resourcecontrollerv2

package
v0.72.0 Latest Latest
Warning

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

Go to latest
Published: Nov 29, 2024 License: Apache-2.0 Imports: 9 Imported by: 37

Documentation

Overview

Package resourcecontrollerv2 : Operations and models for the ResourceControllerV2 service

Index

Constants

View Source
const (
	CredentialsRedactedRedactedConst         = "REDACTED"
	CredentialsRedactedRedactedExplicitConst = "REDACTED_EXPLICIT" // #nosec G101
)

Constants associated with the Credentials.Redacted property. If present, the user doesn't have the correct access to view the credentials and the details are redacted. The string value identifies the level of access that's required to view the credential. For additional information, see [viewing a credential](https://cloud.ibm.com/docs/account?topic=account-service_credentials&interface=ui#viewing-credentials-ui).

View Source
const (
	ListResourceInstancesOptionsStateActiveConst             = "active"
	ListResourceInstancesOptionsStateFailedConst             = "failed"
	ListResourceInstancesOptionsStateInactiveConst           = "inactive"
	ListResourceInstancesOptionsStatePendingReclamationConst = "pending_reclamation"
	ListResourceInstancesOptionsStatePreProvisioningConst    = "pre_provisioning"
	ListResourceInstancesOptionsStateProvisioningConst       = "provisioning"
	ListResourceInstancesOptionsStateRemovedConst            = "removed"
)

Constants associated with the ListResourceInstancesOptions.State property. The state of the instance. If not specified, instances in state `active` and `provisioning` are returned.

View Source
const (
	ResourceInstanceStateActiveConst             = "active"
	ResourceInstanceStateFailedConst             = "failed"
	ResourceInstanceStateInactiveConst           = "inactive"
	ResourceInstanceStatePendingReclamationConst = "pending_reclamation"
	ResourceInstanceStatePendingRemovalConst     = "pending_removal"
	ResourceInstanceStatePreProvisioningConst    = "pre_provisioning"
	ResourceInstanceStateProvisioningConst       = "provisioning"
	ResourceInstanceStateRemovedConst            = "removed"
)

Constants associated with the ResourceInstance.State property. The current state of the instance. For example, if the instance is deleted, it will return removed.

View Source
const (
	ResourceInstanceLastOperationStateFailedConst     = "failed"
	ResourceInstanceLastOperationStateInProgressConst = "in progress"
	ResourceInstanceLastOperationStateSucceededConst  = "succeeded"
)

Constants associated with the ResourceInstanceLastOperation.State property. The last operation state of the resoure instance. This indicates if the resource's last operation is in progress, succeeded or failed.

View Source
const DefaultServiceName = "resource_controller"

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 added in v0.17.2

func GetServiceURLForRegion(region string) (string, error)

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

func UnmarshalCredentials

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

UnmarshalCredentials unmarshals an instance of Credentials from the specified map of raw messages.

func UnmarshalPlanHistoryItem

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

UnmarshalPlanHistoryItem unmarshals an instance of PlanHistoryItem from the specified map of raw messages.

func UnmarshalReclamation

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

UnmarshalReclamation unmarshals an instance of Reclamation from the specified map of raw messages.

func UnmarshalReclamationsList

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

UnmarshalReclamationsList unmarshals an instance of ReclamationsList from the specified map of raw messages.

func UnmarshalResourceAlias

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

UnmarshalResourceAlias unmarshals an instance of ResourceAlias from the specified map of raw messages.

func UnmarshalResourceAliasesList

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

UnmarshalResourceAliasesList unmarshals an instance of ResourceAliasesList from the specified map of raw messages.

func UnmarshalResourceBinding

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

UnmarshalResourceBinding unmarshals an instance of ResourceBinding from the specified map of raw messages.

func UnmarshalResourceBindingPostParameters

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

UnmarshalResourceBindingPostParameters unmarshals an instance of ResourceBindingPostParameters from the specified map of raw messages.

func UnmarshalResourceBindingsList

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

UnmarshalResourceBindingsList unmarshals an instance of ResourceBindingsList from the specified map of raw messages.

func UnmarshalResourceInstance

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

UnmarshalResourceInstance unmarshals an instance of ResourceInstance from the specified map of raw messages.

func UnmarshalResourceInstanceLastOperation added in v0.27.0

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

UnmarshalResourceInstanceLastOperation unmarshals an instance of ResourceInstanceLastOperation from the specified map of raw messages.

func UnmarshalResourceInstancesList

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

UnmarshalResourceInstancesList unmarshals an instance of ResourceInstancesList from the specified map of raw messages.

func UnmarshalResourceKey

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

UnmarshalResourceKey unmarshals an instance of ResourceKey from the specified map of raw messages.

func UnmarshalResourceKeyPostParameters

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

UnmarshalResourceKeyPostParameters unmarshals an instance of ResourceKeyPostParameters from the specified map of raw messages.

func UnmarshalResourceKeysList

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

UnmarshalResourceKeysList unmarshals an instance of ResourceKeysList from the specified map of raw messages.

Types

type CancelLastopResourceInstanceOptions added in v0.27.0

type CancelLastopResourceInstanceOptions struct {
	// The resource instance URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

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

CancelLastopResourceInstanceOptions : The CancelLastopResourceInstance options.

func (*CancelLastopResourceInstanceOptions) SetHeaders added in v0.27.0

SetHeaders : Allow user to set Headers

func (*CancelLastopResourceInstanceOptions) SetID added in v0.27.0

SetID : Allow user to set ID

type CreateResourceAliasOptions

type CreateResourceAliasOptions struct {
	// The name of the alias. Must be 180 characters or less and cannot include any special characters other than `(space)
	// - . _ :`.
	Name *string `json:"name" validate:"required"`

	// The ID of resource instance.
	Source *string `json:"source" validate:"required"`

	// The CRN of target name(space) in a specific environment, for example, space in Dallas YP, CFEE instance etc.
	Target *string `json:"target" validate:"required"`

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

CreateResourceAliasOptions : The CreateResourceAlias options.

func (*CreateResourceAliasOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateResourceAliasOptions) SetName

SetName : Allow user to set Name

func (*CreateResourceAliasOptions) SetSource

func (_options *CreateResourceAliasOptions) SetSource(source string) *CreateResourceAliasOptions

SetSource : Allow user to set Source

func (*CreateResourceAliasOptions) SetTarget

func (_options *CreateResourceAliasOptions) SetTarget(target string) *CreateResourceAliasOptions

SetTarget : Allow user to set Target

type CreateResourceBindingOptions

type CreateResourceBindingOptions struct {
	// The ID of resource alias.
	Source *string `json:"source" validate:"required"`

	// The CRN of application to bind to in a specific environment, for example, Dallas YP, CFEE instance.
	Target *string `json:"target" validate:"required"`

	// The name of the binding. Must be 180 characters or less and cannot include any special characters other than
	// `(space) - . _ :`.
	Name *string `json:"name,omitempty"`

	// Configuration options represented as key-value pairs. Service defined options are passed through to the target
	// resource brokers, whereas platform defined options are not.
	Parameters *ResourceBindingPostParameters `json:"parameters,omitempty"`

	// The base IAM service role name (Reader, Writer, or Manager), or the service or custom role CRN. Refer to service’s
	// documentation for supported roles.
	Role *string `json:"role,omitempty"`

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

CreateResourceBindingOptions : The CreateResourceBinding options.

func (*CreateResourceBindingOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*CreateResourceBindingOptions) SetName

SetName : Allow user to set Name

func (*CreateResourceBindingOptions) SetParameters

SetParameters : Allow user to set Parameters

func (*CreateResourceBindingOptions) SetRole

SetRole : Allow user to set Role

func (*CreateResourceBindingOptions) SetSource

SetSource : Allow user to set Source

func (*CreateResourceBindingOptions) SetTarget

SetTarget : Allow user to set Target

type CreateResourceInstanceOptions

type CreateResourceInstanceOptions struct {
	// The name of the instance. Must be 180 characters or less and cannot include any special characters other than
	// `(space) - . _ :`.
	Name *string `json:"name" validate:"required"`

	// The deployment location where the instance should be hosted.
	Target *string `json:"target" validate:"required"`

	// The ID of the resource group.
	ResourceGroup *string `json:"resource_group" validate:"required"`

	// The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
	ResourcePlanID *string `json:"resource_plan_id" validate:"required"`

	// Tags that are attached to the instance after provisioning. These tags can be searched and managed through the
	// Tagging API in IBM Cloud.
	Tags []string `json:"tags,omitempty"`

	// A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region
	// instance delete call.
	AllowCleanup *bool `json:"allow_cleanup,omitempty"`

	// Configuration options represented as key-value pairs that are passed through to the target resource brokers. Set the
	// `onetime_credentials` property to specify whether newly created resource key credentials can be retrieved by using
	// get resource key or get a list of all of the resource keys requests.
	Parameters map[string]interface{} `json:"parameters,omitempty"`

	// Indicates if the resource instance is locked for further update or delete operations. It does not affect actions
	// performed on child resources like aliases, bindings or keys. False by default.
	EntityLock *bool `json:"Entity-Lock,omitempty"`

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

CreateResourceInstanceOptions : The CreateResourceInstance options.

func (*CreateResourceInstanceOptions) SetAllowCleanup

func (_options *CreateResourceInstanceOptions) SetAllowCleanup(allowCleanup bool) *CreateResourceInstanceOptions

SetAllowCleanup : Allow user to set AllowCleanup

func (*CreateResourceInstanceOptions) SetEntityLock

func (_options *CreateResourceInstanceOptions) SetEntityLock(entityLock bool) *CreateResourceInstanceOptions

SetEntityLock : Allow user to set EntityLock

func (*CreateResourceInstanceOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*CreateResourceInstanceOptions) SetName

SetName : Allow user to set Name

func (*CreateResourceInstanceOptions) SetParameters

func (_options *CreateResourceInstanceOptions) SetParameters(parameters map[string]interface{}) *CreateResourceInstanceOptions

SetParameters : Allow user to set Parameters

func (*CreateResourceInstanceOptions) SetResourceGroup

func (_options *CreateResourceInstanceOptions) SetResourceGroup(resourceGroup string) *CreateResourceInstanceOptions

SetResourceGroup : Allow user to set ResourceGroup

func (*CreateResourceInstanceOptions) SetResourcePlanID

func (_options *CreateResourceInstanceOptions) SetResourcePlanID(resourcePlanID string) *CreateResourceInstanceOptions

SetResourcePlanID : Allow user to set ResourcePlanID

func (*CreateResourceInstanceOptions) SetTags

SetTags : Allow user to set Tags

func (*CreateResourceInstanceOptions) SetTarget

SetTarget : Allow user to set Target

type CreateResourceKeyOptions

type CreateResourceKeyOptions struct {
	// The name of the key.
	Name *string `json:"name" validate:"required"`

	// The ID of resource instance or alias.
	Source *string `json:"source" validate:"required"`

	// Configuration options represented as key-value pairs. Service defined options are passed through to the target
	// resource brokers, whereas platform defined options are not.
	Parameters *ResourceKeyPostParameters `json:"parameters,omitempty"`

	// The base IAM service role name (Reader, Writer, or Manager), or the service or custom role CRN. Refer to service’s
	// documentation for supported roles.
	Role *string `json:"role,omitempty"`

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

CreateResourceKeyOptions : The CreateResourceKey options.

func (*CreateResourceKeyOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateResourceKeyOptions) SetName

func (_options *CreateResourceKeyOptions) SetName(name string) *CreateResourceKeyOptions

SetName : Allow user to set Name

func (*CreateResourceKeyOptions) SetParameters

func (_options *CreateResourceKeyOptions) SetParameters(parameters *ResourceKeyPostParameters) *CreateResourceKeyOptions

SetParameters : Allow user to set Parameters

func (*CreateResourceKeyOptions) SetRole

func (_options *CreateResourceKeyOptions) SetRole(role string) *CreateResourceKeyOptions

SetRole : Allow user to set Role

func (*CreateResourceKeyOptions) SetSource

func (_options *CreateResourceKeyOptions) SetSource(source string) *CreateResourceKeyOptions

SetSource : Allow user to set Source

type Credentials

type Credentials struct {
	// If present, the user doesn't have the correct access to view the credentials and the details are redacted.  The
	// string value identifies the level of access that's required to view the credential. For additional information, see
	// [viewing a
	// credential](https://cloud.ibm.com/docs/account?topic=account-service_credentials&interface=ui#viewing-credentials-ui).
	Redacted *string `json:"REDACTED,omitempty"`

	// The API key for the credentials.
	Apikey *string `json:"apikey,omitempty"`

	// The optional description of the API key.
	IamApikeyDescription *string `json:"iam_apikey_description,omitempty"`

	// The name of the API key.
	IamApikeyName *string `json:"iam_apikey_name,omitempty"`

	// The Cloud Resource Name for the role of the credentials.
	IamRoleCRN *string `json:"iam_role_crn,omitempty"`

	// The Cloud Resource Name for the service ID of the credentials.
	IamServiceidCRN *string `json:"iam_serviceid_crn,omitempty"`
	// contains filtered or unexported fields
}

Credentials : The credentials for a resource. This type supports additional properties of type interface{}. Additional key-value pairs from the resource broker.

func (*Credentials) GetProperties

func (o *Credentials) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of Credentials.

func (*Credentials) GetProperty

func (o *Credentials) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of Credentials.

func (*Credentials) MarshalJSON

func (o *Credentials) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of Credentials

func (*Credentials) SetProperties added in v0.29.3

func (o *Credentials) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of Credentials. Additional key-value pairs from the resource broker.

func (*Credentials) SetProperty

func (o *Credentials) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of Credentials. Additional key-value pairs from the resource broker.

type DeleteResourceAliasOptions

type DeleteResourceAliasOptions struct {
	// The resource alias URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

	// Deletes the resource bindings and keys associated with the alias.
	Recursive *bool `json:"recursive,omitempty"`

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

DeleteResourceAliasOptions : The DeleteResourceAlias options.

func (*DeleteResourceAliasOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteResourceAliasOptions) SetID

SetID : Allow user to set ID

func (*DeleteResourceAliasOptions) SetRecursive added in v0.29.3

func (_options *DeleteResourceAliasOptions) SetRecursive(recursive bool) *DeleteResourceAliasOptions

SetRecursive : Allow user to set Recursive

type DeleteResourceBindingOptions

type DeleteResourceBindingOptions struct {
	// The resource binding URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

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

DeleteResourceBindingOptions : The DeleteResourceBinding options.

func (*DeleteResourceBindingOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*DeleteResourceBindingOptions) SetID

SetID : Allow user to set ID

type DeleteResourceInstanceOptions

type DeleteResourceInstanceOptions struct {
	// The resource instance URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

	// Will delete resource bindings, keys and aliases associated with the instance.
	Recursive *bool `json:"recursive,omitempty"`

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

DeleteResourceInstanceOptions : The DeleteResourceInstance options.

func (*DeleteResourceInstanceOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*DeleteResourceInstanceOptions) SetID

SetID : Allow user to set ID

func (*DeleteResourceInstanceOptions) SetRecursive added in v0.17.16

func (_options *DeleteResourceInstanceOptions) SetRecursive(recursive bool) *DeleteResourceInstanceOptions

SetRecursive : Allow user to set Recursive

type DeleteResourceKeyOptions

type DeleteResourceKeyOptions struct {
	// The resource key URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

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

DeleteResourceKeyOptions : The DeleteResourceKey options.

func (*DeleteResourceKeyOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteResourceKeyOptions) SetID

SetID : Allow user to set ID

type GetResourceAliasOptions

type GetResourceAliasOptions struct {
	// The resource alias URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

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

GetResourceAliasOptions : The GetResourceAlias options.

func (*GetResourceAliasOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetResourceAliasOptions) SetID

SetID : Allow user to set ID

type GetResourceBindingOptions

type GetResourceBindingOptions struct {
	// The resource binding URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

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

GetResourceBindingOptions : The GetResourceBinding options.

func (*GetResourceBindingOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetResourceBindingOptions) SetID

SetID : Allow user to set ID

type GetResourceInstanceOptions

type GetResourceInstanceOptions struct {
	// The resource instance URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

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

GetResourceInstanceOptions : The GetResourceInstance options.

func (*GetResourceInstanceOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetResourceInstanceOptions) SetID

SetID : Allow user to set ID

type GetResourceKeyOptions

type GetResourceKeyOptions struct {
	// The resource key URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

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

GetResourceKeyOptions : The GetResourceKey options.

func (*GetResourceKeyOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetResourceKeyOptions) SetID

func (_options *GetResourceKeyOptions) SetID(id string) *GetResourceKeyOptions

SetID : Allow user to set ID

type ListReclamationsOptions

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

	// The GUID of the resource instance.
	ResourceInstanceID *string `json:"resource_instance_id,omitempty"`

	// The ID of the resource group.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

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

ListReclamationsOptions : The ListReclamations options.

func (*ListReclamationsOptions) SetAccountID

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

SetAccountID : Allow user to set AccountID

func (*ListReclamationsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListReclamationsOptions) SetResourceGroupID added in v0.48.0

func (_options *ListReclamationsOptions) SetResourceGroupID(resourceGroupID string) *ListReclamationsOptions

SetResourceGroupID : Allow user to set ResourceGroupID

func (*ListReclamationsOptions) SetResourceInstanceID

func (_options *ListReclamationsOptions) SetResourceInstanceID(resourceInstanceID string) *ListReclamationsOptions

SetResourceInstanceID : Allow user to set ResourceInstanceID

type ListResourceAliasesForInstanceOptions added in v0.17.16

type ListResourceAliasesForInstanceOptions struct {
	// The resource instance URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

	// Limit on how many items should be returned.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. Any additional query
	// parameters are ignored if a page token is present. If omitted, the first page of results is returned. This value is
	// obtained from the 'start' query parameter in the 'next_url' field of the operation response.
	Start *string `json:"start,omitempty"`

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

ListResourceAliasesForInstanceOptions : The ListResourceAliasesForInstance options.

func (*ListResourceAliasesForInstanceOptions) SetHeaders added in v0.17.16

SetHeaders : Allow user to set Headers

func (*ListResourceAliasesForInstanceOptions) SetID added in v0.17.16

SetID : Allow user to set ID

func (*ListResourceAliasesForInstanceOptions) SetLimit added in v0.18.9

SetLimit : Allow user to set Limit

func (*ListResourceAliasesForInstanceOptions) SetStart added in v0.18.9

SetStart : Allow user to set Start

type ListResourceAliasesOptions

type ListResourceAliasesOptions struct {
	// The GUID of the alias.
	GUID *string `json:"guid,omitempty"`

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

	// The ID of the resource instance.
	ResourceInstanceID *string `json:"resource_instance_id,omitempty"`

	// The ID of the instance in the target environment. For example, `service_instance_id` in a given IBM Cloud
	// environment.
	RegionInstanceID *string `json:"region_instance_id,omitempty"`

	// The unique ID of the offering (service name). This value is provided by and stored in the global catalog.
	ResourceID *string `json:"resource_id,omitempty"`

	// The ID of the resource group.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

	// Limit on how many items should be returned.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. Any additional query
	// parameters are ignored if a page token is present. If omitted, the first page of results is returned. This value is
	// obtained from the 'start' query parameter in the 'next_url' field of the operation response.
	Start *string `json:"start,omitempty"`

	// Start date inclusive filter.
	UpdatedFrom *string `json:"updated_from,omitempty"`

	// End date inclusive filter.
	UpdatedTo *string `json:"updated_to,omitempty"`

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

ListResourceAliasesOptions : The ListResourceAliases options.

func (*ListResourceAliasesOptions) SetGUID added in v0.17.2

SetGUID : Allow user to set GUID

func (*ListResourceAliasesOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListResourceAliasesOptions) SetLimit

func (_options *ListResourceAliasesOptions) SetLimit(limit int64) *ListResourceAliasesOptions

SetLimit : Allow user to set Limit

func (*ListResourceAliasesOptions) SetName

SetName : Allow user to set Name

func (*ListResourceAliasesOptions) SetRegionInstanceID

func (_options *ListResourceAliasesOptions) SetRegionInstanceID(regionInstanceID string) *ListResourceAliasesOptions

SetRegionInstanceID : Allow user to set RegionInstanceID

func (*ListResourceAliasesOptions) SetResourceGroupID

func (_options *ListResourceAliasesOptions) SetResourceGroupID(resourceGroupID string) *ListResourceAliasesOptions

SetResourceGroupID : Allow user to set ResourceGroupID

func (*ListResourceAliasesOptions) SetResourceID

func (_options *ListResourceAliasesOptions) SetResourceID(resourceID string) *ListResourceAliasesOptions

SetResourceID : Allow user to set ResourceID

func (*ListResourceAliasesOptions) SetResourceInstanceID

func (_options *ListResourceAliasesOptions) SetResourceInstanceID(resourceInstanceID string) *ListResourceAliasesOptions

SetResourceInstanceID : Allow user to set ResourceInstanceID

func (*ListResourceAliasesOptions) SetStart added in v0.18.9

SetStart : Allow user to set Start

func (*ListResourceAliasesOptions) SetUpdatedFrom

func (_options *ListResourceAliasesOptions) SetUpdatedFrom(updatedFrom string) *ListResourceAliasesOptions

SetUpdatedFrom : Allow user to set UpdatedFrom

func (*ListResourceAliasesOptions) SetUpdatedTo

func (_options *ListResourceAliasesOptions) SetUpdatedTo(updatedTo string) *ListResourceAliasesOptions

SetUpdatedTo : Allow user to set UpdatedTo

type ListResourceBindingsForAliasOptions added in v0.17.16

type ListResourceBindingsForAliasOptions struct {
	// The resource alias URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

	// Limit on how many items should be returned.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. Any additional query
	// parameters are ignored if a page token is present. If omitted, the first page of results is returned. This value is
	// obtained from the 'start' query parameter in the 'next_url' field of the operation response.
	Start *string `json:"start,omitempty"`

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

ListResourceBindingsForAliasOptions : The ListResourceBindingsForAlias options.

func (*ListResourceBindingsForAliasOptions) SetHeaders added in v0.17.16

SetHeaders : Allow user to set Headers

func (*ListResourceBindingsForAliasOptions) SetID added in v0.17.16

SetID : Allow user to set ID

func (*ListResourceBindingsForAliasOptions) SetLimit added in v0.18.9

SetLimit : Allow user to set Limit

func (*ListResourceBindingsForAliasOptions) SetStart added in v0.18.9

SetStart : Allow user to set Start

type ListResourceBindingsOptions

type ListResourceBindingsOptions struct {
	// The GUID of the binding.
	GUID *string `json:"guid,omitempty"`

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

	// The ID of the resource group.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

	// The unique ID of the offering (service name). This value is provided by and stored in the global catalog.
	ResourceID *string `json:"resource_id,omitempty"`

	// The ID of the binding in the target environment. For example, `service_binding_id` in a given IBM Cloud environment.
	RegionBindingID *string `json:"region_binding_id,omitempty"`

	// Limit on how many items should be returned.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. Any additional query
	// parameters are ignored if a page token is present. If omitted, the first page of results is returned. This value is
	// obtained from the 'start' query parameter in the 'next_url' field of the operation response.
	Start *string `json:"start,omitempty"`

	// Start date inclusive filter.
	UpdatedFrom *string `json:"updated_from,omitempty"`

	// End date inclusive filter.
	UpdatedTo *string `json:"updated_to,omitempty"`

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

ListResourceBindingsOptions : The ListResourceBindings options.

func (*ListResourceBindingsOptions) SetGUID added in v0.17.2

SetGUID : Allow user to set GUID

func (*ListResourceBindingsOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListResourceBindingsOptions) SetLimit

SetLimit : Allow user to set Limit

func (*ListResourceBindingsOptions) SetName

SetName : Allow user to set Name

func (*ListResourceBindingsOptions) SetRegionBindingID

func (_options *ListResourceBindingsOptions) SetRegionBindingID(regionBindingID string) *ListResourceBindingsOptions

SetRegionBindingID : Allow user to set RegionBindingID

func (*ListResourceBindingsOptions) SetResourceGroupID

func (_options *ListResourceBindingsOptions) SetResourceGroupID(resourceGroupID string) *ListResourceBindingsOptions

SetResourceGroupID : Allow user to set ResourceGroupID

func (*ListResourceBindingsOptions) SetResourceID

func (_options *ListResourceBindingsOptions) SetResourceID(resourceID string) *ListResourceBindingsOptions

SetResourceID : Allow user to set ResourceID

func (*ListResourceBindingsOptions) SetStart added in v0.18.9

SetStart : Allow user to set Start

func (*ListResourceBindingsOptions) SetUpdatedFrom

func (_options *ListResourceBindingsOptions) SetUpdatedFrom(updatedFrom string) *ListResourceBindingsOptions

SetUpdatedFrom : Allow user to set UpdatedFrom

func (*ListResourceBindingsOptions) SetUpdatedTo

func (_options *ListResourceBindingsOptions) SetUpdatedTo(updatedTo string) *ListResourceBindingsOptions

SetUpdatedTo : Allow user to set UpdatedTo

type ListResourceInstancesOptions

type ListResourceInstancesOptions struct {
	// The GUID of the instance.
	GUID *string `json:"guid,omitempty"`

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

	// The ID of the resource group.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

	// The unique ID of the offering. This value is provided by and stored in the global catalog.
	ResourceID *string `json:"resource_id,omitempty"`

	// The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
	ResourcePlanID *string `json:"resource_plan_id,omitempty"`

	// The type of the instance, for example, `service_instance`.
	Type *string `json:"type,omitempty"`

	// The sub-type of instance, for example, `kms`.
	SubType *string `json:"sub_type,omitempty"`

	// Limit on how many items should be returned.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. Any additional query
	// parameters are ignored if a page token is present. If omitted, the first page of results is returned. This value is
	// obtained from the 'start' query parameter in the 'next_url' field of the operation response.
	Start *string `json:"start,omitempty"`

	// The state of the instance. If not specified, instances in state `active` and `provisioning` are returned.
	State *string `json:"state,omitempty"`

	// Start date inclusive filter.
	UpdatedFrom *string `json:"updated_from,omitempty"`

	// End date inclusive filter.
	UpdatedTo *string `json:"updated_to,omitempty"`

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

ListResourceInstancesOptions : The ListResourceInstances options.

func (*ListResourceInstancesOptions) SetGUID added in v0.17.2

SetGUID : Allow user to set GUID

func (*ListResourceInstancesOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*ListResourceInstancesOptions) SetLimit

SetLimit : Allow user to set Limit

func (*ListResourceInstancesOptions) SetName

SetName : Allow user to set Name

func (*ListResourceInstancesOptions) SetResourceGroupID

func (_options *ListResourceInstancesOptions) SetResourceGroupID(resourceGroupID string) *ListResourceInstancesOptions

SetResourceGroupID : Allow user to set ResourceGroupID

func (*ListResourceInstancesOptions) SetResourceID

func (_options *ListResourceInstancesOptions) SetResourceID(resourceID string) *ListResourceInstancesOptions

SetResourceID : Allow user to set ResourceID

func (*ListResourceInstancesOptions) SetResourcePlanID

func (_options *ListResourceInstancesOptions) SetResourcePlanID(resourcePlanID string) *ListResourceInstancesOptions

SetResourcePlanID : Allow user to set ResourcePlanID

func (*ListResourceInstancesOptions) SetStart added in v0.18.9

SetStart : Allow user to set Start

func (*ListResourceInstancesOptions) SetState added in v0.18.1

SetState : Allow user to set State

func (*ListResourceInstancesOptions) SetSubType

func (_options *ListResourceInstancesOptions) SetSubType(subType string) *ListResourceInstancesOptions

SetSubType : Allow user to set SubType

func (*ListResourceInstancesOptions) SetType

SetType : Allow user to set Type

func (*ListResourceInstancesOptions) SetUpdatedFrom

func (_options *ListResourceInstancesOptions) SetUpdatedFrom(updatedFrom string) *ListResourceInstancesOptions

SetUpdatedFrom : Allow user to set UpdatedFrom

func (*ListResourceInstancesOptions) SetUpdatedTo

func (_options *ListResourceInstancesOptions) SetUpdatedTo(updatedTo string) *ListResourceInstancesOptions

SetUpdatedTo : Allow user to set UpdatedTo

type ListResourceKeysForInstanceOptions added in v0.17.16

type ListResourceKeysForInstanceOptions struct {
	// The resource instance URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

	// Limit on how many items should be returned.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. Any additional query
	// parameters are ignored if a page token is present. If omitted, the first page of results is returned. This value is
	// obtained from the 'start' query parameter in the 'next_url' field of the operation response.
	Start *string `json:"start,omitempty"`

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

ListResourceKeysForInstanceOptions : The ListResourceKeysForInstance options.

func (*ListResourceKeysForInstanceOptions) SetHeaders added in v0.17.16

SetHeaders : Allow user to set Headers

func (*ListResourceKeysForInstanceOptions) SetID added in v0.17.16

SetID : Allow user to set ID

func (*ListResourceKeysForInstanceOptions) SetLimit added in v0.18.9

SetLimit : Allow user to set Limit

func (*ListResourceKeysForInstanceOptions) SetStart added in v0.18.9

SetStart : Allow user to set Start

type ListResourceKeysOptions

type ListResourceKeysOptions struct {
	// The GUID of the key.
	GUID *string `json:"guid,omitempty"`

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

	// The ID of the resource group.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

	// The unique ID of the offering. This value is provided by and stored in the global catalog.
	ResourceID *string `json:"resource_id,omitempty"`

	// Limit on how many items should be returned.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. Any additional query
	// parameters are ignored if a page token is present. If omitted, the first page of results is returned. This value is
	// obtained from the 'start' query parameter in the 'next_url' field of the operation response.
	Start *string `json:"start,omitempty"`

	// Start date inclusive filter.
	UpdatedFrom *string `json:"updated_from,omitempty"`

	// End date inclusive filter.
	UpdatedTo *string `json:"updated_to,omitempty"`

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

ListResourceKeysOptions : The ListResourceKeys options.

func (*ListResourceKeysOptions) SetGUID added in v0.17.2

func (_options *ListResourceKeysOptions) SetGUID(guid string) *ListResourceKeysOptions

SetGUID : Allow user to set GUID

func (*ListResourceKeysOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListResourceKeysOptions) SetLimit

func (_options *ListResourceKeysOptions) SetLimit(limit int64) *ListResourceKeysOptions

SetLimit : Allow user to set Limit

func (*ListResourceKeysOptions) SetName

func (_options *ListResourceKeysOptions) SetName(name string) *ListResourceKeysOptions

SetName : Allow user to set Name

func (*ListResourceKeysOptions) SetResourceGroupID

func (_options *ListResourceKeysOptions) SetResourceGroupID(resourceGroupID string) *ListResourceKeysOptions

SetResourceGroupID : Allow user to set ResourceGroupID

func (*ListResourceKeysOptions) SetResourceID

func (_options *ListResourceKeysOptions) SetResourceID(resourceID string) *ListResourceKeysOptions

SetResourceID : Allow user to set ResourceID

func (*ListResourceKeysOptions) SetStart added in v0.18.9

func (_options *ListResourceKeysOptions) SetStart(start string) *ListResourceKeysOptions

SetStart : Allow user to set Start

func (*ListResourceKeysOptions) SetUpdatedFrom

func (_options *ListResourceKeysOptions) SetUpdatedFrom(updatedFrom string) *ListResourceKeysOptions

SetUpdatedFrom : Allow user to set UpdatedFrom

func (*ListResourceKeysOptions) SetUpdatedTo

func (_options *ListResourceKeysOptions) SetUpdatedTo(updatedTo string) *ListResourceKeysOptions

SetUpdatedTo : Allow user to set UpdatedTo

type LockResourceInstanceOptions

type LockResourceInstanceOptions struct {
	// The resource instance URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

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

LockResourceInstanceOptions : The LockResourceInstance options.

func (*LockResourceInstanceOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*LockResourceInstanceOptions) SetID

SetID : Allow user to set ID

type PlanHistoryItem

type PlanHistoryItem struct {
	// The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
	ResourcePlanID *string `json:"resource_plan_id" validate:"required"`

	// The date on which the plan was changed.
	StartDate *strfmt.DateTime `json:"start_date" validate:"required"`

	// The subject who made the plan change.
	RequestorID *string `json:"requestor_id,omitempty"`
}

PlanHistoryItem : An element of the plan history of the instance.

type Reclamation

type Reclamation struct {
	// The ID associated with the reclamation.
	ID *string `json:"id,omitempty"`

	// The ID of the entity for the reclamation.
	EntityID *string `json:"entity_id,omitempty"`

	// The ID of the entity type for the reclamation.
	EntityTypeID *string `json:"entity_type_id,omitempty"`

	// The full Cloud Resource Name (CRN) associated with the binding. For more information about this format, see [Cloud
	// Resource Names](https://cloud.ibm.com/docs/overview?topic=overview-crn).
	EntityCRN *string `json:"entity_crn,omitempty"`

	// The ID of the resource instance.
	ResourceInstanceID *string `json:"resource_instance_id,omitempty"`

	// The ID of the resource group.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

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

	// The ID of policy for the reclamation.
	PolicyID *string `json:"policy_id,omitempty"`

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

	// The target time that the reclamation retention period end.
	TargetTime *string `json:"target_time,omitempty"`

	// The custom properties of the reclamation.
	CustomProperties map[string]interface{} `json:"custom_properties,omitempty"`

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

	// The subject who created the reclamation.
	CreatedBy *string `json:"created_by,omitempty"`

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

	// The subject who updated the reclamation.
	UpdatedBy *string `json:"updated_by,omitempty"`
}

Reclamation : A reclamation.

type ReclamationsList

type ReclamationsList struct {
	// A list of reclamations.
	Resources []Reclamation `json:"resources,omitempty"`
}

ReclamationsList : A list of reclamations.

type ResourceAlias

type ResourceAlias struct {
	// The ID associated with the alias.
	ID *string `json:"id,omitempty"`

	// The GUID of the alias.
	GUID *string `json:"guid,omitempty"`

	// When you created a new alias, a relative URL path is created identifying the location of the alias.
	URL *string `json:"url,omitempty"`

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

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

	// The date when the alias was deleted.
	DeletedAt *strfmt.DateTime `json:"deleted_at,omitempty"`

	// The subject who created the alias.
	CreatedBy *string `json:"created_by,omitempty"`

	// The subject who updated the alias.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// The subject who deleted the alias.
	DeletedBy *string `json:"deleted_by,omitempty"`

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

	// The ID of the resource instance that is being aliased.
	ResourceInstanceID *string `json:"resource_instance_id,omitempty"`

	// The CRN of the target namespace in the specific environment.
	TargetCRN *string `json:"target_crn,omitempty"`

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

	// The unique ID of the offering. This value is provided by and stored in the global catalog.
	ResourceID *string `json:"resource_id,omitempty"`

	// The ID of the resource group.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

	// The CRN of the alias. For more information about this format, see [Cloud Resource
	// Names](https://cloud.ibm.com/docs/overview?topic=overview-crn).
	CRN *string `json:"crn,omitempty"`

	// The ID of the instance in the target environment. For example, `service_instance_id` in a given IBM Cloud
	// environment.
	RegionInstanceID *string `json:"region_instance_id,omitempty"`

	// The CRN of the instance in the target environment.
	RegionInstanceCRN *string `json:"region_instance_crn,omitempty"`

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

	// A boolean that dictates if the alias was migrated from a previous CF instance.
	Migrated *bool `json:"migrated,omitempty"`

	// The relative path to the resource instance.
	ResourceInstanceURL *string `json:"resource_instance_url,omitempty"`

	// The relative path to the resource bindings for the alias.
	ResourceBindingsURL *string `json:"resource_bindings_url,omitempty"`

	// The relative path to the resource keys for the alias.
	ResourceKeysURL *string `json:"resource_keys_url,omitempty"`
}

ResourceAlias : A resource alias.

type ResourceAliasesForInstancePager added in v0.29.3

type ResourceAliasesForInstancePager struct {
	// contains filtered or unexported fields
}

ResourceAliasesForInstancePager can be used to simplify the use of the "ListResourceAliasesForInstance" method.

func (*ResourceAliasesForInstancePager) GetAll added in v0.29.3

func (pager *ResourceAliasesForInstancePager) GetAll() (allItems []ResourceAlias, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*ResourceAliasesForInstancePager) GetAllWithContext added in v0.29.3

func (pager *ResourceAliasesForInstancePager) GetAllWithContext(ctx context.Context) (allItems []ResourceAlias, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*ResourceAliasesForInstancePager) GetNext added in v0.29.3

func (pager *ResourceAliasesForInstancePager) GetNext() (page []ResourceAlias, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*ResourceAliasesForInstancePager) GetNextWithContext added in v0.29.3

func (pager *ResourceAliasesForInstancePager) GetNextWithContext(ctx context.Context) (page []ResourceAlias, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*ResourceAliasesForInstancePager) HasNext added in v0.29.3

func (pager *ResourceAliasesForInstancePager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type ResourceAliasesList

type ResourceAliasesList struct {
	// The number of resource aliases in `resources`.
	RowsCount *int64 `json:"rows_count" validate:"required"`

	// The URL for requesting the next page of results.
	NextURL *string `json:"next_url" validate:"required"`

	// A list of resource aliases.
	Resources []ResourceAlias `json:"resources" validate:"required"`
}

ResourceAliasesList : A list of resource aliases.

func (*ResourceAliasesList) GetNextStart added in v0.29.3

func (resp *ResourceAliasesList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type ResourceAliasesPager added in v0.29.3

type ResourceAliasesPager struct {
	// contains filtered or unexported fields
}

ResourceAliasesPager can be used to simplify the use of the "ListResourceAliases" method.

func (*ResourceAliasesPager) GetAll added in v0.29.3

func (pager *ResourceAliasesPager) GetAll() (allItems []ResourceAlias, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*ResourceAliasesPager) GetAllWithContext added in v0.29.3

func (pager *ResourceAliasesPager) GetAllWithContext(ctx context.Context) (allItems []ResourceAlias, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*ResourceAliasesPager) GetNext added in v0.29.3

func (pager *ResourceAliasesPager) GetNext() (page []ResourceAlias, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*ResourceAliasesPager) GetNextWithContext added in v0.29.3

func (pager *ResourceAliasesPager) GetNextWithContext(ctx context.Context) (page []ResourceAlias, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*ResourceAliasesPager) HasNext added in v0.29.3

func (pager *ResourceAliasesPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type ResourceBinding

type ResourceBinding struct {
	// The ID associated with the binding.
	ID *string `json:"id,omitempty"`

	// The GUID of the binding.
	GUID *string `json:"guid,omitempty"`

	// When you provision a new binding, a relative URL path is created identifying the location of the binding.
	URL *string `json:"url,omitempty"`

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

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

	// The date when the binding was deleted.
	DeletedAt *strfmt.DateTime `json:"deleted_at,omitempty"`

	// The subject who created the binding.
	CreatedBy *string `json:"created_by,omitempty"`

	// The subject who updated the binding.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// The subject who deleted the binding.
	DeletedBy *string `json:"deleted_by,omitempty"`

	// The CRN of resource alias associated to the binding.
	SourceCRN *string `json:"source_crn,omitempty"`

	// The CRN of target resource, for example, application, in a specific environment.
	TargetCRN *string `json:"target_crn,omitempty"`

	// The full Cloud Resource Name (CRN) associated with the binding. For more information about this format, see [Cloud
	// Resource Names](https://cloud.ibm.com/docs/overview?topic=overview-crn).
	CRN *string `json:"crn,omitempty"`

	// The ID of the binding in the target environment. For example, `service_binding_id` in a given IBM Cloud environment.
	RegionBindingID *string `json:"region_binding_id,omitempty"`

	// The CRN of the binding in the target environment.
	RegionBindingCRN *string `json:"region_binding_crn,omitempty"`

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

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

	// The ID of the resource group.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

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

	// The credentials for the binding. Additional key-value pairs are passed through from the resource brokers. After a
	// credential is created for a service, it can be viewed at any time for users that need the API key value. However,
	// all users must have the correct level of access to see the details of a credential that includes the API key value.
	// For additional details, see [viewing a
	// credential](https://cloud.ibm.com/docs/account?topic=account-service_credentials&interface=ui#viewing-credentials-ui)
	// or the service’s documentation.
	Credentials *Credentials `json:"credentials,omitempty"`

	// Specifies whether the binding’s credentials support IAM.
	IamCompatible *bool `json:"iam_compatible,omitempty"`

	// The unique ID of the offering. This value is provided by and stored in the global catalog.
	ResourceID *string `json:"resource_id,omitempty"`

	// A boolean that dictates if the alias was migrated from a previous CF instance.
	Migrated *bool `json:"migrated,omitempty"`

	// The relative path to the resource alias that this binding is associated with.
	ResourceAliasURL *string `json:"resource_alias_url,omitempty"`
}

ResourceBinding : A resource binding.

type ResourceBindingPostParameters

type ResourceBindingPostParameters struct {
	// An optional platform defined option to reuse an existing IAM serviceId for the role assignment.
	ServiceidCRN *string `json:"serviceid_crn,omitempty"`
	// contains filtered or unexported fields
}

ResourceBindingPostParameters : Configuration options represented as key-value pairs. Service defined options are passed through to the target resource brokers, whereas platform defined options are not. This type supports additional properties of type interface{}.

func (*ResourceBindingPostParameters) GetProperties added in v0.17.16

func (o *ResourceBindingPostParameters) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of ResourceBindingPostParameters.

func (*ResourceBindingPostParameters) GetProperty added in v0.17.16

func (o *ResourceBindingPostParameters) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of ResourceBindingPostParameters.

func (*ResourceBindingPostParameters) MarshalJSON added in v0.17.16

func (o *ResourceBindingPostParameters) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of ResourceBindingPostParameters

func (*ResourceBindingPostParameters) SetProperties added in v0.29.3

func (o *ResourceBindingPostParameters) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of ResourceBindingPostParameters.

func (*ResourceBindingPostParameters) SetProperty added in v0.17.16

func (o *ResourceBindingPostParameters) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of ResourceBindingPostParameters.

type ResourceBindingsForAliasPager added in v0.29.3

type ResourceBindingsForAliasPager struct {
	// contains filtered or unexported fields
}

ResourceBindingsForAliasPager can be used to simplify the use of the "ListResourceBindingsForAlias" method.

func (*ResourceBindingsForAliasPager) GetAll added in v0.29.3

func (pager *ResourceBindingsForAliasPager) GetAll() (allItems []ResourceBinding, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*ResourceBindingsForAliasPager) GetAllWithContext added in v0.29.3

func (pager *ResourceBindingsForAliasPager) GetAllWithContext(ctx context.Context) (allItems []ResourceBinding, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*ResourceBindingsForAliasPager) GetNext added in v0.29.3

func (pager *ResourceBindingsForAliasPager) GetNext() (page []ResourceBinding, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*ResourceBindingsForAliasPager) GetNextWithContext added in v0.29.3

func (pager *ResourceBindingsForAliasPager) GetNextWithContext(ctx context.Context) (page []ResourceBinding, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*ResourceBindingsForAliasPager) HasNext added in v0.29.3

func (pager *ResourceBindingsForAliasPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type ResourceBindingsList

type ResourceBindingsList struct {
	// The number of resource bindings in `resources`.
	RowsCount *int64 `json:"rows_count" validate:"required"`

	// The URL for requesting the next page of results.
	NextURL *string `json:"next_url" validate:"required"`

	// A list of resource bindings.
	Resources []ResourceBinding `json:"resources" validate:"required"`
}

ResourceBindingsList : A list of resource bindings.

func (*ResourceBindingsList) GetNextStart added in v0.29.3

func (resp *ResourceBindingsList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type ResourceBindingsPager added in v0.29.3

type ResourceBindingsPager struct {
	// contains filtered or unexported fields
}

ResourceBindingsPager can be used to simplify the use of the "ListResourceBindings" method.

func (*ResourceBindingsPager) GetAll added in v0.29.3

func (pager *ResourceBindingsPager) GetAll() (allItems []ResourceBinding, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*ResourceBindingsPager) GetAllWithContext added in v0.29.3

func (pager *ResourceBindingsPager) GetAllWithContext(ctx context.Context) (allItems []ResourceBinding, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*ResourceBindingsPager) GetNext added in v0.29.3

func (pager *ResourceBindingsPager) GetNext() (page []ResourceBinding, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*ResourceBindingsPager) GetNextWithContext added in v0.29.3

func (pager *ResourceBindingsPager) GetNextWithContext(ctx context.Context) (page []ResourceBinding, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*ResourceBindingsPager) HasNext added in v0.29.3

func (pager *ResourceBindingsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type ResourceControllerV2

type ResourceControllerV2 struct {
	Service *core.BaseService
}

ResourceControllerV2 : Manage lifecycle of your Cloud resources using Resource Controller APIs. Resources are provisioned globally in an account scope. Supports asynchronous provisioning of resources. Enables consumption of a global resource through a Cloud Foundry space in any region.

API Version: 2.0

func NewResourceControllerV2

func NewResourceControllerV2(options *ResourceControllerV2Options) (service *ResourceControllerV2, err error)

NewResourceControllerV2 : constructs an instance of ResourceControllerV2 with passed in options.

func NewResourceControllerV2UsingExternalConfig

func NewResourceControllerV2UsingExternalConfig(options *ResourceControllerV2Options) (resourceController *ResourceControllerV2, err error)

NewResourceControllerV2UsingExternalConfig : constructs an instance of ResourceControllerV2 with passed in options and external configuration.

func (*ResourceControllerV2) CancelLastopResourceInstance added in v0.27.0

func (resourceController *ResourceControllerV2) CancelLastopResourceInstance(cancelLastopResourceInstanceOptions *CancelLastopResourceInstanceOptions) (result *ResourceInstance, response *core.DetailedResponse, err error)

CancelLastopResourceInstance : Cancel the in progress last operation of the resource instance Cancel the in progress last operation of the resource instance. After successful cancellation, the resource instance is removed.

func (*ResourceControllerV2) CancelLastopResourceInstanceWithContext added in v0.27.0

func (resourceController *ResourceControllerV2) CancelLastopResourceInstanceWithContext(ctx context.Context, cancelLastopResourceInstanceOptions *CancelLastopResourceInstanceOptions) (result *ResourceInstance, response *core.DetailedResponse, err error)

CancelLastopResourceInstanceWithContext is an alternate form of the CancelLastopResourceInstance method which supports a Context parameter

func (*ResourceControllerV2) Clone added in v0.17.2

func (resourceController *ResourceControllerV2) Clone() *ResourceControllerV2

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

func (*ResourceControllerV2) CreateResourceAlias

func (resourceController *ResourceControllerV2) CreateResourceAlias(createResourceAliasOptions *CreateResourceAliasOptions) (result *ResourceAlias, response *core.DetailedResponse, err error)

CreateResourceAlias : Create a new resource alias Alias a resource instance into a targeted environment's (name)space. Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) CreateResourceAliasWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) CreateResourceAliasWithContext(ctx context.Context, createResourceAliasOptions *CreateResourceAliasOptions) (result *ResourceAlias, response *core.DetailedResponse, err error)

CreateResourceAliasWithContext is an alternate form of the CreateResourceAlias method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) CreateResourceBinding

func (resourceController *ResourceControllerV2) CreateResourceBinding(createResourceBindingOptions *CreateResourceBindingOptions) (result *ResourceBinding, response *core.DetailedResponse, err error)

CreateResourceBinding : Create a new resource binding A resource binding connects credentials to a resource alias. The credentials are in the form of a resource key. Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) CreateResourceBindingWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) CreateResourceBindingWithContext(ctx context.Context, createResourceBindingOptions *CreateResourceBindingOptions) (result *ResourceBinding, response *core.DetailedResponse, err error)

CreateResourceBindingWithContext is an alternate form of the CreateResourceBinding method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) CreateResourceInstance

func (resourceController *ResourceControllerV2) CreateResourceInstance(createResourceInstanceOptions *CreateResourceInstanceOptions) (result *ResourceInstance, response *core.DetailedResponse, err error)

CreateResourceInstance : Create (provision) a new resource instance When you provision a service you get an instance of that service. An instance represents the resource with which you create, and additionally, represents a chargeable record of which billing can occur.

func (*ResourceControllerV2) CreateResourceInstanceWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) CreateResourceInstanceWithContext(ctx context.Context, createResourceInstanceOptions *CreateResourceInstanceOptions) (result *ResourceInstance, response *core.DetailedResponse, err error)

CreateResourceInstanceWithContext is an alternate form of the CreateResourceInstance method which supports a Context parameter

func (*ResourceControllerV2) CreateResourceKey

func (resourceController *ResourceControllerV2) CreateResourceKey(createResourceKeyOptions *CreateResourceKeyOptions) (result *ResourceKey, response *core.DetailedResponse, err error)

CreateResourceKey : Create a new resource key A resource key is a saved credential you can use to authenticate with a resource instance.

func (*ResourceControllerV2) CreateResourceKeyWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) CreateResourceKeyWithContext(ctx context.Context, createResourceKeyOptions *CreateResourceKeyOptions) (result *ResourceKey, response *core.DetailedResponse, err error)

CreateResourceKeyWithContext is an alternate form of the CreateResourceKey method which supports a Context parameter

func (*ResourceControllerV2) DeleteResourceAlias

func (resourceController *ResourceControllerV2) DeleteResourceAlias(deleteResourceAliasOptions *DeleteResourceAliasOptions) (response *core.DetailedResponse, err error)

DeleteResourceAlias : Delete a resource alias Delete a resource alias by URL-encoded CRN or GUID. If the resource alias has any resource keys or bindings associated with it, use the `recursive=true` parameter to delete it. Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) DeleteResourceAliasWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) DeleteResourceAliasWithContext(ctx context.Context, deleteResourceAliasOptions *DeleteResourceAliasOptions) (response *core.DetailedResponse, err error)

DeleteResourceAliasWithContext is an alternate form of the DeleteResourceAlias method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) DeleteResourceBinding

func (resourceController *ResourceControllerV2) DeleteResourceBinding(deleteResourceBindingOptions *DeleteResourceBindingOptions) (response *core.DetailedResponse, err error)

DeleteResourceBinding : Delete a resource binding Deleting a resource binding does not affect the resource alias that the binding is associated with. Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) DeleteResourceBindingWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) DeleteResourceBindingWithContext(ctx context.Context, deleteResourceBindingOptions *DeleteResourceBindingOptions) (response *core.DetailedResponse, err error)

DeleteResourceBindingWithContext is an alternate form of the DeleteResourceBinding method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) DeleteResourceInstance

func (resourceController *ResourceControllerV2) DeleteResourceInstance(deleteResourceInstanceOptions *DeleteResourceInstanceOptions) (response *core.DetailedResponse, err error)

DeleteResourceInstance : Delete a resource instance Delete a resource instance by URL-encoded CRN or GUID. If the resource instance has any resource keys or aliases associated with it, use the `recursive=true` parameter to delete it.

func (*ResourceControllerV2) DeleteResourceInstanceWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) DeleteResourceInstanceWithContext(ctx context.Context, deleteResourceInstanceOptions *DeleteResourceInstanceOptions) (response *core.DetailedResponse, err error)

DeleteResourceInstanceWithContext is an alternate form of the DeleteResourceInstance method which supports a Context parameter

func (*ResourceControllerV2) DeleteResourceKey

func (resourceController *ResourceControllerV2) DeleteResourceKey(deleteResourceKeyOptions *DeleteResourceKeyOptions) (response *core.DetailedResponse, err error)

DeleteResourceKey : Delete a resource key Deleting a resource key does not affect any resource instance or resource alias associated with the key.

func (*ResourceControllerV2) DeleteResourceKeyWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) DeleteResourceKeyWithContext(ctx context.Context, deleteResourceKeyOptions *DeleteResourceKeyOptions) (response *core.DetailedResponse, err error)

DeleteResourceKeyWithContext is an alternate form of the DeleteResourceKey method which supports a Context parameter

func (*ResourceControllerV2) DisableRetries added in v0.12.2

func (resourceController *ResourceControllerV2) DisableRetries()

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

func (*ResourceControllerV2) EnableRetries added in v0.12.2

func (resourceController *ResourceControllerV2) 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 (*ResourceControllerV2) GetEnableGzipCompression added in v0.12.2

func (resourceController *ResourceControllerV2) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*ResourceControllerV2) GetResourceAlias

func (resourceController *ResourceControllerV2) GetResourceAlias(getResourceAliasOptions *GetResourceAliasOptions) (result *ResourceAlias, response *core.DetailedResponse, err error)

GetResourceAlias : Get a resource alias View a resource alias and all of its details, like who created it and the resource instance that it's associated with. Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) GetResourceAliasWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) GetResourceAliasWithContext(ctx context.Context, getResourceAliasOptions *GetResourceAliasOptions) (result *ResourceAlias, response *core.DetailedResponse, err error)

GetResourceAliasWithContext is an alternate form of the GetResourceAlias method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) GetResourceBinding

func (resourceController *ResourceControllerV2) GetResourceBinding(getResourceBindingOptions *GetResourceBindingOptions) (result *ResourceBinding, response *core.DetailedResponse, err error)

GetResourceBinding : Get a resource binding View a resource binding and all of its details, like who created it, the credential, and the resource alias that the binding is associated with. Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) GetResourceBindingWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) GetResourceBindingWithContext(ctx context.Context, getResourceBindingOptions *GetResourceBindingOptions) (result *ResourceBinding, response *core.DetailedResponse, err error)

GetResourceBindingWithContext is an alternate form of the GetResourceBinding method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) GetResourceInstance

func (resourceController *ResourceControllerV2) GetResourceInstance(getResourceInstanceOptions *GetResourceInstanceOptions) (result *ResourceInstance, response *core.DetailedResponse, err error)

GetResourceInstance : Get a resource instance Retrieve a resource instance by URL-encoded CRN or GUID. Find more details on a particular instance, like when it was provisioned and who provisioned it.

func (*ResourceControllerV2) GetResourceInstanceWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) GetResourceInstanceWithContext(ctx context.Context, getResourceInstanceOptions *GetResourceInstanceOptions) (result *ResourceInstance, response *core.DetailedResponse, err error)

GetResourceInstanceWithContext is an alternate form of the GetResourceInstance method which supports a Context parameter

func (*ResourceControllerV2) GetResourceKey

func (resourceController *ResourceControllerV2) GetResourceKey(getResourceKeyOptions *GetResourceKeyOptions) (result *ResourceKey, response *core.DetailedResponse, err error)

GetResourceKey : Get resource key View the details of a resource key by URL-encoded CRN or GUID, like the credentials for the key and who created it.

func (*ResourceControllerV2) GetResourceKeyWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) GetResourceKeyWithContext(ctx context.Context, getResourceKeyOptions *GetResourceKeyOptions) (result *ResourceKey, response *core.DetailedResponse, err error)

GetResourceKeyWithContext is an alternate form of the GetResourceKey method which supports a Context parameter

func (*ResourceControllerV2) GetServiceURL added in v0.12.2

func (resourceController *ResourceControllerV2) GetServiceURL() string

GetServiceURL returns the service URL

func (*ResourceControllerV2) ListReclamations

func (resourceController *ResourceControllerV2) ListReclamations(listReclamationsOptions *ListReclamationsOptions) (result *ReclamationsList, response *core.DetailedResponse, err error)

ListReclamations : Get a list of all reclamations View all of the resource reclamations that exist for every resource instance.

func (*ResourceControllerV2) ListReclamationsWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) ListReclamationsWithContext(ctx context.Context, listReclamationsOptions *ListReclamationsOptions) (result *ReclamationsList, response *core.DetailedResponse, err error)

ListReclamationsWithContext is an alternate form of the ListReclamations method which supports a Context parameter

func (*ResourceControllerV2) ListResourceAliases

func (resourceController *ResourceControllerV2) ListResourceAliases(listResourceAliasesOptions *ListResourceAliasesOptions) (result *ResourceAliasesList, response *core.DetailedResponse, err error)

ListResourceAliases : Get a list of all resource aliases View all of the resource aliases that exist for every resource instance. Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) ListResourceAliasesForInstance added in v0.17.16

func (resourceController *ResourceControllerV2) ListResourceAliasesForInstance(listResourceAliasesForInstanceOptions *ListResourceAliasesForInstanceOptions) (result *ResourceAliasesList, response *core.DetailedResponse, err error)

ListResourceAliasesForInstance : Get a list of all resource aliases for the instance Retrieving a list of all resource aliases can help you find out who's using the resource instance. Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) ListResourceAliasesForInstanceWithContext added in v0.17.16

func (resourceController *ResourceControllerV2) ListResourceAliasesForInstanceWithContext(ctx context.Context, listResourceAliasesForInstanceOptions *ListResourceAliasesForInstanceOptions) (result *ResourceAliasesList, response *core.DetailedResponse, err error)

ListResourceAliasesForInstanceWithContext is an alternate form of the ListResourceAliasesForInstance method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) ListResourceAliasesWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) ListResourceAliasesWithContext(ctx context.Context, listResourceAliasesOptions *ListResourceAliasesOptions) (result *ResourceAliasesList, response *core.DetailedResponse, err error)

ListResourceAliasesWithContext is an alternate form of the ListResourceAliases method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) ListResourceBindings

func (resourceController *ResourceControllerV2) ListResourceBindings(listResourceBindingsOptions *ListResourceBindingsOptions) (result *ResourceBindingsList, response *core.DetailedResponse, err error)

ListResourceBindings : Get a list of all resource bindings View all of the resource bindings that exist for all of your resource aliases. Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) ListResourceBindingsForAlias added in v0.17.16

func (resourceController *ResourceControllerV2) ListResourceBindingsForAlias(listResourceBindingsForAliasOptions *ListResourceBindingsForAliasOptions) (result *ResourceBindingsList, response *core.DetailedResponse, err error)

ListResourceBindingsForAlias : Get a list of all resource bindings for the alias View all of the resource bindings associated with a specific resource alias. Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) ListResourceBindingsForAliasWithContext added in v0.17.16

