resourcecontrollerv2

package
v0.15.0 Latest Latest
Warning

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

 Go to latest Published: Nov 30, 2020 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 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 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 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 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 short or long ID of resource instance.
	Source *string `json:"source" validate:"required"`

	// The CRN of target name(space) in a specific environment, e.g. 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 

func (options *CreateResourceAliasOptions) SetName(name string) *CreateResourceAliasOptions

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 short or long ID of resource alias.
	Source *string `json:"source" validate:"required"`

	// The CRN of application to bind to in a specific environment, e.g. 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 role name or it's CRN.
	Role *string `json:"role,omitempty"`

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

CreateResourceBindingOptions : The CreateResourceBinding options.

func (*CreateResourceBindingOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateResourceBindingOptions) SetName 

func (options *CreateResourceBindingOptions) SetName(name string) *CreateResourceBindingOptions

SetName : Allow user to set Name

func (*CreateResourceBindingOptions) SetParameters 

func (options *CreateResourceBindingOptions) SetParameters(parameters *ResourceBindingPostParameters) *CreateResourceBindingOptions

SetParameters : Allow user to set Parameters

func (*CreateResourceBindingOptions) SetRole 

func (options *CreateResourceBindingOptions) SetRole(role string) *CreateResourceBindingOptions

SetRole : Allow user to set Role

func (*CreateResourceBindingOptions) SetSource 

func (options *CreateResourceBindingOptions) SetSource(source string) *CreateResourceBindingOptions

SetSource : Allow user to set Source

func (*CreateResourceBindingOptions) SetTarget 

func (options *CreateResourceBindingOptions) SetTarget(target string) *CreateResourceBindingOptions

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"`

	// Short or long ID of 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.
	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 *string `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 string) *CreateResourceInstanceOptions

SetEntityLock : Allow user to set EntityLock

func (*CreateResourceInstanceOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateResourceInstanceOptions) SetName 

func (options *CreateResourceInstanceOptions) SetName(name string) *CreateResourceInstanceOptions

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 

func (options *CreateResourceInstanceOptions) SetTags(tags []string) *CreateResourceInstanceOptions

SetTags : Allow user to set Tags

func (*CreateResourceInstanceOptions) SetTarget 

func (options *CreateResourceInstanceOptions) SetTarget(target string) *CreateResourceInstanceOptions

SetTarget : Allow user to set Target

type CreateResourceKeyOptions 

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

	// The short or long 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 role name or it's CRN.
	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 {
	// 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.

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) SetProperty 

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

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

type DeleteResourceAliasOptions 

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

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

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 

func (options *DeleteResourceAliasOptions) SetID(id string) *DeleteResourceAliasOptions

SetID : Allow user to set ID

type DeleteResourceBindingOptions 

type DeleteResourceBindingOptions struct {
	// The short or long ID of the binding.
	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 

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

SetHeaders : Allow user to set Headers

func (*DeleteResourceBindingOptions) SetID 

func (options *DeleteResourceBindingOptions) SetID(id string) *DeleteResourceBindingOptions

SetID : Allow user to set ID

type DeleteResourceInstanceOptions 

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

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

DeleteResourceInstanceOptions : The DeleteResourceInstance options.

func (*DeleteResourceInstanceOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteResourceInstanceOptions) SetID 

func (options *DeleteResourceInstanceOptions) SetID(id string) *DeleteResourceInstanceOptions

SetID : Allow user to set ID

type DeleteResourceKeyOptions 

type DeleteResourceKeyOptions struct {
	// The short or long ID of the key.
	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 

func (options *DeleteResourceKeyOptions) SetID(id string) *DeleteResourceKeyOptions

SetID : Allow user to set ID

type GetResourceAliasOptions 

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

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

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 

func (options *GetResourceAliasOptions) SetID(id string) *GetResourceAliasOptions

SetID : Allow user to set ID

type GetResourceBindingOptions 

type GetResourceBindingOptions struct {
	// The short or long ID of the binding.
	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 

func (options *GetResourceBindingOptions) SetID(id string) *GetResourceBindingOptions

SetID : Allow user to set ID

type GetResourceInstanceOptions 

type GetResourceInstanceOptions struct {
	// The short or long ID of the instance.
	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 

func (options *GetResourceInstanceOptions) SetID(id string) *GetResourceInstanceOptions

SetID : Allow user to set ID

type GetResourceKeyOptions 

type GetResourceKeyOptions struct {
	// The short or long ID of the key.
	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 short ID of the resource instance.
	ResourceInstanceID *string `json:"resource_instance_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) SetResourceInstanceID 

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

