storageprovisioner

Documentation

Index

• Variables
• type Client
  • func NewClient(caller base.APICaller, options ...Option) (*Client, error)
  • func (st *Client) AttachmentLife(ctx context.Context, ids []params.MachineStorageId) ([]params.LifeResult, error)
  • func (st *Client) CreateVolumeAttachmentPlans(ctx context.Context, volumeAttachmentPlans []params.VolumeAttachmentPlan) ([]params.ErrorResult, error)
  • func (st *Client) EnsureDead(ctx context.Context, tags []names.Tag) ([]params.ErrorResult, error)
  • func (st *Client) FilesystemAttachmentParams(ctx context.Context, ids []params.MachineStorageId) ([]params.FilesystemAttachmentParamsResult, error)
  • func (st *Client) FilesystemAttachments(ctx context.Context, ids []params.MachineStorageId) ([]params.FilesystemAttachmentResult, error)
  • func (st *Client) FilesystemParams(ctx context.Context, tags []names.FilesystemTag) ([]params.FilesystemParamsResult, error)
  • func (st *Client) Filesystems(ctx context.Context, tags []names.FilesystemTag) ([]params.FilesystemResult, error)
  • func (st *Client) InstanceIds(ctx context.Context, tags []names.MachineTag) ([]params.StringResult, error)
  • func (st *Client) Life(ctx context.Context, tags []names.Tag) ([]params.LifeResult, error)
  • func (st *Client) Remove(ctx context.Context, tags []names.Tag) ([]params.ErrorResult, error)
  • func (st *Client) RemoveAttachments(ctx context.Context, ids []params.MachineStorageId) ([]params.ErrorResult, error)
  • func (st *Client) RemoveFilesystemParams(ctx context.Context, tags []names.FilesystemTag) ([]params.RemoveFilesystemParamsResult, error)
  • func (st *Client) RemoveVolumeAttachmentPlan(ctx context.Context, ids []params.MachineStorageId) ([]params.ErrorResult, error)
  • func (st *Client) RemoveVolumeParams(ctx context.Context, tags []names.VolumeTag) ([]params.RemoveVolumeParamsResult, error)
  • func (st *Client) SetFilesystemAttachmentInfo(ctx context.Context, filesystemAttachments []params.FilesystemAttachment) ([]params.ErrorResult, error)
  • func (st *Client) SetFilesystemInfo(ctx context.Context, filesystems []params.Filesystem) ([]params.ErrorResult, error)
  • func (st *Client) SetStatus(ctx context.Context, args []params.EntityStatusArgs) error
  • func (st *Client) SetVolumeAttachmentInfo(ctx context.Context, volumeAttachments []params.VolumeAttachment) ([]params.ErrorResult, error)
  • func (st *Client) SetVolumeAttachmentPlanBlockInfo(ctx context.Context, volumeAttachmentPlans []params.VolumeAttachmentPlan) ([]params.ErrorResult, error)
  • func (st *Client) SetVolumeInfo(ctx context.Context, volumes []params.Volume) ([]params.ErrorResult, error)
  • func (st *Client) VolumeAttachmentParams(ctx context.Context, ids []params.MachineStorageId) ([]params.VolumeAttachmentParamsResult, error)
  • func (st *Client) VolumeAttachmentPlans(ctx context.Context, ids []params.MachineStorageId) ([]params.VolumeAttachmentPlanResult, error)
  • func (st *Client) VolumeAttachments(ctx context.Context, ids []params.MachineStorageId) ([]params.VolumeAttachmentResult, error)
  • func (st *Client) VolumeBlockDevices(ctx context.Context, ids []params.MachineStorageId) ([]params.BlockDeviceResult, error)
  • func (st *Client) VolumeParams(ctx context.Context, tags []names.VolumeTag) ([]params.VolumeParamsResult, error)
  • func (st *Client) Volumes(ctx context.Context, tags []names.VolumeTag) ([]params.VolumeResult, error)
  • func (st *Client) WatchApplications(ctx context.Context) (watcher.StringsWatcher, error)
  • func (st *Client) WatchBlockDevices(ctx context.Context, m names.MachineTag) (watcher.NotifyWatcher, error)
  • func (st *Client) WatchFilesystemAttachments(ctx context.Context, scope names.Tag) (watcher.MachineStorageIDsWatcher, error)
  • func (st *Client) WatchFilesystems(ctx context.Context, scope names.Tag) (watcher.StringsWatcher, error)
  • func (st *Client) WatchMachine(ctx context.Context, m names.MachineTag) (watcher.NotifyWatcher, error)
  • func (st *Client) WatchVolumeAttachmentPlans(ctx context.Context, scope names.Tag) (watcher.MachineStorageIDsWatcher, error)
  • func (st *Client) WatchVolumeAttachments(ctx context.Context, scope names.Tag) (watcher.MachineStorageIDsWatcher, error)
  • func (st *Client) WatchVolumes(ctx context.Context, scope names.Tag) (watcher.StringsWatcher, error)