func (resourceController *ResourceControllerV2) ListResourceBindingsForAliasWithContext(ctx context.Context, listResourceBindingsForAliasOptions *ListResourceBindingsForAliasOptions) (result *ResourceBindingsList, response *core.DetailedResponse, err error)

ListResourceBindingsForAliasWithContext is an alternate form of the ListResourceBindingsForAlias method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) ListResourceBindingsWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) ListResourceBindingsWithContext(ctx context.Context, listResourceBindingsOptions *ListResourceBindingsOptions) (result *ResourceBindingsList, response *core.DetailedResponse, err error)

ListResourceBindingsWithContext is an alternate form of the ListResourceBindings method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) ListResourceInstances

func (resourceController *ResourceControllerV2) ListResourceInstances(listResourceInstancesOptions *ListResourceInstancesOptions) (result *ResourceInstancesList, response *core.DetailedResponse, err error)

ListResourceInstances : Get a list of all resource instances View a list of all available resource instances. Resources is a broad term that could mean anything from a service instance to a virtual machine associated with the customer account.

func (*ResourceControllerV2) ListResourceInstancesWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) ListResourceInstancesWithContext(ctx context.Context, listResourceInstancesOptions *ListResourceInstancesOptions) (result *ResourceInstancesList, response *core.DetailedResponse, err error)

