esremoteclustersapi

Documentation

Index

• func Get(params GetParams) (*models.RemoteResources, error)
• func Update(params UpdateParams) error
• type GetParams
  • func (params GetParams) Validate() error
• type UpdateParams
  • func (params UpdateParams) Validate() error

Functions

func Get

func Get(params GetParams) (*models.RemoteResources, error)

Get returns a response with the number of remote deployments.

func Update

func Update(params UpdateParams) error

Update returns a response with the number of remote deployments.

Types

type GetParams

type GetParams struct {
	// Required API instance
	*api.API

	// Required source deployment ID
	DeploymentID string

	// Optional source ref_id. When not specified, an API call will be issued
	// to auto-discover the resource's RefID.
	RefID string
}

GetParams is consumed by Get.

func (GetParams) Validate

func (params GetParams) Validate() error

Validate ensures the parameters are usable by the consuming function.

type UpdateParams

type UpdateParams struct {
	// Required API instance
	*api.API

	// Required source deployment ID
	DeploymentID string

	// Optional source ref_id. When not specified, an API call will be issued
	// to auto-discover the resource's RefID.
	RefID string

	// Required remote resources
	RemoteResources *models.RemoteResources
}

UpdateParams is consumed by Update.

func (UpdateParams) Validate

func (params UpdateParams) Validate() error

Validate ensures the parameters are usable by the consuming function.