• type Option

Variables

var WithTracer = base.WithTracer

WithTracer returns an Option that configures the Client to use the supplied tracer.

Types

type Client

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

Client provides access to a storageprovisioner facade client.

func NewClient

func NewClient(caller base.APICaller, options ...Option) (*Client, error)

NewClient creates a new client-side StorageProvisioner facade.

func (*Client) AttachmentLife

func (st *Client) AttachmentLife(ctx context.Context, ids []params.MachineStorageId) ([]params.LifeResult, error)

AttachmentLife requests the life cycle of the attachments with the specified IDs.

func (*Client) CreateVolumeAttachmentPlans

func (st *Client) CreateVolumeAttachmentPlans(ctx context.Context, volumeAttachmentPlans []params.VolumeAttachmentPlan) ([]params.ErrorResult, error)

func (*Client) EnsureDead

func (st *Client) EnsureDead(ctx context.Context, tags []names.Tag) ([]params.ErrorResult, error)

EnsureDead progresses the entities with the specified tags to the Dead life cycle state, if they are Alive or Dying.

func (*Client) FilesystemAttachmentParams

func (st *Client) FilesystemAttachmentParams(ctx context.Context, ids []params.MachineStorageId) ([]params.FilesystemAttachmentParamsResult, error)

FilesystemAttachmentParams returns the parameters for creating the filesystem attachments with the specified tags.

func (*Client) FilesystemAttachments

func (st *Client) FilesystemAttachments(ctx context.Context, ids []params.MachineStorageId) ([]params.FilesystemAttachmentResult, error)

FilesystemAttachments returns details of filesystem attachments with the specified IDs.

func (*Client) FilesystemParams

func (st *Client) FilesystemParams(ctx context.Context, tags []names.FilesystemTag) ([]params.FilesystemParamsResult, error)

FilesystemParams returns the parameters for creating the filesystems with the specified tags.

func (*Client) Filesystems

func (st *Client) Filesystems(ctx context.Context, tags []names.FilesystemTag) ([]params.FilesystemResult, error)

Filesystems returns details of filesystems with the specified tags.

func (*Client) InstanceIds

func (st *Client) InstanceIds(ctx context.Context, tags []names.MachineTag) ([]params.StringResult, error)

InstanceIds returns the provider specific instance ID for each machine, or an CodeNotProvisioned error if not set.

func (*Client) Life

func (st *Client) Life(ctx context.Context, tags []names.Tag) ([]params.LifeResult, error)

Life requests the life cycle of the entities with the specified tags.

func (*Client) Remove

func (st *Client) Remove(ctx context.Context, tags []names.Tag) ([]params.ErrorResult, error)

Remove removes the entities with the specified tags from state.

func (*Client) RemoveAttachments

func (st *Client) RemoveAttachments(ctx context.Context, ids []params.MachineStorageId) ([]params.ErrorResult, error)

RemoveAttachments removes the attachments with the specified IDs from state.

func (*Client) RemoveFilesystemParams

func (st *Client) RemoveFilesystemParams(ctx context.Context, tags []names.FilesystemTag) ([]params.RemoveFilesystemParamsResult, error)

RemoveFilesystemParams returns the parameters for destroying or releasing the filesystems with the specified tags.

func (*Client) RemoveVolumeAttachmentPlan

func (st *Client) RemoveVolumeAttachmentPlan(ctx context.Context, ids []params.MachineStorageId) ([]params.ErrorResult, error)

func (*Client) RemoveVolumeParams

func (st *Client) RemoveVolumeParams(ctx context.Context, tags []names.VolumeTag) ([]params.RemoveVolumeParamsResult, error)

RemoveVolumeParams returns the parameters for destroying or releasing the volumes with the specified tags.

func (*Client) SetFilesystemAttachmentInfo

func (st *Client) SetFilesystemAttachmentInfo(ctx context.Context, filesystemAttachments []params.FilesystemAttachment) ([]params.ErrorResult, error)

SetFilesystemAttachmentInfo records the details of newly provisioned filesystem attachments.

func (*Client) SetFilesystemInfo

func (st *Client) SetFilesystemInfo(ctx context.Context, filesystems []params.Filesystem) ([]params.ErrorResult, error)