ListResourceInstancesWithContext is an alternate form of the ListResourceInstances method which supports a Context parameter

func (*ResourceControllerV2) ListResourceKeys

func (resourceController *ResourceControllerV2) ListResourceKeys(listResourceKeysOptions *ListResourceKeysOptions) (result *ResourceKeysList, response *core.DetailedResponse, err error)

ListResourceKeys : Get a list of all of the resource keys View all of the resource keys that exist for all of your resource instances.

func (*ResourceControllerV2) ListResourceKeysForInstance added in v0.17.16

func (resourceController *ResourceControllerV2) ListResourceKeysForInstance(listResourceKeysForInstanceOptions *ListResourceKeysForInstanceOptions) (result *ResourceKeysList, response *core.DetailedResponse, err error)

ListResourceKeysForInstance : Get a list of all the resource keys for the instance You may have many resource keys for one resource instance. For example, you may have a different resource key for each user or each role.

func (*ResourceControllerV2) ListResourceKeysForInstanceWithContext added in v0.17.16

func (resourceController *ResourceControllerV2) ListResourceKeysForInstanceWithContext(ctx context.Context, listResourceKeysForInstanceOptions *ListResourceKeysForInstanceOptions) (result *ResourceKeysList, response *core.DetailedResponse, err error)

ListResourceKeysForInstanceWithContext is an alternate form of the ListResourceKeysForInstance method which supports a Context parameter

