resourcemanagerv2

package
v0.29.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 17, 2022 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package resourcemanagerv2 : Operations and models for the ResourceManagerV2 service

Index

Constants

View Source
const DefaultServiceName = "resource_manager"

DefaultServiceName is the default key used to find external configuration information.

View Source
const DefaultServiceURL = "https://resource-controller.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func GetServiceURLForRegion

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalQuotaDefinition

func UnmarshalQuotaDefinition(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalQuotaDefinition unmarshals an instance of QuotaDefinition from the specified map of raw messages.

func UnmarshalQuotaDefinitionList

func UnmarshalQuotaDefinitionList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalQuotaDefinitionList unmarshals an instance of QuotaDefinitionList from the specified map of raw messages.

func UnmarshalResCreateResourceGroup

func UnmarshalResCreateResourceGroup(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResCreateResourceGroup unmarshals an instance of ResCreateResourceGroup from the specified map of raw messages.

func UnmarshalResourceGroup

func UnmarshalResourceGroup(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceGroup unmarshals an instance of ResourceGroup from the specified map of raw messages.

func UnmarshalResourceGroupList

func UnmarshalResourceGroupList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceGroupList unmarshals an instance of ResourceGroupList from the specified map of raw messages.

func UnmarshalResourceQuota

func UnmarshalResourceQuota(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceQuota unmarshals an instance of ResourceQuota from the specified map of raw messages.

Types

type CreateResourceGroupOptions

type CreateResourceGroupOptions struct {
	// The new name of the resource group.
	Name *string `json:"name,omitempty"`

	// The account id of the resource group.
	AccountID *string `json:"account_id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateResourceGroupOptions : The CreateResourceGroup options.

func (*CreateResourceGroupOptions) SetAccountID

func (_options *CreateResourceGroupOptions) SetAccountID(accountID string) *CreateResourceGroupOptions

SetAccountID : Allow user to set AccountID

func (*CreateResourceGroupOptions) SetHeaders

func (options *CreateResourceGroupOptions) SetHeaders(param map[string]string) *CreateResourceGroupOptions

SetHeaders : Allow user to set Headers

func (*CreateResourceGroupOptions) SetName

SetName : Allow user to set Name

type DeleteResourceGroupOptions

type DeleteResourceGroupOptions struct {
	// The short or long ID of the alias.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteResourceGroupOptions : The DeleteResourceGroup options.

func (*DeleteResourceGroupOptions) SetHeaders

func (options *DeleteResourceGroupOptions) SetHeaders(param map[string]string) *DeleteResourceGroupOptions

SetHeaders : Allow user to set Headers

func (*DeleteResourceGroupOptions) SetID

SetID : Allow user to set ID

type GetQuotaDefinitionOptions

type GetQuotaDefinitionOptions struct {
	// The id of the quota.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetQuotaDefinitionOptions : The GetQuotaDefinition options.

func (*GetQuotaDefinitionOptions) SetHeaders

func (options *GetQuotaDefinitionOptions) SetHeaders(param map[string]string) *GetQuotaDefinitionOptions

SetHeaders : Allow user to set Headers

func (*GetQuotaDefinitionOptions) SetID

SetID : Allow user to set ID

type GetResourceGroupOptions

type GetResourceGroupOptions struct {
	// The short or long ID of the alias.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetResourceGroupOptions : The GetResourceGroup options.

func (*GetResourceGroupOptions) SetHeaders

func (options *GetResourceGroupOptions) SetHeaders(param map[string]string) *GetResourceGroupOptions

SetHeaders : Allow user to set Headers

func (*GetResourceGroupOptions) SetID

SetID : Allow user to set ID

type ListQuotaDefinitionsOptions

type ListQuotaDefinitionsOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListQuotaDefinitionsOptions : The ListQuotaDefinitions options.

func (*ListQuotaDefinitionsOptions) SetHeaders

func (options *ListQuotaDefinitionsOptions) SetHeaders(param map[string]string) *ListQuotaDefinitionsOptions

SetHeaders : Allow user to set Headers

type ListResourceGroupsOptions

type ListResourceGroupsOptions struct {
	// The ID of the account that contains the resource groups that you want to get.
	AccountID *string `json:"account_id,omitempty"`

	// The date in the format of YYYY-MM which returns resource groups. Deleted resource groups will be excluded before
	// this month.
	Date *string `json:"date,omitempty"`

	// The name of the resource group.
	Name *string `json:"name,omitempty"`

	// Boolean value to specify whether or not to list default resource groups.
	Default *bool `json:"default,omitempty"`

	// Boolean value to specify whether or not to list default resource groups.
	IncludeDeleted *bool `json:"include_deleted,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListResourceGroupsOptions : The ListResourceGroups options.

func (*ListResourceGroupsOptions) SetAccountID

func (_options *ListResourceGroupsOptions) SetAccountID(accountID string) *ListResourceGroupsOptions

SetAccountID : Allow user to set AccountID

func (*ListResourceGroupsOptions) SetDate

SetDate : Allow user to set Date

func (*ListResourceGroupsOptions) SetDefault

func (_options *ListResourceGroupsOptions) SetDefault(defaultVar bool) *ListResourceGroupsOptions

SetDefault : Allow user to set Default

func (*ListResourceGroupsOptions) SetHeaders

func (options *ListResourceGroupsOptions) SetHeaders(param map[string]string) *ListResourceGroupsOptions

SetHeaders : Allow user to set Headers

func (*ListResourceGroupsOptions) SetIncludeDeleted

func (_options *ListResourceGroupsOptions) SetIncludeDeleted(includeDeleted bool) *ListResourceGroupsOptions

SetIncludeDeleted : Allow user to set IncludeDeleted

func (*ListResourceGroupsOptions) SetName

SetName : Allow user to set Name

type QuotaDefinition

type QuotaDefinition struct {
	// An alpha-numeric value identifying the quota.
	ID *string `json:"id,omitempty"`

	// The human-readable name of the quota.
	Name *string `json:"name,omitempty"`

	// The type of the quota.
	Type *string `json:"type,omitempty"`

	// The total app limit.
	NumberOfApps *float64 `json:"number_of_apps,omitempty"`

	// The total service instances limit per app.
	NumberOfServiceInstances *float64 `json:"number_of_service_instances,omitempty"`

	// Default number of instances per lite plan.
	DefaultNumberOfInstancesPerLitePlan *float64 `json:"default_number_of_instances_per_lite_plan,omitempty"`

	// The total instances limit per app.
	InstancesPerApp *float64 `json:"instances_per_app,omitempty"`

	// The total memory of app instance.
	InstanceMemory *string `json:"instance_memory,omitempty"`

	// The total app memory capacity.
	TotalAppMemory *string `json:"total_app_memory,omitempty"`

	// The VSI limit.
	VsiLimit *float64 `json:"vsi_limit,omitempty"`

	// The resource quotas associated with a quota definition.
	ResourceQuotas []ResourceQuota `json:"resource_quotas,omitempty"`

	// The date when the quota was initially created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The date when the quota was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

QuotaDefinition : A returned quota definition.

type QuotaDefinitionList

type QuotaDefinitionList struct {
	// The list of quota definitions.
	Resources []QuotaDefinition `json:"resources" validate:"required"`
}

QuotaDefinitionList : A list of quota definitions.

type ResCreateResourceGroup

type ResCreateResourceGroup struct {
	// An alpha-numeric value identifying the resource group.
	ID *string `json:"id,omitempty"`

	// The full CRN (cloud resource name) associated with the resource group. For more on this format, see [Cloud Resource
	// Names](https://cloud.ibm.com/docs/account?topic=account-crn).
	CRN *string `json:"crn,omitempty"`
}

ResCreateResourceGroup : A newly-created resource group.

type ResourceGroup

type ResourceGroup struct {
	// An alpha-numeric value identifying the resource group.
	ID *string `json:"id,omitempty"`

	// The full CRN (cloud resource name) associated with the resource group. For more on this format, see [Cloud Resource
	// Names](https://cloud.ibm.com/docs/account?topic=account-crn).
	CRN *string `json:"crn,omitempty"`

	// An alpha-numeric value identifying the account ID.
	AccountID *string `json:"account_id,omitempty"`

	// The human-readable name of the resource group.
	Name *string `json:"name,omitempty"`

	// The state of the resource group.
	State *string `json:"state,omitempty"`

	// Identify if this resource group is default of the account or not.
	Default *bool `json:"default,omitempty"`

	// An alpha-numeric value identifying the quota ID associated with the resource group.
	QuotaID *string `json:"quota_id,omitempty"`

	// The URL to access the quota details that associated with the resource group.
	QuotaURL *string `json:"quota_url,omitempty"`

	// The URL to access the payment methods details that associated with the resource group.
	PaymentMethodsURL *string `json:"payment_methods_url,omitempty"`

	// An array of the resources that linked to the resource group.
	ResourceLinkages []interface{} `json:"resource_linkages,omitempty"`

	// The URL to access the team details that associated with the resource group.
	TeamsURL *string `json:"teams_url,omitempty"`

	// The date when the resource group was initially created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// The date when the resource group was last updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`
}

ResourceGroup : A resource group.

type ResourceGroupList

type ResourceGroupList struct {
	// The list of resource groups.
	Resources []ResourceGroup `json:"resources" validate:"required"`
}

ResourceGroupList : A list of resource groups.

type ResourceManagerV2

type ResourceManagerV2 struct {
	Service *core.BaseService
}

ResourceManagerV2 : Manage lifecycle of your Cloud resource groups using Resource Manager APIs.

API Version: 2.0

func NewResourceManagerV2

func NewResourceManagerV2(options *ResourceManagerV2Options) (service *ResourceManagerV2, err error)

NewResourceManagerV2 : constructs an instance of ResourceManagerV2 with passed in options.

func NewResourceManagerV2UsingExternalConfig

func NewResourceManagerV2UsingExternalConfig(options *ResourceManagerV2Options) (resourceManager *ResourceManagerV2, err error)

NewResourceManagerV2UsingExternalConfig : constructs an instance of ResourceManagerV2 with passed in options and external configuration.

func (*ResourceManagerV2) Clone

func (resourceManager *ResourceManagerV2) Clone() *ResourceManagerV2

Clone makes a copy of "resourceManager" suitable for processing requests.

func (*ResourceManagerV2) CreateResourceGroup

func (resourceManager *ResourceManagerV2) CreateResourceGroup(createResourceGroupOptions *CreateResourceGroupOptions) (result *ResCreateResourceGroup, response *core.DetailedResponse, err error)

CreateResourceGroup : Create a resource group Create a resource group in an account to organize your account resources in customizable groupings so that you can quickly assign users access to more than one resource at a time. To learn what makes a good resource group strategy, see [Best practices for organizing resources](https://cloud.ibm.com/docs/account?topic=account-account_setup). A default resource group is created when an account is created. If you have a Lite account or 30-day trial, you cannot create extra resource groups, but you can rename your default resource group. If you have a Pay-As-You-Go or Subscription account, you can create multiple resource groups. You must be assigned an IAM policy with the Administrator role on All Account Management services to create extra resource groups.

func (*ResourceManagerV2) CreateResourceGroupWithContext

func (resourceManager *ResourceManagerV2) CreateResourceGroupWithContext(ctx context.Context, createResourceGroupOptions *CreateResourceGroupOptions) (result *ResCreateResourceGroup, response *core.DetailedResponse, err error)

CreateResourceGroupWithContext is an alternate form of the CreateResourceGroup method which supports a Context parameter

func (*ResourceManagerV2) DeleteResourceGroup

func (resourceManager *ResourceManagerV2) DeleteResourceGroup(deleteResourceGroupOptions *DeleteResourceGroupOptions) (response *core.DetailedResponse, err error)

DeleteResourceGroup : Delete a resource group Delete a resource group by the alias ID. You can delete a resource group only if the targeted resource group does not contain any resources or if it is not a default resource group. When a user creates an account, a default resource group is created in the account. If you want to delete a resource group that contains resources, first [delete the resource instances](https://cloud.ibm.com/apidocs/resource-controller/resource-controller?code=java#delete-resource-instance). Then, delete the resource group when all resource instances in the group are deleted. Users need to be assigned an IAM policy with the Editor role or higher on the targeted resource group.

func (*ResourceManagerV2) DeleteResourceGroupWithContext

func (resourceManager *ResourceManagerV2) DeleteResourceGroupWithContext(ctx context.Context, deleteResourceGroupOptions *DeleteResourceGroupOptions) (response *core.DetailedResponse, err error)

DeleteResourceGroupWithContext is an alternate form of the DeleteResourceGroup method which supports a Context parameter

func (*ResourceManagerV2) DisableRetries

func (resourceManager *ResourceManagerV2) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*ResourceManagerV2) EnableRetries

func (resourceManager *ResourceManagerV2) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*ResourceManagerV2) GetEnableGzipCompression

func (resourceManager *ResourceManagerV2) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*ResourceManagerV2) GetQuotaDefinition

func (resourceManager *ResourceManagerV2) GetQuotaDefinition(getQuotaDefinitionOptions *GetQuotaDefinitionOptions) (result *QuotaDefinition, response *core.DetailedResponse, err error)

GetQuotaDefinition : Get a quota definition Call this method to retrieve information about a particular quota by passing the quota ID. The response can be used to identify the quota type, Standard or Paid. Information about available resources, such as number of apps, number of service instances, and memory, are returned in the response. Quotas for a resource group limit the number of apps, instances, and memory allowed for that specific resource group. Each resource group that you have on your account has a specific set of quotas. Standard quotas are for resource groups that are created by users with a Lite account, and Pay-As-You-Go quotas are for resource groups that are created with a Pay-As-You-Go account. No specific IAM policy needed.

func (*ResourceManagerV2) GetQuotaDefinitionWithContext

func (resourceManager *ResourceManagerV2) GetQuotaDefinitionWithContext(ctx context.Context, getQuotaDefinitionOptions *GetQuotaDefinitionOptions) (result *QuotaDefinition, response *core.DetailedResponse, err error)

GetQuotaDefinitionWithContext is an alternate form of the GetQuotaDefinition method which supports a Context parameter

func (*ResourceManagerV2) GetResourceGroup

func (resourceManager *ResourceManagerV2) GetResourceGroup(getResourceGroupOptions *GetResourceGroupOptions) (result *ResourceGroup, response *core.DetailedResponse, err error)

GetResourceGroup : Get a resource group Retrieve a resource group by alias ID. Call this method to get details about a particular resource group, like the name of the resource group, associated quotas, whether the state is active, the resource group ID and the CRN. The `id` returned in the response can be used to [create a resource instance later](https://cloud.ibm.com/apidocs/resource-controller/resource-controller?code=java#create-resource-instance). Users need to be assigned an IAM policy with the Viewer role or higher on the targeted resource group.

func (*ResourceManagerV2) GetResourceGroupWithContext

func (resourceManager *ResourceManagerV2) GetResourceGroupWithContext(ctx context.Context, getResourceGroupOptions *GetResourceGroupOptions) (result *ResourceGroup, response *core.DetailedResponse, err error)

GetResourceGroupWithContext is an alternate form of the GetResourceGroup method which supports a Context parameter

func (*ResourceManagerV2) GetServiceURL

func (resourceManager *ResourceManagerV2) GetServiceURL() string

GetServiceURL returns the service URL

func (*ResourceManagerV2) ListQuotaDefinitions

func (resourceManager *ResourceManagerV2) ListQuotaDefinitions(listQuotaDefinitionsOptions *ListQuotaDefinitionsOptions) (result *QuotaDefinitionList, response *core.DetailedResponse, err error)

ListQuotaDefinitions : List quota definitions Get a list of all quota definitions. Quotas for a resource group limit the number of apps, instances, and memory allowed for that specific resource group. Each resource group that you have on your account has a specific set of quotas. Standard quotas are for resource groups that are created by users with a Lite account, and Pay-As-You-Go quotas are for resource groups that are created with a Pay-As-You-Go account. This method provides list of all available quota definitions. No specific IAM policy needed.

func (*ResourceManagerV2) ListQuotaDefinitionsWithContext

func (resourceManager *ResourceManagerV2) ListQuotaDefinitionsWithContext(ctx context.Context, listQuotaDefinitionsOptions *ListQuotaDefinitionsOptions) (result *QuotaDefinitionList, response *core.DetailedResponse, err error)

ListQuotaDefinitionsWithContext is an alternate form of the ListQuotaDefinitions method which supports a Context parameter

func (*ResourceManagerV2) ListResourceGroups

func (resourceManager *ResourceManagerV2) ListResourceGroups(listResourceGroupsOptions *ListResourceGroupsOptions) (result *ResourceGroupList, response *core.DetailedResponse, err error)

ListResourceGroups : Get a list of all resource groups Call this method to retrieve information about all resource groups and associated quotas in an account. The `id` returned in the response can be used to [create a resource instance later](https://cloud.ibm.com/apidocs/resource-controller/resource-controller?code=java#create-resource-instance). The response can be filtered based on queryParams such as `account_id`, `name`, `default`, and more to narrow your search.Users need to be assigned IAM policies with the Viewer role or higher on the targeted resource groups.

func (*ResourceManagerV2) ListResourceGroupsWithContext

func (resourceManager *ResourceManagerV2) ListResourceGroupsWithContext(ctx context.Context, listResourceGroupsOptions *ListResourceGroupsOptions) (result *ResourceGroupList, response *core.DetailedResponse, err error)

ListResourceGroupsWithContext is an alternate form of the ListResourceGroups method which supports a Context parameter

func (*ResourceManagerV2) NewCreateResourceGroupOptions

func (*ResourceManagerV2) NewCreateResourceGroupOptions() *CreateResourceGroupOptions

NewCreateResourceGroupOptions : Instantiate CreateResourceGroupOptions

func (*ResourceManagerV2) NewDeleteResourceGroupOptions

func (*ResourceManagerV2) NewDeleteResourceGroupOptions(id string) *DeleteResourceGroupOptions

NewDeleteResourceGroupOptions : Instantiate DeleteResourceGroupOptions

func (*ResourceManagerV2) NewGetQuotaDefinitionOptions

func (*ResourceManagerV2) NewGetQuotaDefinitionOptions(id string) *GetQuotaDefinitionOptions

NewGetQuotaDefinitionOptions : Instantiate GetQuotaDefinitionOptions

func (*ResourceManagerV2) NewGetResourceGroupOptions

func (*ResourceManagerV2) NewGetResourceGroupOptions(id string) *GetResourceGroupOptions

NewGetResourceGroupOptions : Instantiate GetResourceGroupOptions

func (*ResourceManagerV2) NewListQuotaDefinitionsOptions

func (*ResourceManagerV2) NewListQuotaDefinitionsOptions() *ListQuotaDefinitionsOptions

NewListQuotaDefinitionsOptions : Instantiate ListQuotaDefinitionsOptions

func (*ResourceManagerV2) NewListResourceGroupsOptions

func (*ResourceManagerV2) NewListResourceGroupsOptions() *ListResourceGroupsOptions

NewListResourceGroupsOptions : Instantiate ListResourceGroupsOptions

func (*ResourceManagerV2) NewUpdateResourceGroupOptions

func (*ResourceManagerV2) NewUpdateResourceGroupOptions(id string) *UpdateResourceGroupOptions

NewUpdateResourceGroupOptions : Instantiate UpdateResourceGroupOptions

func (*ResourceManagerV2) SetDefaultHeaders

func (resourceManager *ResourceManagerV2) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*ResourceManagerV2) SetEnableGzipCompression

func (resourceManager *ResourceManagerV2) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*ResourceManagerV2) SetServiceURL

func (resourceManager *ResourceManagerV2) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*ResourceManagerV2) UpdateResourceGroup

func (resourceManager *ResourceManagerV2) UpdateResourceGroup(updateResourceGroupOptions *UpdateResourceGroupOptions) (result *ResourceGroup, response *core.DetailedResponse, err error)

UpdateResourceGroup : Update a resource group Update a resource group by the alias ID. Call this method to update information about an existing resource group. You can rename a resource group and activate or suspend a particular resource group. To update a resource group, users need to be assigned with IAM policies with the Editor role or higher.

func (*ResourceManagerV2) UpdateResourceGroupWithContext

func (resourceManager *ResourceManagerV2) UpdateResourceGroupWithContext(ctx context.Context, updateResourceGroupOptions *UpdateResourceGroupOptions) (result *ResourceGroup, response *core.DetailedResponse, err error)

UpdateResourceGroupWithContext is an alternate form of the UpdateResourceGroup method which supports a Context parameter

type ResourceManagerV2Options

type ResourceManagerV2Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

ResourceManagerV2Options : Service options

type ResourceQuota

type ResourceQuota struct {
	// An alpha-numeric value identifying the quota.
	ID *string `json:"_id,omitempty"`

	// The human-readable name of the quota.
	ResourceID *string `json:"resource_id,omitempty"`

	// The full CRN (cloud resource name) associated with the quota. For more on this format, see
	// https://cloud.ibm.com/docs/account?topic=account-crn.
	CRN *string `json:"crn,omitempty"`

	// The limit number of this resource.
	Limit *float64 `json:"limit,omitempty"`
}

ResourceQuota : A resource quota.

type UpdateResourceGroupOptions

type UpdateResourceGroupOptions struct {
	// The short or long ID of the alias.
	ID *string `json:"id" validate:"required,ne="`

	// The new name of the resource group.
	Name *string `json:"name,omitempty"`

	// The state of the resource group.
	State *string `json:"state,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateResourceGroupOptions : The UpdateResourceGroup options.

func (*UpdateResourceGroupOptions) SetHeaders

func (options *UpdateResourceGroupOptions) SetHeaders(param map[string]string) *UpdateResourceGroupOptions

SetHeaders : Allow user to set Headers

func (*UpdateResourceGroupOptions) SetID

SetID : Allow user to set ID

func (*UpdateResourceGroupOptions) SetName

SetName : Allow user to set Name

func (*UpdateResourceGroupOptions) SetState

SetState : Allow user to set State

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL