dnssvcsinstancesv2

package
v0.0.7 Latest Latest
Warning

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

Go to latest
Published: Aug 24, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package dnssvcsinstancesv2 : Operations and models for the DnsSvcsInstancesV2 service

Index

Constants

View Source
const DefaultServiceName = "dns_svcs_instances"

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

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

DefaultServiceURL is the default URL to make service requests to.

View Source
const (
	ListResourceInstancesOptions_Type_ServiceInstance = "service_instance"
)

Constants associated with the ListResourceInstancesOptions.Type property. The type of the instance. For example, `service_instance`.

Variables

This section is empty.

Functions

This section is empty.

Types

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

	// 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) 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 DeleteResourceInstanceOptions

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

	// 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

type DnsSvcsInstancesV2

type DnsSvcsInstancesV2 struct {
	Service *core.BaseService
}

DnsSvcsInstancesV2 : Manage lifecycle of PDNS resource instance using Resource Controller APIs.

Version: 2.0

func NewDnsSvcsInstancesV2

func NewDnsSvcsInstancesV2(options *DnsSvcsInstancesV2Options) (service *DnsSvcsInstancesV2, err error)

NewDnsSvcsInstancesV2 : constructs an instance of DnsSvcsInstancesV2 with passed in options.

func NewDnsSvcsInstancesV2UsingExternalConfig

func NewDnsSvcsInstancesV2UsingExternalConfig(options *DnsSvcsInstancesV2Options) (dnsSvcsInstances *DnsSvcsInstancesV2, err error)

NewDnsSvcsInstancesV2UsingExternalConfig : constructs an instance of DnsSvcsInstancesV2 with passed in options and external configuration.

func (*DnsSvcsInstancesV2) CreateResourceInstance

func (dnsSvcsInstances *DnsSvcsInstancesV2) 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 (*DnsSvcsInstancesV2) DeleteResourceInstance

func (dnsSvcsInstances *DnsSvcsInstancesV2) DeleteResourceInstance(deleteResourceInstanceOptions *DeleteResourceInstanceOptions) (response *core.DetailedResponse, err error)

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

func (*DnsSvcsInstancesV2) GetResourceInstance

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

GetResourceInstance : Get a resource instance Retrieve a resource instance by ID.

func (*DnsSvcsInstancesV2) ListResourceInstances

func (dnsSvcsInstances *DnsSvcsInstancesV2) 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 (*DnsSvcsInstancesV2) NewCreateResourceInstanceOptions

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

NewCreateResourceInstanceOptions : Instantiate CreateResourceInstanceOptions

func (*DnsSvcsInstancesV2) NewDeleteResourceInstanceOptions

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

NewDeleteResourceInstanceOptions : Instantiate DeleteResourceInstanceOptions

func (*DnsSvcsInstancesV2) NewGetResourceInstanceOptions

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

NewGetResourceInstanceOptions : Instantiate GetResourceInstanceOptions

func (*DnsSvcsInstancesV2) NewListResourceInstancesOptions

func (*DnsSvcsInstancesV2) NewListResourceInstancesOptions(resourceID string, typeVar string) *ListResourceInstancesOptions

NewListResourceInstancesOptions : Instantiate ListResourceInstancesOptions

func (*DnsSvcsInstancesV2) NewUpdateResourceInstanceOptions

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

NewUpdateResourceInstanceOptions : Instantiate UpdateResourceInstanceOptions

func (*DnsSvcsInstancesV2) SetServiceURL

func (dnsSvcsInstances *DnsSvcsInstancesV2) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*DnsSvcsInstancesV2) UpdateResourceInstance

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

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

type DnsSvcsInstancesV2Options

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

DnsSvcsInstancesV2Options : Service options

type GetResourceInstanceOptions

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

	// 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 ListResourceInstancesOptions

type ListResourceInstancesOptions struct {
	// The unique ID of the offering. This value is provided by and stored in the global catalog.
	ResourceID *string `json:"resource_id" validate:"required"`

	// The type of the instance. For example, `service_instance`.
	Type *string `json:"type" validate:"required"`

	// 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 plan associated with the offering. This value is provided by and stored in the global catalog.
	ResourcePlanID *string `json:"resource_plan_id,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

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

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

func UnmarshalPlanHistoryItem

func UnmarshalPlanHistoryItem(m map[string]interface{}) (result *PlanHistoryItem, err error)

UnmarshalPlanHistoryItem constructs an instance of PlanHistoryItem from the specified map.

func UnmarshalPlanHistoryItemSlice

func UnmarshalPlanHistoryItemSlice(s []interface{}) (slice []PlanHistoryItem, err error)

UnmarshalPlanHistoryItemSlice unmarshals a slice of PlanHistoryItem instances from the specified list of maps.

func UnmarshalPlanHistoryItemSliceAsProperty

func UnmarshalPlanHistoryItemSliceAsProperty(m map[string]interface{}, propertyName string) (slice []PlanHistoryItem, err error)

UnmarshalPlanHistoryItemSliceAsProperty unmarshals a slice of PlanHistoryItem instances that are stored as a property within the specified map.

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

	// The location of cloud geography/region/zone/data center that the resource resides in
	RegionID *string `json:"region_id,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 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"`

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

	// A boolean that dictates if the resource instance is going to be migrated
	Migrated *bool `json:"migrated,omitempty"`
}

ResourceInstance : A resource instance.

func UnmarshalResourceInstance

func UnmarshalResourceInstance(m map[string]interface{}) (result *ResourceInstance, err error)

UnmarshalResourceInstance constructs an instance of ResourceInstance from the specified map.

func UnmarshalResourceInstanceSlice

func UnmarshalResourceInstanceSlice(s []interface{}) (slice []ResourceInstance, err error)

UnmarshalResourceInstanceSlice unmarshals a slice of ResourceInstance instances from the specified list of maps.

func UnmarshalResourceInstanceSliceAsProperty

func UnmarshalResourceInstanceSliceAsProperty(m map[string]interface{}, propertyName string) (slice []ResourceInstance, err error)

UnmarshalResourceInstanceSliceAsProperty unmarshals a slice of ResourceInstance instances that are stored as a property within the specified map.

type ResourceInstancesList

type ResourceInstancesList struct {
	// The URL for requesting the next page of results.
	NextURL *string `json:"next_url,omitempty"`

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

func UnmarshalResourceInstancesList

func UnmarshalResourceInstancesList(m map[string]interface{}) (result *ResourceInstancesList, err error)

UnmarshalResourceInstancesList constructs an instance of ResourceInstancesList from the specified map.

type UpdateResourceInstanceOptions

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

	// 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

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

Jump to

Keyboard shortcuts

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