func (*ResourceControllerV2) ListResourceKeysWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) ListResourceKeysWithContext(ctx context.Context, listResourceKeysOptions *ListResourceKeysOptions) (result *ResourceKeysList, response *core.DetailedResponse, err error)

ListResourceKeysWithContext is an alternate form of the ListResourceKeys method which supports a Context parameter

func (*ResourceControllerV2) LockResourceInstance

func (resourceController *ResourceControllerV2) LockResourceInstance(lockResourceInstanceOptions *LockResourceInstanceOptions) (result *ResourceInstance, response *core.DetailedResponse, err error)

LockResourceInstance : Lock a resource instance Locks a resource instance. A locked instance can not be updated or deleted. It does not affect actions performed on child resources like aliases, bindings, or keys.

func (*ResourceControllerV2) LockResourceInstanceWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) LockResourceInstanceWithContext(ctx context.Context, lockResourceInstanceOptions *LockResourceInstanceOptions) (result *ResourceInstance, response *core.DetailedResponse, err error)

LockResourceInstanceWithContext is an alternate form of the LockResourceInstance method which supports a Context parameter

func (*ResourceControllerV2) NewCancelLastopResourceInstanceOptions added in v0.27.0

func (*ResourceControllerV2) NewCancelLastopResourceInstanceOptions(id string) *CancelLastopResourceInstanceOptions