SetResourceInstanceID : Allow user to set ResourceInstanceID

type ListResourceAliasesOptions 

type ListResourceAliasesOptions struct {
	// Short ID of the alias.
	Guid *string `json:"guid,omitempty"`

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

	// Resource instance short ID.
	ResourceInstanceID *string `json:"resource_instance_id,omitempty"`

	// Short ID of the instance in a specific targeted 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"`

	// Short ID of Resource group.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

	// Limit on how many items should be returned.
	Limit *string `json:"limit,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 

func (options *ListResourceAliasesOptions) SetGuid(guid string) *ListResourceAliasesOptions

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 string) *ListResourceAliasesOptions

SetLimit : Allow user to set Limit

func (*ListResourceAliasesOptions) SetName 

func (options *ListResourceAliasesOptions) SetName(name string) *ListResourceAliasesOptions

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) 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 ListResourceBindingsOptions 

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

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

	// Short 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"`

	// Short ID of the binding in the specific targeted environment, e.g. 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 *string `json:"limit,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 

func (options *ListResourceBindingsOptions) SetGuid(guid string) *ListResourceBindingsOptions

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 

func (options *ListResourceBindingsOptions) SetLimit(limit string) *ListResourceBindingsOptions

SetLimit : Allow user to set Limit

func (*ListResourceBindingsOptions) SetName 

func (options *ListResourceBindingsOptions) SetName(name string) *ListResourceBindingsOptions

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) 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 {
	// When you provision a new resource in the specified location for the selected plan, a GUID (globally unique
	// identifier) is created. This is a unique internal GUID managed by Resource controller that corresponds to the
	// instance.
	Guid *string `json:"guid,omitempty"`

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

	// Short ID of a 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, e.g. `cfaas`.
	SubType *string `json:"sub_type,omitempty"`

	// Limit on how many items should be returned.
	Limit *string `json:"limit,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 

func (options *ListResourceInstancesOptions) SetGuid(guid string) *ListResourceInstancesOptions

SetGuid : Allow user to set Guid

func (*ListResourceInstancesOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListResourceInstancesOptions) SetLimit 

func (options *ListResourceInstancesOptions) SetLimit(limit string) *ListResourceInstancesOptions

SetLimit : Allow user to set Limit

func (*ListResourceInstancesOptions) SetName 

func (options *ListResourceInstancesOptions) SetName(name string) *ListResourceInstancesOptions

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) SetSubType 

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

SetSubType : Allow user to set SubType

func (*ListResourceInstancesOptions) SetType 

func (options *ListResourceInstancesOptions) SetType(typeVar string) *ListResourceInstancesOptions

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 ListResourceKeysOptions 

type ListResourceKeysOptions struct {
	// When you create a new key, a GUID (globally unique identifier) is assigned. This is a unique internal GUID managed
	// by Resource controller that corresponds to the key.
	Guid *string `json:"guid,omitempty"`

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

	// The short 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 *string `json:"limit,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 

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 string) *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) 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 short or long ID of the instance.
	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 

func (options *LockResourceInstanceOptions) SetID(id string) *LockResourceInstanceOptions

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"`
}

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 short ID of the entity for the reclamation.
	EntityID *string `json:"entity_id,omitempty"`

	// The short 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 short ID of the resource instance.
	ResourceInstanceID *string `json:"resource_instance_id,omitempty"`

	// The short 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 short 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"`

	// When you create a new alias, a globally unique identifier (GUID) is assigned. This GUID is a unique internal
	// indentifier managed by the resource controller that corresponds to the alias.
	Guid *string `json:"guid,omitempty"`

	// The full Cloud Resource Name (CRN) associated with 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"`

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

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

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

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

	// The long ID (full CRN) of the resource group.
	ResourceGroupCrn *string `json:"resource_group_crn,omitempty"`

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

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

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

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

	// The relative path to the 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"`

	// 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"`
}

ResourceAlias : A resource alias.

type ResourceAliasesList 

type ResourceAliasesList struct {
	// 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"`

	// The number of resource aliases in `resources`.
	RowsCount *int64 `json:"rows_count" validate:"required"`
}

ResourceAliasesList : A list of resource aliases.

