volumes

type CreateOpts struct {
	// The availability zone [OPTIONAL]
	AvailabilityZone string
	// ConsistencyGroupID is the ID of a consistency group [OPTINAL]
	ConsistencyGroupID string
	// The volume description [OPTIONAL]
	Description string
	// One or more metadata key and value pairs to associate with the volume [OPTIONAL]
	Metadata map[string]string
	// The volume name [OPTIONAL]
	Name string
	// The size of the volume, in gibibytes (GiB) [REQUIRED]
	Size int
	// the ID of the existing volume snapshot [OPTIONAL]
	SnapshotID string
	// SourceReplica is a UUID of an existing volume to replicate with [OPTIONAL]
	SourceReplica string
	// the ID of the existing volume [OPTIONAL]
	SourceVolID string
	// The ID of the image from which you want to create the volume.
	// Required to create a bootable volume.
	ImageID string
	// The associated volume type [OPTIONAL]
	VolumeType string
}

type CreateOptsBuilder interface {
	ToVolumeCreateMap() (map[string]interface{}, error)
}

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

type DeleteResult struct {
	gophercloud.ErrResult
}

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

type ListOpts struct {
	// admin-only option. Set it to true to see all tenant volumes.
	AllTenants bool `q:"all_tenants"`
	// List only volumes that contain Metadata.
	Metadata map[string]string `q:"metadata"`
	// List only volumes that have Name as the display name.
	Name string `q:"name"`
	// List only volumes that have a status of Status.
	Status string `q:"status"`
}

type ListOptsBuilder interface {
	ToVolumeListQuery() (string, error)
}

type ListResult struct {
	pagination.SinglePageBase
}

type UpdateOpts struct {
	// OPTIONAL
	Name string
	// OPTIONAL
	Description string
	// OPTIONAL
	Metadata map[string]string
}

type UpdateOptsBuilder interface {
	ToVolumeUpdateMap() (map[string]interface{}, error)
}

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

type Volume struct {
	// Instances onto which the volume is attached.
	Attachments []map[string]interface{} `mapstructure:"attachments"`

	// AvailabilityZone is which availability zone the volume is in.
	AvailabilityZone string `mapstructure:"availability_zone"`

	// Indicates whether this is a bootable volume.
	Bootable string `mapstructure:"bootable"`

	// ConsistencyGroupID is the consistency group ID.
	ConsistencyGroupID string `mapstructure:"consistencygroup_id"`

	// The date when this volume was created.
	CreatedAt string `mapstructure:"created_at"`

	// Human-readable description for the volume.
	Description string `mapstructure:"description"`

	// Encrypted denotes if the volume is encrypted.
	Encrypted bool `mapstructure:"encrypted"`

	// Human-readable display name for the volume.
	Name string `mapstructure:"name"`

	// The type of volume to create, either SATA or SSD.
	VolumeType string `mapstructure:"volume_type"`

	// ReplicationDriverData contains data about the replication driver.
	ReplicationDriverData string `mapstructure:"os-volume-replication:driver_data"`

	// ReplicationExtendedStatus contains extended status about replication.
	ReplicationExtendedStatus string `mapstructure:"os-volume-replication:extended_status"`

	// ReplicationStatus is the status of replication.
	ReplicationStatus string `mapstructure:"replication_status"`

	// The ID of the snapshot from which the volume was created
	SnapshotID string `mapstructure:"snapshot_id"`

	// The ID of another block storage volume from which the current volume was created
	SourceVolID string `mapstructure:"source_volid"`

	// Current status of the volume.
	Status string `mapstructure:"status"`

	// TenantID is the id of the project that owns the volume.
	TenantID string `mapstructure:"os-vol-tenant-attr:tenant_id"`

	// Arbitrary key-value pairs defined by the user.
	Metadata map[string]string `mapstructure:"metadata"`

	// Multiattach denotes if the volume is multi-attach capable.
	Multiattach bool `mapstructure:"multiattach"`

	// Unique identifier for the volume.
	ID string `mapstructure:"id"`

	// Size of the volume in GB.
	Size int `mapstructure:"size"`

	// UserID is the id of the user who created the volume.
	UserID string `mapstructure:"user_id"`
}