NewCancelLastopResourceInstanceOptions : Instantiate CancelLastopResourceInstanceOptions

func (*ResourceControllerV2) NewCreateResourceAliasOptions

func (*ResourceControllerV2) NewCreateResourceAliasOptions(name string, source string, target string) *CreateResourceAliasOptions

NewCreateResourceAliasOptions : Instantiate CreateResourceAliasOptions

func (*ResourceControllerV2) NewCreateResourceBindingOptions

func (*ResourceControllerV2) NewCreateResourceBindingOptions(source string, target string) *CreateResourceBindingOptions

NewCreateResourceBindingOptions : Instantiate CreateResourceBindingOptions

func (*ResourceControllerV2) NewCreateResourceInstanceOptions

func (*ResourceControllerV2) NewCreateResourceInstanceOptions(name string, target string, resourceGroup string, resourcePlanID string) *CreateResourceInstanceOptions

NewCreateResourceInstanceOptions : Instantiate CreateResourceInstanceOptions

func (*ResourceControllerV2) NewCreateResourceKeyOptions

func (*ResourceControllerV2) NewCreateResourceKeyOptions(name string, source string) *CreateResourceKeyOptions

NewCreateResourceKeyOptions : Instantiate CreateResourceKeyOptions

func (*ResourceControllerV2) NewDeleteResourceAliasOptions