SetFilesystemInfo records the details of newly provisioned filesystems.

func (*Client) SetStatus

func (st *Client) SetStatus(ctx context.Context, args []params.EntityStatusArgs) error

SetStatus sets the status of storage entities.

func (*Client) SetVolumeAttachmentInfo

func (st *Client) SetVolumeAttachmentInfo(ctx context.Context, volumeAttachments []params.VolumeAttachment) ([]params.ErrorResult, error)

SetVolumeAttachmentInfo records the details of newly provisioned volume attachments.

func (*Client) SetVolumeAttachmentPlanBlockInfo

func (st *Client) SetVolumeAttachmentPlanBlockInfo(ctx context.Context, volumeAttachmentPlans []params.VolumeAttachmentPlan) ([]params.ErrorResult, error)

func (*Client) SetVolumeInfo

func (st *Client) SetVolumeInfo(ctx context.Context, volumes []params.Volume) ([]params.ErrorResult, error)

SetVolumeInfo records the details of newly provisioned volumes.

func (*Client) VolumeAttachmentParams

func (st *Client) VolumeAttachmentParams(ctx context.Context, ids []params.MachineStorageId) ([]params.VolumeAttachmentParamsResult, error)

VolumeAttachmentParams returns the parameters for creating the volume attachments with the specified tags.

func (*Client) VolumeAttachmentPlans

func (st *Client) VolumeAttachmentPlans(ctx context.Context, ids []params.MachineStorageId) ([]params.VolumeAttachmentPlanResult, error)

func (*Client) VolumeAttachments

func (st *Client) VolumeAttachments(ctx context.Context, ids []params.MachineStorageId) ([]params.VolumeAttachmentResult, error)

VolumeAttachments returns details of volume attachments with the specified IDs.

func (*Client) VolumeBlockDevices

func (st *Client) VolumeBlockDevices(ctx context.Context, ids []params.MachineStorageId) ([]params.BlockDeviceResult, error)

VolumeBlockDevices returns details of block devices corresponding to the volume attachments with the specified IDs.

func (*Client) VolumeParams

func (st *Client) VolumeParams(ctx context.Context, tags []names.VolumeTag) ([]params.VolumeParamsResult, error)

VolumeParams returns the parameters for creating the volumes with the specified tags.

func (*Client) Volumes

func (st *Client) Volumes(ctx context.Context, tags []names.VolumeTag) ([]params.VolumeResult, error)

Volumes returns details of volumes with the specified tags.

func (*Client) WatchApplications

func (st *Client) WatchApplications(ctx context.Context) (watcher.StringsWatcher, error)

WatchApplications returns a StringsWatcher that notifies of changes to the lifecycles of CAAS applications in the current model.

func (*Client) WatchBlockDevices

func (st *Client) WatchBlockDevices(ctx context.Context, m names.MachineTag) (watcher.NotifyWatcher, error)

WatchBlockDevices watches for changes to the specified machine's block devices.

func (*Client) WatchFilesystemAttachments

func (st *Client) WatchFilesystemAttachments(ctx context.Context, scope names.Tag) (watcher.MachineStorageIDsWatcher, error)

WatchFilesystemAttachments watches for changes to filesystem attachments scoped to the entity with the specified tag.

func (*Client) WatchFilesystems

func (st *Client) WatchFilesystems(ctx context.Context, scope names.Tag) (watcher.StringsWatcher, error)

WatchFilesystems watches for lifecycle changes to volumes scoped to the entity with the specified tag.

func (*Client) WatchMachine

func (st *Client) WatchMachine(ctx context.Context, m names.MachineTag) (watcher.NotifyWatcher, error)

WatchMachine watches for changes to the specified machine.

func (*Client) WatchVolumeAttachmentPlans

func (st *Client) WatchVolumeAttachmentPlans(ctx context.Context, scope names.Tag) (watcher.MachineStorageIDsWatcher, error)

WatchVolumeAttachmentPlans watches for changes to volume attachments scoped to the entity with the tag passed to NewClient.

func (*Client) WatchVolumeAttachments

func (st *Client) WatchVolumeAttachments(ctx context.Context, scope names.Tag) (watcher.MachineStorageIDsWatcher, error)

WatchVolumeAttachments watches for changes to volume attachments scoped to the entity with the specified tag.

func (*Client) WatchVolumes

func (st *Client) WatchVolumes(ctx context.Context, scope names.Tag) (watcher.StringsWatcher, error)

WatchVolumes watches for lifecycle changes to volumes scoped to the entity with the specified tag.

type Option

type Option = base.Option

Option is a function that can be used to configure a Client.