type ResourceBinding 

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

	// When you create a new binding, a globally unique identifier (GUID) is assigned. This GUID is a unique internal
	// identifier managed by the resource controller that corresponds to the binding.
	Guid *string `json:"guid,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"`

	// When you provision a new binding, a relative URL path is created identifying the location of the binding.
	URL *string `json:"url,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 short ID of the resource group.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

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

	// The CRN of target resource, e.g. application, in a specific environment.
	TargetCrn *string `json:"target_crn,omitempty"`

	// The role CRN.
	Role *string `json:"role,omitempty"`

	// The short ID of the binding in specific targeted environment, e.g. `service_binding_id` in a given IBM Cloud
	// environment.
	RegionBindingID *string `json:"region_binding_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.  For
	// additional details, see the service’s documentation.
	Credentials *Credentials `json:"credentials,omitempty"`

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

	// The relative path to the resource alias that this binding is associated with.
	ResourceAliasURL *string `json:"resource_alias_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"`
}

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"`
}

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.

type ResourceBindingsList 

type ResourceBindingsList struct {
	// 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"`

	// The number of resource bindings in `resources`.
	RowsCount *int64 `json:"rows_count" validate:"required"`
}

ResourceBindingsList : A list of resource bindings.

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.

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) 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.

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

func (*ResourceControllerV2) CreateResourceBinding 

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

CreateResourceBinding : Create a new resource binding Create a new resource binding.

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

func (*ResourceControllerV2) CreateResourceInstance 

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

CreateResourceInstance : Create (provision) a new resource instance Provision a new resource in the specified location for the selected plan.

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 Create a new resource key.

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 ID.

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

func (*ResourceControllerV2) DeleteResourceBinding 

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

DeleteResourceBinding : Delete a resource binding Delete a resource binding by ID.

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

func (*ResourceControllerV2) DeleteResourceInstance 

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

DeleteResourceInstance : Delete a resource instance Delete a resource instance by ID.

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 by ID Delete a resource key by ID.

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 Retrieve a resource alias by ID.

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

func (*ResourceControllerV2) GetResourceBinding 

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

GetResourceBinding : Get a resource binding Retrieve a resource binding by ID.

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

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 ID.

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 by ID Get resource key by ID.

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 Get a list of all reclamations.

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 Get a list of all resource aliases.

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

func (*ResourceControllerV2) ListResourceBindings 

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

ListResourceBindings : Get a list of all resource bindings Get a list of all resource bindings.

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

func (*ResourceControllerV2) ListResourceInstances 

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

ListResourceInstances : Get a list of all resource instances Get a list of all resource instances.

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 List all resource keys.

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 by ID. 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) 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) NewListResourceAliasesOptions 

func (*ResourceControllerV2) NewListResourceAliasesOptions() *ListResourceAliasesOptions

NewListResourceAliasesOptions : Instantiate ListResourceAliasesOptions

func (*ResourceControllerV2) NewListResourceBindingsOptions 

func (*ResourceControllerV2) NewListResourceBindingsOptions() *ListResourceBindingsOptions

NewListResourceBindingsOptions : Instantiate ListResourceBindingsOptions

func (*ResourceControllerV2) NewListResourceInstancesOptions 

func (*ResourceControllerV2) NewListResourceInstancesOptions() *ListResourceInstancesOptions

NewListResourceInstancesOptions : Instantiate ListResourceInstancesOptions

func (*ResourceControllerV2) NewListResourceKeysOptions 

func (*ResourceControllerV2) NewListResourceKeysOptions() *ListResourceKeysOptions

NewListResourceKeysOptions : Instantiate ListResourceKeysOptions

func (*ResourceControllerV2) NewLockResourceInstanceOptions 

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

NewLockResourceInstanceOptions : Instantiate LockResourceInstanceOptions

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 (provisionally delete) a resource so that it can no longer be used, or restore a resource 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 Unlocks a resource instance by ID.

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 Update a resource alias by ID.

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

func (*ResourceControllerV2) UpdateResourceBinding 

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

UpdateResourceBinding : Update a resource binding Update a resource binding by ID.

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

func (*ResourceControllerV2) UpdateResourceInstance 

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