func (*ResourceControllerV2) NewDeleteResourceAliasOptions(id string) *DeleteResourceAliasOptions

NewDeleteResourceAliasOptions : Instantiate DeleteResourceAliasOptions

func (*ResourceControllerV2) NewDeleteResourceBindingOptions

func (*ResourceControllerV2) NewDeleteResourceBindingOptions(id string) *DeleteResourceBindingOptions

NewDeleteResourceBindingOptions : Instantiate DeleteResourceBindingOptions

func (*ResourceControllerV2) NewDeleteResourceInstanceOptions

func (*ResourceControllerV2) NewDeleteResourceInstanceOptions(id string) *DeleteResourceInstanceOptions

NewDeleteResourceInstanceOptions : Instantiate DeleteResourceInstanceOptions

func (*ResourceControllerV2) NewDeleteResourceKeyOptions

func (*ResourceControllerV2) NewDeleteResourceKeyOptions(id string) *DeleteResourceKeyOptions

NewDeleteResourceKeyOptions : Instantiate DeleteResourceKeyOptions

func (*ResourceControllerV2) NewGetResourceAliasOptions

func (*ResourceControllerV2) NewGetResourceAliasOptions(id string) *GetResourceAliasOptions

NewGetResourceAliasOptions : Instantiate GetResourceAliasOptions

func (*ResourceControllerV2) NewGetResourceBindingOptions

func (*ResourceControllerV2) NewGetResourceBindingOptions(id string) *GetResourceBindingOptions

NewGetResourceBindingOptions : Instantiate GetResourceBindingOptions

func (*ResourceControllerV2) NewGetResourceInstanceOptions

func (*ResourceControllerV2) NewGetResourceInstanceOptions(id string) *GetResourceInstanceOptions

NewGetResourceInstanceOptions : Instantiate GetResourceInstanceOptions

func (*ResourceControllerV2) NewGetResourceKeyOptions

func (*ResourceControllerV2) NewGetResourceKeyOptions(id string) *GetResourceKeyOptions

NewGetResourceKeyOptions : Instantiate GetResourceKeyOptions

func (*ResourceControllerV2) NewListReclamationsOptions

func (*ResourceControllerV2) NewListReclamationsOptions() *ListReclamationsOptions

NewListReclamationsOptions : Instantiate ListReclamationsOptions

func (*ResourceControllerV2) NewListResourceAliasesForInstanceOptions added in v0.17.16

func (*ResourceControllerV2) NewListResourceAliasesForInstanceOptions(id string) *ListResourceAliasesForInstanceOptions

NewListResourceAliasesForInstanceOptions : Instantiate ListResourceAliasesForInstanceOptions

func (*ResourceControllerV2) NewListResourceAliasesOptions

func (*ResourceControllerV2) NewListResourceAliasesOptions() *ListResourceAliasesOptions

NewListResourceAliasesOptions : Instantiate ListResourceAliasesOptions

func (*ResourceControllerV2) NewListResourceBindingsForAliasOptions added in v0.17.16

func (*ResourceControllerV2) NewListResourceBindingsForAliasOptions(id string) *ListResourceBindingsForAliasOptions

NewListResourceBindingsForAliasOptions : Instantiate ListResourceBindingsForAliasOptions

func (*ResourceControllerV2) NewListResourceBindingsOptions

func (*ResourceControllerV2) NewListResourceBindingsOptions() *ListResourceBindingsOptions

NewListResourceBindingsOptions : Instantiate ListResourceBindingsOptions

func (*ResourceControllerV2) NewListResourceInstancesOptions

func (*ResourceControllerV2) NewListResourceInstancesOptions() *ListResourceInstancesOptions

NewListResourceInstancesOptions : Instantiate ListResourceInstancesOptions

func (*ResourceControllerV2) NewListResourceKeysForInstanceOptions added in v0.17.16

func (*ResourceControllerV2) NewListResourceKeysForInstanceOptions(id string) *ListResourceKeysForInstanceOptions

NewListResourceKeysForInstanceOptions : Instantiate ListResourceKeysForInstanceOptions

func (*ResourceControllerV2) NewListResourceKeysOptions

func (*ResourceControllerV2) NewListResourceKeysOptions() *ListResourceKeysOptions

NewListResourceKeysOptions : Instantiate ListResourceKeysOptions

func (*ResourceControllerV2) NewLockResourceInstanceOptions

func (*ResourceControllerV2) NewLockResourceInstanceOptions(id string) *LockResourceInstanceOptions

NewLockResourceInstanceOptions : Instantiate LockResourceInstanceOptions

func (*ResourceControllerV2) NewResourceAliasesForInstancePager added in v0.29.3

func (resourceController *ResourceControllerV2) NewResourceAliasesForInstancePager(options *ListResourceAliasesForInstanceOptions) (pager *ResourceAliasesForInstancePager, err error)

NewResourceAliasesForInstancePager returns a new ResourceAliasesForInstancePager instance.

func (*ResourceControllerV2) NewResourceAliasesPager added in v0.29.3

func (resourceController *ResourceControllerV2) NewResourceAliasesPager(options *ListResourceAliasesOptions) (pager *ResourceAliasesPager, err error)

NewResourceAliasesPager returns a new ResourceAliasesPager instance.

func (*ResourceControllerV2) NewResourceBindingsForAliasPager added in v0.29.3

func (resourceController *ResourceControllerV2) NewResourceBindingsForAliasPager(options *ListResourceBindingsForAliasOptions) (pager *ResourceBindingsForAliasPager, err error)

NewResourceBindingsForAliasPager returns a new ResourceBindingsForAliasPager instance.

func (*ResourceControllerV2) NewResourceBindingsPager added in v0.29.3

func (resourceController *ResourceControllerV2) NewResourceBindingsPager(options *ListResourceBindingsOptions) (pager *ResourceBindingsPager, err error)

NewResourceBindingsPager returns a new ResourceBindingsPager instance.

func (*ResourceControllerV2) NewResourceInstancesPager added in v0.29.3

func (resourceController *ResourceControllerV2) NewResourceInstancesPager(options *ListResourceInstancesOptions) (pager *ResourceInstancesPager, err error)

NewResourceInstancesPager returns a new ResourceInstancesPager instance.

func (*ResourceControllerV2) NewResourceKeysForInstancePager added in v0.29.3

func (resourceController *ResourceControllerV2) NewResourceKeysForInstancePager(options *ListResourceKeysForInstanceOptions) (pager *ResourceKeysForInstancePager, err error)

NewResourceKeysForInstancePager returns a new ResourceKeysForInstancePager instance.

func (*ResourceControllerV2) NewResourceKeysPager added in v0.29.3

func (resourceController *ResourceControllerV2) NewResourceKeysPager(options *ListResourceKeysOptions) (pager *ResourceKeysPager, err error)

NewResourceKeysPager returns a new ResourceKeysPager instance.

func (*ResourceControllerV2) NewRunReclamationActionOptions

func (*ResourceControllerV2) NewRunReclamationActionOptions(id string, actionName string) *RunReclamationActionOptions

NewRunReclamationActionOptions : Instantiate RunReclamationActionOptions

func (*ResourceControllerV2) NewUnlockResourceInstanceOptions

func (*ResourceControllerV2) NewUnlockResourceInstanceOptions(id string) *UnlockResourceInstanceOptions

NewUnlockResourceInstanceOptions : Instantiate UnlockResourceInstanceOptions

func (*ResourceControllerV2) NewUpdateResourceAliasOptions

func (*ResourceControllerV2) NewUpdateResourceAliasOptions(id string, name string) *UpdateResourceAliasOptions

NewUpdateResourceAliasOptions : Instantiate UpdateResourceAliasOptions

func (*ResourceControllerV2) NewUpdateResourceBindingOptions

func (*ResourceControllerV2) NewUpdateResourceBindingOptions(id string, name string) *UpdateResourceBindingOptions

NewUpdateResourceBindingOptions : Instantiate UpdateResourceBindingOptions

func (*ResourceControllerV2) NewUpdateResourceInstanceOptions

func (*ResourceControllerV2) NewUpdateResourceInstanceOptions(id string) *UpdateResourceInstanceOptions

NewUpdateResourceInstanceOptions : Instantiate UpdateResourceInstanceOptions

func (*ResourceControllerV2) NewUpdateResourceKeyOptions

func (*ResourceControllerV2) NewUpdateResourceKeyOptions(id string, name string) *UpdateResourceKeyOptions

NewUpdateResourceKeyOptions : Instantiate UpdateResourceKeyOptions

func (*ResourceControllerV2) RunReclamationAction

