instanceconfigapi

Documentation

Index

• func Create(params CreateParams) (*models.VersionedIDResponse, error)
• func Delete(params DeleteParams) error
• func Get(params GetParams) (*models.InstanceConfiguration, error)
• func List(params ListParams) ([]*models.InstanceConfiguration, error)
• func NewConfig(source io.Reader) (*models.InstanceConfiguration, error)
• func PullToDirectory(params PullToDirectoryParams) error
• func Update(params UpdateParams) error
• type CreateParams
  • func (params CreateParams) Validate() error
• type DeleteParams
  • func (params DeleteParams) Validate() error
• type GetParams
  • func (params GetParams) Validate() error
• type ListParams
  • func (params ListParams) Validate() error
• type PullToDirectoryParams
  • func (params PullToDirectoryParams) Validate() error
• type UpdateParams
  • func (params UpdateParams) Validate() error

Functions

func Create

func Create(params CreateParams) (*models.VersionedIDResponse, error)

Create creates a new instance configuration.

func Delete

func Delete(params DeleteParams) error

Delete deletes an already existing instance configuration.

func Get

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

Get obtains an instance configuration from an ID

func List

func List(params ListParams) ([]*models.InstanceConfiguration, error)

List returns an array of all instance configurations

func NewConfig

func NewConfig(source io.Reader) (*models.InstanceConfiguration, error)

NewConfig creates a new InstanceConfiguration from an io.Reader containing a JSON payload.

func PullToDirectory

func PullToDirectory(params PullToDirectoryParams) error

PullToDirectory downloads instance configs and save them in a local folder

func Update

func Update(params UpdateParams) error

Update overwrites an already existing instance configuration.

Types

type CreateParams

type CreateParams struct {
	*api.API
	Config *models.InstanceConfiguration
	Region string
}

CreateParams is used to create a new instance configuration.

func (CreateParams) Validate

func (params CreateParams) Validate() error

Validate ensures that the parameters are correct.

type DeleteParams

type DeleteParams struct {
	*api.API
	ID     string
	Region string
}

DeleteParams is used to delete an instance configuration from its ID.

func (DeleteParams) Validate

func (params DeleteParams) Validate() error

Validate ensures that the parameters are correct.

type GetParams

type GetParams struct {
	*api.API
	ID     string
	Region string
}

GetParams is used to obtain an instance configuration from an ID.

func (GetParams) Validate

func (params GetParams) Validate() error

Validate ensures that the parameters are correct.

type ListParams

type ListParams struct {
	*api.API
	Region string
}

ListParams is used to list all of the available instance configurations.

func (ListParams) Validate

func (params ListParams) Validate() error

Validate ensures that the parameters are correct.

type PullToDirectoryParams

type PullToDirectoryParams struct {
	*api.API
	Directory string
	Region    string
}

PullToDirectoryParams is used to store all available instance configurations in a local directory.

func (PullToDirectoryParams) Validate

func (params PullToDirectoryParams) Validate() error

Validate ensures that the parameters are correct.

type UpdateParams

type UpdateParams struct {
	*api.API
	ID     string
	Config *models.InstanceConfiguration
	Region string
}

UpdateParams is used to overwrite an existing instance configuration.

func (UpdateParams) Validate

func (params UpdateParams) Validate() error

Validate ensures that the parameters are correct.