UpdateResourceInstance : Update a resource instance Update a resource instance by ID.

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 Update a resource key by ID.

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"`

	// When you create a new resource, a globally unique identifier (GUID) is assigned. This GUID is a unique internal
	// identifier managed by the resource controller that corresponds to the instance.
	Guid *string `json:"guid,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"`

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

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

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

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

	// The long ID (full CRN) of the resource group.
	ResourceGroupCrn *string `json:"resource_group_crn,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 full 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"`

	// The current configuration parameters of the instance.
	Parameters map[string]interface{} `json:"parameters,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, e.g. `service_instance`.
	Type *string `json:"type,omitempty"`

	// The sub-type of instance, e.g. `cfaas`.
	SubType *string `json:"sub_type,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"`

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

	// The status of the last operation requested on the instance.
	LastOperation map[string]interface{} `json:"last_operation,omitempty"`

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

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

	// The relative path to the resource aliases for the instance.
	ResourceAliasesURL *string `json:"resource_aliases_url,omitempty"`

	// The relative path to the resource bindings for the instance.
	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 date when the instance was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

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

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

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

	// The date when the instance was deleted.
	DeletedAt *strfmt.DateTime `json:"deleted_at,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 subject who initiated the instance reclamation.
	ScheduledReclaimBy *string `json:"scheduled_reclaim_by,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"`
}

ResourceInstance : A resource instance.

type ResourceInstancesList 

type ResourceInstancesList struct {
	// 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"`

	// The number of resource instances in `resources`.
	RowsCount *int64 `json:"rows_count" validate:"required"`
}

ResourceInstancesList : A list of resource instances.

type ResourceKey 

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

	// When you create a new key, a globally unique identifier (GUID) is assigned. This GUID is a unique internal
	// identifier managed by the resource controller that corresponds to the key.
	Guid *string `json:"guid,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"`

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

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

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

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

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

	// The role CRN.
	Role *string `json:"role,omitempty"`

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

	// The credentials for the key. Additional key-value pairs are passed through from the resource brokers.  Refer to
	// service’s documentation for additional details.
	Credentials *Credentials `json:"credentials,omitempty"`

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

	// The relative path to the resource.
	ResourceInstanceURL *string `json:"resource_instance_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"`
}

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"`
}

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.

type ResourceKeysList 

type ResourceKeysList struct {
	// 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"`

	// The number of resource keys in `resources`.
	RowsCount *int64 `json:"rows_count" validate:"required"`
}

ResourceKeysList : A list of resource keys.

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 

func (options *RunReclamationActionOptions) SetID(id string) *RunReclamationActionOptions

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 short or long ID of the instance.
	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 

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

SetHeaders : Allow user to set Headers

func (*UnlockResourceInstanceOptions) SetID 

func (options *UnlockResourceInstanceOptions) SetID(id string) *UnlockResourceInstanceOptions

SetID : Allow user to set ID

type UpdateResourceAliasOptions 

type UpdateResourceAliasOptions struct {
	// The short or long ID of the alias.
	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 

func (options *UpdateResourceAliasOptions) SetID(id string) *UpdateResourceAliasOptions

SetID : Allow user to set ID

func (*UpdateResourceAliasOptions) SetName 

func (options *UpdateResourceAliasOptions) SetName(name string) *UpdateResourceAliasOptions

SetName : Allow user to set Name

type UpdateResourceBindingOptions 

type UpdateResourceBindingOptions struct {
	// The short or long ID of the binding.
	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 

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

SetHeaders : Allow user to set Headers

func (*UpdateResourceBindingOptions) SetID 

func (options *UpdateResourceBindingOptions) SetID(id string) *UpdateResourceBindingOptions

SetID : Allow user to set ID

func (*UpdateResourceBindingOptions) SetName 

func (options *UpdateResourceBindingOptions) SetName(name string) *UpdateResourceBindingOptions

SetName : Allow user to set Name

type UpdateResourceInstanceOptions 

type UpdateResourceInstanceOptions struct {
	// The short or long ID of the instance.
	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.
	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 

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

SetHeaders : Allow user to set Headers

func (*UpdateResourceInstanceOptions) SetID 

func (options *UpdateResourceInstanceOptions) SetID(id string) *UpdateResourceInstanceOptions

SetID : Allow user to set ID

func (*UpdateResourceInstanceOptions) SetName 

func (options *UpdateResourceInstanceOptions) SetName(name string) *UpdateResourceInstanceOptions

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 short or long ID of the key.
	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 

func (options *UpdateResourceKeyOptions) SetID(id string) *UpdateResourceKeyOptions

SetID : Allow user to set ID

func (*UpdateResourceKeyOptions) SetName 

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

SetName : Allow user to set Name

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.