func (resourceController *ResourceControllerV2) RunReclamationAction(runReclamationActionOptions *RunReclamationActionOptions) (result *Reclamation, response *core.DetailedResponse, err error)

RunReclamationAction : Perform a reclamation action Reclaim a resource instance so that it can no longer be used, or restore the resource instance so that it's usable again.

func (*ResourceControllerV2) RunReclamationActionWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) RunReclamationActionWithContext(ctx context.Context, runReclamationActionOptions *RunReclamationActionOptions) (result *Reclamation, response *core.DetailedResponse, err error)

RunReclamationActionWithContext is an alternate form of the RunReclamationAction method which supports a Context parameter

func (*ResourceControllerV2) SetDefaultHeaders added in v0.12.2

func (resourceController *ResourceControllerV2) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*ResourceControllerV2) SetEnableGzipCompression added in v0.12.2

func (resourceController *ResourceControllerV2) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*ResourceControllerV2) SetServiceURL

func (resourceController *ResourceControllerV2) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*ResourceControllerV2) UnlockResourceInstance

func (resourceController *ResourceControllerV2) UnlockResourceInstance(unlockResourceInstanceOptions *UnlockResourceInstanceOptions) (result *ResourceInstance, response *core.DetailedResponse, err error)

UnlockResourceInstance : Unlock a resource instance Unlock a resource instance to update or delete it. Unlocking a resource instance does not affect child resources like aliases, bindings or keys.

func (*ResourceControllerV2) UnlockResourceInstanceWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) UnlockResourceInstanceWithContext(ctx context.Context, unlockResourceInstanceOptions *UnlockResourceInstanceOptions) (result *ResourceInstance, response *core.DetailedResponse, err error)

UnlockResourceInstanceWithContext is an alternate form of the UnlockResourceInstance method which supports a Context parameter

func (*ResourceControllerV2) UpdateResourceAlias

func (resourceController *ResourceControllerV2) UpdateResourceAlias(updateResourceAliasOptions *UpdateResourceAliasOptions) (result *ResourceAlias, response *core.DetailedResponse, err error)

UpdateResourceAlias : Update a resource alias Use the resource alias URL-encoded CRN or GUID to update the resource alias. Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) UpdateResourceAliasWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) UpdateResourceAliasWithContext(ctx context.Context, updateResourceAliasOptions *UpdateResourceAliasOptions) (result *ResourceAlias, response *core.DetailedResponse, err error)

UpdateResourceAliasWithContext is an alternate form of the UpdateResourceAlias method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) UpdateResourceBinding

func (resourceController *ResourceControllerV2) UpdateResourceBinding(updateResourceBindingOptions *UpdateResourceBindingOptions) (result *ResourceBinding, response *core.DetailedResponse, err error)

UpdateResourceBinding : Update a resource binding Use the resource binding URL-encoded CRN or GUID to update the resource binding. Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) UpdateResourceBindingWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) UpdateResourceBindingWithContext(ctx context.Context, updateResourceBindingOptions *UpdateResourceBindingOptions) (result *ResourceBinding, response *core.DetailedResponse, err error)

UpdateResourceBindingWithContext is an alternate form of the UpdateResourceBinding method which supports a Context parameter Deprecated: this method is deprecated and may be removed in a future release.

func (*ResourceControllerV2) UpdateResourceInstance

func (resourceController *ResourceControllerV2) UpdateResourceInstance(updateResourceInstanceOptions *UpdateResourceInstanceOptions) (result *ResourceInstance, response *core.DetailedResponse, err error)

UpdateResourceInstance : Update a resource instance Use the resource instance URL-encoded CRN or GUID to make updates to the resource instance, like changing the name or plan.

func (*ResourceControllerV2) UpdateResourceInstanceWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) UpdateResourceInstanceWithContext(ctx context.Context, updateResourceInstanceOptions *UpdateResourceInstanceOptions) (result *ResourceInstance, response *core.DetailedResponse, err error)

UpdateResourceInstanceWithContext is an alternate form of the UpdateResourceInstance method which supports a Context parameter

func (*ResourceControllerV2) UpdateResourceKey

func (resourceController *ResourceControllerV2) UpdateResourceKey(updateResourceKeyOptions *UpdateResourceKeyOptions) (result *ResourceKey, response *core.DetailedResponse, err error)

UpdateResourceKey : Update a resource key Use the resource key URL-encoded CRN or GUID to update the resource key.

func (*ResourceControllerV2) UpdateResourceKeyWithContext added in v0.12.2

func (resourceController *ResourceControllerV2) UpdateResourceKeyWithContext(ctx context.Context, updateResourceKeyOptions *UpdateResourceKeyOptions) (result *ResourceKey, response *core.DetailedResponse, err error)

UpdateResourceKeyWithContext is an alternate form of the UpdateResourceKey method which supports a Context parameter

type ResourceControllerV2Options

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

ResourceControllerV2Options : Service options

type ResourceInstance

type ResourceInstance struct {
	// The ID associated with the instance.
	ID *string `json:"id,omitempty"`

	// The GUID of the instance.
	GUID *string `json:"guid,omitempty"`

	// When you provision a new resource, a relative URL path is created identifying the location of the instance.
	URL *string `json:"url,omitempty"`

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

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

	// The date when the instance was deleted.
	DeletedAt *strfmt.DateTime `json:"deleted_at,omitempty"`

	// The subject who created the instance.
	CreatedBy *string `json:"created_by,omitempty"`

	// The subject who updated the instance.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// The subject who deleted the instance.
	DeletedBy *string `json:"deleted_by,omitempty"`

	// The date when the instance was scheduled for reclamation.
	ScheduledReclaimAt *strfmt.DateTime `json:"scheduled_reclaim_at,omitempty"`

	// The date when the instance under reclamation was restored.
	RestoredAt *strfmt.DateTime `json:"restored_at,omitempty"`

	// The subject who restored the instance back from reclamation.
	RestoredBy *string `json:"restored_by,omitempty"`

	// The subject who initiated the instance reclamation.
	ScheduledReclaimBy *string `json:"scheduled_reclaim_by,omitempty"`

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

	// The deployment location where the instance was provisioned.
	RegionID *string `json:"region_id,omitempty"`

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

	// The unique ID of the reseller channel where the instance was provisioned from.
	ResellerChannelID *string `json:"reseller_channel_id,omitempty"`

	// The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
	ResourcePlanID *string `json:"resource_plan_id,omitempty"`

	// The ID of the resource group.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

	// The CRN of the resource group.
	ResourceGroupCRN *string `json:"resource_group_crn,omitempty"`

	// The deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where
	// the instance is provisioned.
	TargetCRN *string `json:"target_crn,omitempty"`

	// Whether newly created resource key credentials can be retrieved by using get resource key or get a list of all of
	// the resource keys requests.
	OnetimeCredentials *bool `json:"onetime_credentials,omitempty"`

	// The current configuration parameters of the instance.
	Parameters map[string]interface{} `json:"parameters,omitempty"`

	// A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region
	// instance delete call.
	AllowCleanup *bool `json:"allow_cleanup,omitempty"`

	// The full Cloud Resource Name (CRN) associated with the instance. For more information about this format, see [Cloud
	// Resource Names](https://cloud.ibm.com/docs/overview?topic=overview-crn).
	CRN *string `json:"crn,omitempty"`

	// The current state of the instance. For example, if the instance is deleted, it will return removed.
	State *string `json:"state,omitempty"`

	// The type of the instance, for example, `service_instance`.
	Type *string `json:"type,omitempty"`

	// The sub-type of instance, for example, `cfaas`.
	SubType *string `json:"sub_type,omitempty"`

	// The unique ID of the offering. This value is provided by and stored in the global catalog.
	ResourceID *string `json:"resource_id,omitempty"`

	// The resource-broker-provided URL to access administrative features of the instance.
	DashboardURL *string `json:"dashboard_url,omitempty"`

	// The status of the last operation requested on the instance.
	LastOperation *ResourceInstanceLastOperation `json:"last_operation,omitempty"`

	// The relative path to the resource aliases for the instance.
	// Deprecated: this field is deprecated and may be removed in a future release.
	ResourceAliasesURL *string `json:"resource_aliases_url,omitempty"`

	// The relative path to the resource bindings for the instance.
	// Deprecated: this field is deprecated and may be removed in a future release.
	ResourceBindingsURL *string `json:"resource_bindings_url,omitempty"`

	// The relative path to the resource keys for the instance.
	ResourceKeysURL *string `json:"resource_keys_url,omitempty"`

	// The plan history of the instance.
	PlanHistory []PlanHistoryItem `json:"plan_history,omitempty"`

	// A boolean that dictates if the resource instance was migrated from a previous CF instance.
	Migrated *bool `json:"migrated,omitempty"`

	// Additional instance properties, contributed by the service and/or platform, are represented as key-value pairs.
	Extensions map[string]interface{} `json:"extensions,omitempty"`

	// The CRN of the resource that has control of the instance.
	ControlledBy *string `json:"controlled_by,omitempty"`

	// A boolean that dictates if the resource instance is locked or not.
	Locked *bool `json:"locked,omitempty"`
}

ResourceInstance : A resource instance.

type ResourceInstanceLastOperation added in v0.27.0

type ResourceInstanceLastOperation struct {
	// The last operation type of the resource instance.
	Type *string `json:"type" validate:"required"`

	// The last operation state of the resoure instance. This indicates if the resource's last operation is in progress,
	// succeeded or failed.
	State *string `json:"state" validate:"required"`

	// The last operation sub type of the resoure instance.
	SubType *string `json:"sub_type,omitempty"`

	// A boolean that indicates if the resource is provisioned asynchronously or not.
	Async *bool `json:"async" validate:"required"`

	// The description of the status of last operation.
	Description *string `json:"description" validate:"required"`

	// Optional string that states the reason code for the last operation state change.
	ReasonCode *string `json:"reason_code,omitempty"`

	// A field which indicates the time after which the instance's last operation is to be polled.
	PollAfter *float64 `json:"poll_after,omitempty"`

	// A boolean that indicates if the resource's last operation is cancelable or not.
	Cancelable *bool `json:"cancelable" validate:"required"`

	// A boolean that indicates if the resource broker's last operation can be polled or not.
	Poll *bool `json:"poll" validate:"required"`
	// contains filtered or unexported fields
}

ResourceInstanceLastOperation : The status of the last operation requested on the instance. This type supports additional properties of type interface{}.

func (*ResourceInstanceLastOperation) GetProperties added in v0.27.0

func (o *ResourceInstanceLastOperation) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of ResourceInstanceLastOperation.

func (*ResourceInstanceLastOperation) GetProperty added in v0.27.0

func (o *ResourceInstanceLastOperation) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of ResourceInstanceLastOperation.

func (*ResourceInstanceLastOperation) MarshalJSON added in v0.27.0

func (o *ResourceInstanceLastOperation) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of ResourceInstanceLastOperation

func (*ResourceInstanceLastOperation) SetProperties added in v0.27.0

func (o *ResourceInstanceLastOperation) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of ResourceInstanceLastOperation.

func (*ResourceInstanceLastOperation) SetProperty added in v0.27.0

func (o *ResourceInstanceLastOperation) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of ResourceInstanceLastOperation.

type ResourceInstancesList

type ResourceInstancesList struct {
	// The number of resource instances in `resources`.
	RowsCount *int64 `json:"rows_count" validate:"required"`

	// The URL for requesting the next page of results.
	NextURL *string `json:"next_url" validate:"required"`

	// A list of resource instances.
	Resources []ResourceInstance `json:"resources" validate:"required"`
}

ResourceInstancesList : A list of resource instances.

func (*ResourceInstancesList) GetNextStart added in v0.29.3

func (resp *ResourceInstancesList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type ResourceInstancesPager added in v0.29.3

type ResourceInstancesPager struct {
	// contains filtered or unexported fields
}

ResourceInstancesPager can be used to simplify the use of the "ListResourceInstances" method.

func (*ResourceInstancesPager) GetAll added in v0.29.3

func (pager *ResourceInstancesPager) GetAll() (allItems []ResourceInstance, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*ResourceInstancesPager) GetAllWithContext added in v0.29.3

func (pager *ResourceInstancesPager) GetAllWithContext(ctx context.Context) (allItems []ResourceInstance, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*ResourceInstancesPager) GetNext added in v0.29.3

func (pager *ResourceInstancesPager) GetNext() (page []ResourceInstance, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*ResourceInstancesPager) GetNextWithContext added in v0.29.3

func (pager *ResourceInstancesPager) GetNextWithContext(ctx context.Context) (page []ResourceInstance, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*ResourceInstancesPager) HasNext added in v0.29.3

func (pager *ResourceInstancesPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type ResourceKey

type ResourceKey struct {
	// The ID associated with the key.
	ID *string `json:"id,omitempty"`

	// The GUID of the key.
	GUID *string `json:"guid,omitempty"`

	// When you created a new key, a relative URL path is created identifying the location of the key.
	URL *string `json:"url,omitempty"`

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

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

	// The date when the key was deleted.
	DeletedAt *strfmt.DateTime `json:"deleted_at,omitempty"`

	// The subject who created the key.
	CreatedBy *string `json:"created_by,omitempty"`

	// The subject who updated the key.
	UpdatedBy *string `json:"updated_by,omitempty"`

	// The subject who deleted the key.
	DeletedBy *string `json:"deleted_by,omitempty"`

	// The CRN of resource instance or alias associated to the key.
	SourceCRN *string `json:"source_crn,omitempty"`

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

	// The full Cloud Resource Name (CRN) associated with the key. For more information about this format, see [Cloud
	// Resource Names](https://cloud.ibm.com/docs/overview?topic=overview-crn).
	CRN *string `json:"crn,omitempty"`

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

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

	// The ID of the resource group.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

	// The unique ID of the offering. This value is provided by and stored in the global catalog.
	ResourceID *string `json:"resource_id,omitempty"`

	// Whether newly created resource key credentials can be retrieved by using get resource key or get a list of all of
	// the resource keys requests.
	OnetimeCredentials *bool `json:"onetime_credentials,omitempty"`

	// The credentials for the key. Additional key-value pairs are passed through from the resource brokers. After a
	// credential is created for a service, it can be viewed at any time for users that need the API key value. However,
	// all users must have the correct level of access to see the details of a credential that includes the API key value.
	// For additional details, see [viewing a
	// credential](https://cloud.ibm.com/docs/account?topic=account-service_credentials&interface=ui#viewing-credentials-ui)
	// or the service’s documentation.
	Credentials *Credentials `json:"credentials,omitempty"`

	// Specifies whether the key’s credentials support IAM.
	IamCompatible *bool `json:"iam_compatible,omitempty"`

	// A boolean that dictates if the alias was migrated from a previous CF instance.
	Migrated *bool `json:"migrated,omitempty"`

	// The relative path to the resource.
	ResourceInstanceURL *string `json:"resource_instance_url,omitempty"`

	// The relative path to the resource alias that this binding is associated with.
	ResourceAliasURL *string `json:"resource_alias_url,omitempty"`
}

ResourceKey : A resource key.

type ResourceKeyPostParameters

type ResourceKeyPostParameters struct {
	// An optional platform defined option to reuse an existing IAM serviceId for the role assignment.
	ServiceidCRN *string `json:"serviceid_crn,omitempty"`
	// contains filtered or unexported fields
}

ResourceKeyPostParameters : Configuration options represented as key-value pairs. Service defined options are passed through to the target resource brokers, whereas platform defined options are not. This type supports additional properties of type interface{}.

func (*ResourceKeyPostParameters) GetProperties added in v0.17.16

func (o *ResourceKeyPostParameters) GetProperties() map[string]interface{}

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of ResourceKeyPostParameters.

func (*ResourceKeyPostParameters) GetProperty added in v0.17.16

func (o *ResourceKeyPostParameters) GetProperty(key string) interface{}

GetProperty allows the user to retrieve an arbitrary property from an instance of ResourceKeyPostParameters.

func (*ResourceKeyPostParameters) MarshalJSON added in v0.17.16

func (o *ResourceKeyPostParameters) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of ResourceKeyPostParameters

func (*ResourceKeyPostParameters) SetProperties added in v0.29.3

func (o *ResourceKeyPostParameters) SetProperties(m map[string]interface{})

SetProperties allows the user to set a map of arbitrary properties on an instance of ResourceKeyPostParameters.

func (*ResourceKeyPostParameters) SetProperty added in v0.17.16

func (o *ResourceKeyPostParameters) SetProperty(key string, value interface{})

SetProperty allows the user to set an arbitrary property on an instance of ResourceKeyPostParameters.

type ResourceKeysForInstancePager added in v0.29.3

type ResourceKeysForInstancePager struct {
	// contains filtered or unexported fields
}

ResourceKeysForInstancePager can be used to simplify the use of the "ListResourceKeysForInstance" method.

func (*ResourceKeysForInstancePager) GetAll added in v0.29.3

func (pager *ResourceKeysForInstancePager) GetAll() (allItems []ResourceKey, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*ResourceKeysForInstancePager) GetAllWithContext added in v0.29.3

func (pager *ResourceKeysForInstancePager) GetAllWithContext(ctx context.Context) (allItems []ResourceKey, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*ResourceKeysForInstancePager) GetNext added in v0.29.3

func (pager *ResourceKeysForInstancePager) GetNext() (page []ResourceKey, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*ResourceKeysForInstancePager) GetNextWithContext added in v0.29.3

func (pager *ResourceKeysForInstancePager) GetNextWithContext(ctx context.Context) (page []ResourceKey, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*ResourceKeysForInstancePager) HasNext added in v0.29.3

func (pager *ResourceKeysForInstancePager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type ResourceKeysList

type ResourceKeysList struct {
	// The number of resource keys in `resources`.
	RowsCount *int64 `json:"rows_count" validate:"required"`

	// The URL for requesting the next page of results.
	NextURL *string `json:"next_url" validate:"required"`

	// A list of resource keys.
	Resources []ResourceKey `json:"resources" validate:"required"`
}

ResourceKeysList : A list of resource keys.

func (*ResourceKeysList) GetNextStart added in v0.29.3

func (resp *ResourceKeysList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type ResourceKeysPager added in v0.29.3

type ResourceKeysPager struct {
	// contains filtered or unexported fields
}

ResourceKeysPager can be used to simplify the use of the "ListResourceKeys" method.

func (*ResourceKeysPager) GetAll added in v0.29.3

func (pager *ResourceKeysPager) GetAll() (allItems []ResourceKey, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*ResourceKeysPager) GetAllWithContext added in v0.29.3

func (pager *ResourceKeysPager) GetAllWithContext(ctx context.Context) (allItems []ResourceKey, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*ResourceKeysPager) GetNext added in v0.29.3

func (pager *ResourceKeysPager) GetNext() (page []ResourceKey, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*ResourceKeysPager) GetNextWithContext added in v0.29.3

func (pager *ResourceKeysPager) GetNextWithContext(ctx context.Context) (page []ResourceKey, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*ResourceKeysPager) HasNext added in v0.29.3

func (pager *ResourceKeysPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type RunReclamationActionOptions

type RunReclamationActionOptions struct {
	// The ID associated with the reclamation.
	ID *string `json:"id" validate:"required,ne="`

	// The reclamation action name. Specify `reclaim` to delete a resource, or `restore` to restore a resource.
	ActionName *string `json:"action_name" validate:"required,ne="`

	// The request initiator, if different from the request token.
	RequestBy *string `json:"request_by,omitempty"`

	// A comment to describe the action.
	Comment *string `json:"comment,omitempty"`

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

RunReclamationActionOptions : The RunReclamationAction options.

func (*RunReclamationActionOptions) SetActionName

func (_options *RunReclamationActionOptions) SetActionName(actionName string) *RunReclamationActionOptions

SetActionName : Allow user to set ActionName

func (*RunReclamationActionOptions) SetComment

func (_options *RunReclamationActionOptions) SetComment(comment string) *RunReclamationActionOptions

SetComment : Allow user to set Comment

func (*RunReclamationActionOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*RunReclamationActionOptions) SetID

SetID : Allow user to set ID

func (*RunReclamationActionOptions) SetRequestBy

func (_options *RunReclamationActionOptions) SetRequestBy(requestBy string) *RunReclamationActionOptions

SetRequestBy : Allow user to set RequestBy

type UnlockResourceInstanceOptions

type UnlockResourceInstanceOptions struct {
	// The resource instance URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

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

UnlockResourceInstanceOptions : The UnlockResourceInstance options.

func (*UnlockResourceInstanceOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*UnlockResourceInstanceOptions) SetID

SetID : Allow user to set ID

type UpdateResourceAliasOptions

type UpdateResourceAliasOptions struct {
	// The resource alias URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

	// The new name of the alias. Must be 180 characters or less and cannot include any special characters other than
	// `(space) - . _ :`.
	Name *string `json:"name" validate:"required"`

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

UpdateResourceAliasOptions : The UpdateResourceAlias options.

func (*UpdateResourceAliasOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateResourceAliasOptions) SetID

SetID : Allow user to set ID

func (*UpdateResourceAliasOptions) SetName

SetName : Allow user to set Name

type UpdateResourceBindingOptions

type UpdateResourceBindingOptions struct {
	// The resource binding URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

	// The new name of the binding. Must be 180 characters or less and cannot include any special characters other than
	// `(space) - . _ :`.
	Name *string `json:"name" validate:"required"`

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

UpdateResourceBindingOptions : The UpdateResourceBinding options.

func (*UpdateResourceBindingOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*UpdateResourceBindingOptions) SetID

SetID : Allow user to set ID

func (*UpdateResourceBindingOptions) SetName

SetName : Allow user to set Name

type UpdateResourceInstanceOptions

type UpdateResourceInstanceOptions struct {
	// The resource instance URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

	// The new name of the instance. Must be 180 characters or less and cannot include any special characters other than
	// `(space) - . _ :`.
	Name *string `json:"name,omitempty"`

	// The new configuration options for the instance. Set the `onetime_credentials` property to specify whether newly
	// created resource key credentials can be retrieved by using get resource key or get a list of all of the resource
	// keys requests.
	Parameters map[string]interface{} `json:"parameters,omitempty"`

	// The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.
	ResourcePlanID *string `json:"resource_plan_id,omitempty"`

	// A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region
	// instance delete call.
	AllowCleanup *bool `json:"allow_cleanup,omitempty"`

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

UpdateResourceInstanceOptions : The UpdateResourceInstance options.

func (*UpdateResourceInstanceOptions) SetAllowCleanup

func (_options *UpdateResourceInstanceOptions) SetAllowCleanup(allowCleanup bool) *UpdateResourceInstanceOptions

SetAllowCleanup : Allow user to set AllowCleanup

func (*UpdateResourceInstanceOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*UpdateResourceInstanceOptions) SetID

SetID : Allow user to set ID

func (*UpdateResourceInstanceOptions) SetName

SetName : Allow user to set Name

func (*UpdateResourceInstanceOptions) SetParameters

func (_options *UpdateResourceInstanceOptions) SetParameters(parameters map[string]interface{}) *UpdateResourceInstanceOptions

SetParameters : Allow user to set Parameters

func (*UpdateResourceInstanceOptions) SetResourcePlanID

func (_options *UpdateResourceInstanceOptions) SetResourcePlanID(resourcePlanID string) *UpdateResourceInstanceOptions

SetResourcePlanID : Allow user to set ResourcePlanID

type UpdateResourceKeyOptions

type UpdateResourceKeyOptions struct {
	// The resource key URL-encoded CRN or GUID.
	ID *string `json:"id" validate:"required,ne="`

	// The new name of the key. Must be 180 characters or less and cannot include any special characters other than
	// `(space) - . _ :`.
	Name *string `json:"name" validate:"required"`

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

UpdateResourceKeyOptions : The UpdateResourceKey options.

func (*UpdateResourceKeyOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateResourceKeyOptions) SetID

SetID : Allow user to set ID

func (*UpdateResourceKeyOptions) SetName

func (_options *UpdateResourceKeyOptions) SetName(name string) *UpdateResourceKeyOptions

SetName : Allow user to set Name

Jump to

Keyboard shortcuts

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