Documentation
¶
Overview ¶
Code generated by sdkgen from Gophercloud v2.15.0; DO NOT EDIT.
Code generated by sdkgen from Gophercloud v2.15.0; DO NOT EDIT.
Index ¶
- Constants
- type API
- func (a *API) AbortVolumeDetaching(ctx context.Context, id string) (*VolumeActionResult, error)
- func (a *API) All(ctx context.Context, options ...resource.ListOption) ([]*Volume, error)
- func (a *API) Attach(ctx context.Context, id string, opts AttachOpts, options ...AttachOption) error
- func (a *API) AttachCinderVolume(ctx context.Context, id, mountpoint string, ...) (*VolumeActionResult, error)
- func (a *API) BeginDetaching(ctx context.Context, id string) error
- func (a *API) BeginVolumeDetaching(ctx context.Context, id string) (*VolumeActionResult, error)
- func (a *API) ChangeType(ctx context.Context, id string, opts ChangeTypeOpts, ...) error
- func (a *API) CompleteVolumeExtend(ctx context.Context, id string, options ...VolumeExtendCompletionOption) (*VolumeActionResult, error)
- func (a *API) CompleteVolumeMigration(ctx context.Context, id string, newVolume string, ...) (*VolumeActionResult, error)
- func (a *API) Create(ctx context.Context, opts CreateOpts, options ...CreateOption) (*Volume, error)
- func (a *API) Delete(ctx context.Context, id string, options ...DeleteOption) error
- func (a *API) DeleteVolumeImageMetadata(ctx context.Context, id string, options ...VolumeImageMetadataDeleteOption) (*VolumeImageMetadataDeleteResult, error)
- func (a *API) Detach(ctx context.Context, id string, opts DetachOpts, options ...DetachOption) error
- func (a *API) DetachCinderVolume(ctx context.Context, id, attachmentID string, ...) (*VolumeActionResult, error)
- func (a *API) ExtendSize(ctx context.Context, id string, opts ExtendSizeOpts, ...) error
- func (a *API) ExtendVolume(ctx context.Context, id string, newSize int) (*VolumeActionResult, error)
- func (a *API) Find(ctx context.Context, ref resource.Ref, options ...resource.LookupOption) (*Volume, error)
- func (a *API) FindIdentity(ctx context.Context, identity string, options ...resource.IdentityFindOption) (*Volume, error)
- func (a *API) ForceDelete(ctx context.Context, id string) error
- func (a *API) Get(ctx context.Context, id string) (*Volume, error)
- func (a *API) InitializeConnection(ctx context.Context, id string, opts InitializeConnectionOpts, ...) (map[string]any, error)
- func (a *API) List(ctx context.Context, options ...ListOption) iter.Seq2[*Volume, error]
- func (a *API) MetadataIn(ctx context.Context, ref resource.Ref) (*MetadataScope, error)
- func (a *API) MigrateVolume(ctx context.Context, id string, options ...VolumeMigrationOption) (*VolumeActionResult, error)
- func (a *API) RawClient() *gophercloud.ServiceClient
- func (a *API) ReImage(ctx context.Context, id string, opts ReImageOpts, options ...ReImageOption) error
- func (a *API) Remove(ctx context.Context, ref resource.Ref, options ...resource.LookupOption) error
- func (a *API) Reserve(ctx context.Context, id string) error
- func (a *API) ReserveVolume(ctx context.Context, id string) (*VolumeActionResult, error)
- func (a *API) ResetStatus(ctx context.Context, id string, opts ResetStatusOpts, ...) error
- func (a *API) ResetVolumeStatus(ctx context.Context, id string, options ...VolumeStatusResetOption) (*VolumeActionResult, error)
- func (a *API) RetypeVolume(ctx context.Context, id, newType string, options ...VolumeRetypeOption) (*VolumeActionResult, error)
- func (a *API) RevertVolumeToSnapshot(ctx context.Context, id, snapshotID string) (*VolumeActionResult, error)
- func (a *API) SetBootable(ctx context.Context, id string, opts BootableOpts, ...) error
- func (a *API) SetImageMetadata(ctx context.Context, id string, opts ImageMetadataOpts, ...) error
- func (a *API) SetVolumeBootableStatus(ctx context.Context, id string, bootable bool) (*VolumeActionResult, error)
- func (a *API) SetVolumeImageMetadata(ctx context.Context, id string, options ...VolumeImageMetadataOption) (*VolumeActionResult, error)
- func (a *API) SetVolumeReadonly(ctx context.Context, id string, options ...VolumeReadonlyOption) (*VolumeActionResult, error)
- func (a *API) TerminateConnection(ctx context.Context, id string, opts TerminateConnectionOpts, ...) error
- func (a *API) Unmanage(ctx context.Context, id string) error
- func (a *API) UnmanageVolume(ctx context.Context, id string) (*VolumeActionResult, error)
- func (a *API) Unreserve(ctx context.Context, id string) error
- func (a *API) UnreserveVolume(ctx context.Context, id string) (*VolumeActionResult, error)
- func (a *API) Update(ctx context.Context, id string, opts UpdateOpts, options ...UpdateOption) (*Volume, error)
- func (a *API) UploadImage(ctx context.Context, id string, opts UploadImageOpts, ...) (VolumeImage, error)
- func (a *API) UploadVolumeToImage(ctx context.Context, id, imageName string, options ...VolumeImageUploadOption) (*VolumeImageUploadResult, error)
- func (a *API) WaitFor(ctx context.Context, ref resource.Ref, status string, ...) (*Volume, error)
- func (a *API) WaitForAvailable(ctx context.Context, ref resource.Ref, options ...resource.WaitOption) (*Volume, error)
- func (a *API) WaitForDelete(ctx context.Context, ref resource.Ref, options ...resource.WaitOption) error
- func (a *API) WaitForDeletion(ctx context.Context, ref resource.Ref, options ...resource.WaitOption) error
- func (a *API) WaitForState(ctx context.Context, ref resource.Ref, target string, ...) (*Volume, error)
- func (a *API) WaitForStatus(ctx context.Context, id string, status string) error
- type AttachMode
- type AttachOption
- type AttachOpts
- type AttachResult
- type Attachment
- type BeginDetachingResult
- type BootableOpts
- type ChangeTypeOption
- type ChangeTypeOpts
- type ChangeTypeResult
- type CinderVolumeAttachOption
- type CinderVolumeAttachOpts
- type CinderVolumeDetachOption
- type CinderVolumeDetachOpts
- type CreateOption
- type CreateOpts
- type CreateResult
- type DeleteOption
- type DeleteOpts
- type DeleteResult
- type DetachOption
- type DetachOpts
- type DetachResult
- type ExtendSizeOption
- type ExtendSizeOpts
- type ExtendSizeResult
- type ForceDeleteResult
- type GetResult
- type ImageMetadataOpts
- type ImageVolumeType
- type InitializeConnectionOption
- type InitializeConnectionOpts
- type InitializeConnectionResult
- type ListOption
- type ListOpts
- type MetadataDeleteResult
- type MetadataOption
- type MetadataResult
- type MetadataScope
- func (s *MetadataScope) DeleteKeys(ctx context.Context, keys []string, options ...MetadataOption) (*MetadataDeleteResult, error)
- func (s *MetadataScope) Get(ctx context.Context, options ...MetadataOption) (*MetadataResult, error)
- func (s *MetadataScope) ID() string
- func (s *MetadataScope) Merge(ctx context.Context, values map[string]string, options ...MetadataOption) (*MetadataResult, error)
- func (s *MetadataScope) RawClient() *gophercloud.ServiceClient
- func (s *MetadataScope) Replace(ctx context.Context, values map[string]string, options ...MetadataOption) (*MetadataResult, error)
- type MigrationPolicy
- type ReImageOption
- type ReImageOpts
- type ReImageResult
- type ReserveResult
- type ResetStatusOption
- type ResetStatusOpts
- type ResetStatusResult
- type SchedulerHintOpts
- type SetBootableOption
- type SetBootableResult
- type SetImageMetadataOption
- type SetImageMetadataResult
- type TerminateConnectionOption
- type TerminateConnectionOpts
- type TerminateConnectionResult
- type UnmanageResult
- type UnreserveResult
- type UpdateOption
- type UpdateOpts
- type UpdateResult
- type UploadImageOption
- type UploadImageOpts
- type UploadImageResult
- type Volume
- type VolumeActionResult
- type VolumeExtendCompletionOption
- type VolumeExtendCompletionOpts
- type VolumeImage
- type VolumeImageMetadataDeleteOption
- type VolumeImageMetadataDeleteOpts
- type VolumeImageMetadataDeleteResult
- type VolumeImageMetadataDeletion
- type VolumeImageMetadataOption
- func WithVolumeImageMetadata(value map[string]string) VolumeImageMetadataOption
- func WithVolumeImageMetadataOptions(value VolumeImageMetadataOpts) VolumeImageMetadataOption
- func WithVolumeImageMetadataRaw(value map[string]json.RawMessage) VolumeImageMetadataOption
- func WithVolumeImageMetadataValue(key, value string) VolumeImageMetadataOption
- type VolumeImageMetadataOpts
- type VolumeImageMetadataResponse
- type VolumeImageUploadOption
- func WithVolumeImageUploadContainerFormat(value string) VolumeImageUploadOption
- func WithVolumeImageUploadDiskFormat(value string) VolumeImageUploadOption
- func WithVolumeImageUploadForce(value bool) VolumeImageUploadOption
- func WithVolumeImageUploadOptions(value VolumeImageUploadOpts) VolumeImageUploadOption
- func WithVolumeImageUploadProtected(value bool) VolumeImageUploadOption
- func WithVolumeImageUploadVisibility(value string) VolumeImageUploadOption
- type VolumeImageUploadOpts
- type VolumeImageUploadResponse
- type VolumeImageUploadResult
- type VolumeMigrationCompletionOption
- type VolumeMigrationCompletionOpts
- type VolumeMigrationOption
- func WithVolumeMigrationCluster(value string) VolumeMigrationOption
- func WithVolumeMigrationForceHostCopy(value bool) VolumeMigrationOption
- func WithVolumeMigrationHost(value string) VolumeMigrationOption
- func WithVolumeMigrationLockVolume(value bool) VolumeMigrationOption
- func WithVolumeMigrationOptions(value VolumeMigrationOpts) VolumeMigrationOption
- type VolumeMigrationOpts
- type VolumePage
- type VolumeReadonlyOption
- type VolumeReadonlyOpts
- type VolumeRetypeOption
- type VolumeRetypeOpts
- type VolumeStatusResetOption
- func WithVolumeStatusResetAttachStatus(value string) VolumeStatusResetOption
- func WithVolumeStatusResetMigrationStatus(value string) VolumeStatusResetOption
- func WithVolumeStatusResetOptions(value VolumeStatusResetOpts) VolumeStatusResetOption
- func WithVolumeStatusResetStatus(value string) VolumeStatusResetOption
- type VolumeStatusResetOpts
Constants ¶
const MigrationPolicyNever = upstream.MigrationPolicyNever
const MigrationPolicyOnDemand = upstream.MigrationPolicyOnDemand
const ReadOnly = upstream.ReadOnly
const ReadWrite = upstream.ReadWrite
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct {
Resources *resource.Collection[Volume]
// contains filtered or unexported fields
}
API owns typed operations and their shared resource policies.
func New ¶
func New(client *gophercloud.ServiceClient) *API
func (*API) AbortVolumeDetaching ¶
func (*API) Attach ¶
func (a *API) Attach(ctx context.Context, id string, opts AttachOpts, options ...AttachOption) error
Attach invokes the upstream API with library-owned builders and result handling.
func (*API) AttachCinderVolume ¶
func (a *API) AttachCinderVolume(ctx context.Context, id, mountpoint string, options ...CinderVolumeAttachOption) (*VolumeActionResult, error)
func (*API) BeginDetaching ¶
BeginDetaching invokes the upstream API with library-owned builders and result handling.
func (*API) BeginVolumeDetaching ¶
func (*API) ChangeType ¶
func (a *API) ChangeType(ctx context.Context, id string, opts ChangeTypeOpts, options ...ChangeTypeOption) error
ChangeType invokes the upstream API with library-owned builders and result handling.
func (*API) CompleteVolumeExtend ¶
func (a *API) CompleteVolumeExtend(ctx context.Context, id string, options ...VolumeExtendCompletionOption) (*VolumeActionResult, error)
func (*API) CompleteVolumeMigration ¶
func (a *API) CompleteVolumeMigration(ctx context.Context, id string, newVolume string, options ...VolumeMigrationCompletionOption) (*VolumeActionResult, error)
func (*API) Create ¶
func (a *API) Create(ctx context.Context, opts CreateOpts, options ...CreateOption) (*Volume, error)
Create invokes the upstream API with library-owned builders and result handling.
func (*API) Delete ¶
Delete invokes the upstream API with library-owned builders and result handling.
func (*API) DeleteVolumeImageMetadata ¶
func (a *API) DeleteVolumeImageMetadata(ctx context.Context, id string, options ...VolumeImageMetadataDeleteOption) (*VolumeImageMetadataDeleteResult, error)
func (*API) Detach ¶
func (a *API) Detach(ctx context.Context, id string, opts DetachOpts, options ...DetachOption) error
Detach invokes the upstream API with library-owned builders and result handling.
func (*API) DetachCinderVolume ¶
func (a *API) DetachCinderVolume(ctx context.Context, id, attachmentID string, options ...CinderVolumeDetachOption) (*VolumeActionResult, error)
func (*API) ExtendSize ¶
func (a *API) ExtendSize(ctx context.Context, id string, opts ExtendSizeOpts, options ...ExtendSizeOption) error
ExtendSize invokes the upstream API with library-owned builders and result handling.
func (*API) ExtendVolume ¶
func (*API) FindIdentity ¶
func (a *API) FindIdentity(ctx context.Context, identity string, options ...resource.IdentityFindOption) (*Volume, error)
FindIdentity tries an ID request before exact ID/name fallback within this collection.
func (*API) ForceDelete ¶
ForceDelete invokes the upstream API with library-owned builders and result handling.
func (*API) InitializeConnection ¶
func (a *API) InitializeConnection(ctx context.Context, id string, opts InitializeConnectionOpts, options ...InitializeConnectionOption) (map[string]any, error)
InitializeConnection invokes the upstream API with library-owned builders and result handling.
func (*API) MetadataIn ¶
MetadataIn uses explicit IDs without HTTP. An explicit Name is resolved once through the existing collection's exact lookup and duplicate-name policy.
func (*API) MigrateVolume ¶
func (a *API) MigrateVolume(ctx context.Context, id string, options ...VolumeMigrationOption) (*VolumeActionResult, error)
func (*API) RawClient ¶
func (a *API) RawClient() *gophercloud.ServiceClient
func (*API) ReImage ¶
func (a *API) ReImage(ctx context.Context, id string, opts ReImageOpts, options ...ReImageOption) error
ReImage invokes the upstream API with library-owned builders and result handling.
func (*API) Reserve ¶
Reserve invokes the upstream API with library-owned builders and result handling.
func (*API) ReserveVolume ¶
ReserveVolume preserves the source null action separately from native Reserve.
func (*API) ResetStatus ¶
func (a *API) ResetStatus(ctx context.Context, id string, opts ResetStatusOpts, options ...ResetStatusOption) error
ResetStatus invokes the upstream API with library-owned builders and result handling.
func (*API) ResetVolumeStatus ¶
func (a *API) ResetVolumeStatus(ctx context.Context, id string, options ...VolumeStatusResetOption) (*VolumeActionResult, error)
func (*API) RetypeVolume ¶
func (a *API) RetypeVolume(ctx context.Context, id, newType string, options ...VolumeRetypeOption) (*VolumeActionResult, error)
func (*API) RevertVolumeToSnapshot ¶
func (a *API) RevertVolumeToSnapshot(ctx context.Context, id, snapshotID string) (*VolumeActionResult, error)
RevertVolumeToSnapshot takes an explicit volume ID and literal snapshot body value. Completed reports acknowledgement, without a state poll.
func (*API) SetBootable ¶
func (a *API) SetBootable(ctx context.Context, id string, opts BootableOpts, options ...SetBootableOption) error
SetBootable invokes the upstream API with library-owned builders and result handling.
func (*API) SetImageMetadata ¶
func (a *API) SetImageMetadata(ctx context.Context, id string, opts ImageMetadataOpts, options ...SetImageMetadataOption) error
SetImageMetadata invokes the upstream API with library-owned builders and result handling.
func (*API) SetVolumeBootableStatus ¶
func (a *API) SetVolumeBootableStatus(ctx context.Context, id string, bootable bool) (*VolumeActionResult, error)
SetVolumeBootableStatus preserves the required Proxy bool and opaque acknowledgement.
func (*API) SetVolumeImageMetadata ¶
func (a *API) SetVolumeImageMetadata(ctx context.Context, id string, options ...VolumeImageMetadataOption) (*VolumeActionResult, error)
func (*API) SetVolumeReadonly ¶
func (a *API) SetVolumeReadonly(ctx context.Context, id string, options ...VolumeReadonlyOption) (*VolumeActionResult, error)
SetVolumeReadonly owns the default true and explicit false independently of native attach modes.
func (*API) TerminateConnection ¶
func (a *API) TerminateConnection(ctx context.Context, id string, opts TerminateConnectionOpts, options ...TerminateConnectionOption) error
TerminateConnection invokes the upstream API with library-owned builders and result handling.
func (*API) Unmanage ¶
Unmanage invokes the upstream API with library-owned builders and result handling.
func (*API) UnmanageVolume ¶
UnmanageVolume exposes the SDK null action separately from native Unmanage.
func (*API) Unreserve ¶
Unreserve invokes the upstream API with library-owned builders and result handling.
func (*API) UnreserveVolume ¶
func (*API) Update ¶
func (a *API) Update(ctx context.Context, id string, opts UpdateOpts, options ...UpdateOption) (*Volume, error)
Update invokes the upstream API with library-owned builders and result handling.
func (*API) UploadImage ¶
func (a *API) UploadImage(ctx context.Context, id string, opts UploadImageOpts, options ...UploadImageOption) (VolumeImage, error)
UploadImage invokes the upstream API with library-owned builders and result handling.
func (*API) UploadVolumeToImage ¶
func (a *API) UploadVolumeToImage(ctx context.Context, id, imageName string, options ...VolumeImageUploadOption) (*VolumeImageUploadResult, error)
func (*API) WaitForAvailable ¶
func (a *API) WaitForAvailable(ctx context.Context, ref resource.Ref, options ...resource.WaitOption) (*Volume, error)
WaitForAvailable uses the Cinder available target, error failure and unlimited SDK wait. Options can select a timeout or a different failure-state list.
func (*API) WaitForDelete ¶
func (a *API) WaitForDelete(ctx context.Context, ref resource.Ref, options ...resource.WaitOption) error
WaitForDelete observes absence with a two-second interval and a 120-second SDK timeout. It sends no DELETE request. Options apply last.
func (*API) WaitForDeletion ¶
func (*API) WaitForState ¶
func (a *API) WaitForState(ctx context.Context, ref resource.Ref, target string, options ...resource.WaitOption) (*Volume, error)
WaitForState observes an explicit target with a two-second polling interval, the service's exact error failure state, and no SDK timeout. Options apply last.
type AttachMode ¶
type AttachMode = upstream.AttachMode
type AttachOption ¶
type AttachOption = request.Option[AttachOpts]
func WithAttachField ¶
func WithAttachField(key string, value any) AttachOption
func WithAttachOptions ¶
func WithAttachOptions(value AttachOpts) AttachOption
type AttachOpts ¶
type AttachOpts = upstream.AttachOpts
type AttachResult ¶
type AttachResult = upstream.AttachResult
type Attachment ¶
type Attachment = upstream.Attachment
type BeginDetachingResult ¶
type BeginDetachingResult = upstream.BeginDetachingResult
type BootableOpts ¶
type BootableOpts = upstream.BootableOpts
type ChangeTypeOption ¶
type ChangeTypeOption = request.Option[ChangeTypeOpts]
func WithChangeTypeField ¶
func WithChangeTypeField(key string, value any) ChangeTypeOption
func WithChangeTypeOptions ¶
func WithChangeTypeOptions(value ChangeTypeOpts) ChangeTypeOption
type ChangeTypeOpts ¶
type ChangeTypeOpts = upstream.ChangeTypeOpts
type ChangeTypeResult ¶
type ChangeTypeResult = upstream.ChangeTypeResult
type CinderVolumeAttachOption ¶
type CinderVolumeAttachOption = cinderaction.DirectAttachOption
func WithCinderVolumeAttachHostName ¶
func WithCinderVolumeAttachHostName(value string) CinderVolumeAttachOption
func WithCinderVolumeAttachInstance ¶
func WithCinderVolumeAttachInstance(value string) CinderVolumeAttachOption
func WithCinderVolumeAttachOptions ¶
func WithCinderVolumeAttachOptions(value CinderVolumeAttachOpts) CinderVolumeAttachOption
type CinderVolumeAttachOpts ¶
type CinderVolumeAttachOpts = cinderaction.DirectAttachOptions
func PrepareCinderVolumeAttachOptions ¶
func PrepareCinderVolumeAttachOptions(ctx context.Context, options ...CinderVolumeAttachOption) (CinderVolumeAttachOpts, error)
type CinderVolumeDetachOption ¶
type CinderVolumeDetachOption = cinderaction.DirectDetachOption
func WithCinderVolumeDetachConnector ¶
func WithCinderVolumeDetachConnector(value map[string]json.RawMessage) CinderVolumeDetachOption
func WithCinderVolumeDetachForce ¶
func WithCinderVolumeDetachForce(value bool) CinderVolumeDetachOption
func WithCinderVolumeDetachOptions ¶
func WithCinderVolumeDetachOptions(value CinderVolumeDetachOpts) CinderVolumeDetachOption
type CinderVolumeDetachOpts ¶
type CinderVolumeDetachOpts = cinderaction.DirectDetachOptions
func PrepareCinderVolumeDetachOptions ¶
func PrepareCinderVolumeDetachOptions(ctx context.Context, options ...CinderVolumeDetachOption) (CinderVolumeDetachOpts, error)
type CreateOption ¶
type CreateOption = request.Option[CreateOpts]
func WithCreateField ¶
func WithCreateField(key string, value any) CreateOption
func WithCreateHintOpts ¶
func WithCreateHintOpts(value SchedulerHintOpts) CreateOption
func WithCreateOptions ¶
func WithCreateOptions(value CreateOpts) CreateOption
type CreateOpts ¶
type CreateOpts = upstream.CreateOpts
type CreateResult ¶
type CreateResult = upstream.CreateResult
type DeleteOption ¶
type DeleteOption = request.Option[DeleteOpts]
func WithDeleteOptions ¶
func WithDeleteOptions(value DeleteOpts) DeleteOption
func WithDeleteQuery ¶
func WithDeleteQuery(key, value string) DeleteOption
type DeleteOpts ¶
type DeleteOpts = upstream.DeleteOpts
type DeleteResult ¶
type DeleteResult = upstream.DeleteResult
type DetachOption ¶
type DetachOption = request.Option[DetachOpts]
func WithDetachField ¶
func WithDetachField(key string, value any) DetachOption
func WithDetachOptions ¶
func WithDetachOptions(value DetachOpts) DetachOption
type DetachOpts ¶
type DetachOpts = upstream.DetachOpts
type DetachResult ¶
type DetachResult = upstream.DetachResult
type ExtendSizeOption ¶
type ExtendSizeOption = request.Option[ExtendSizeOpts]
func WithExtendSizeField ¶
func WithExtendSizeField(key string, value any) ExtendSizeOption
func WithExtendSizeOptions ¶
func WithExtendSizeOptions(value ExtendSizeOpts) ExtendSizeOption
type ExtendSizeOpts ¶
type ExtendSizeOpts = upstream.ExtendSizeOpts
type ExtendSizeResult ¶
type ExtendSizeResult = upstream.ExtendSizeResult
type ForceDeleteResult ¶
type ForceDeleteResult = upstream.ForceDeleteResult
type ImageMetadataOpts ¶
type ImageMetadataOpts = upstream.ImageMetadataOpts
type ImageVolumeType ¶
type ImageVolumeType = upstream.ImageVolumeType
type InitializeConnectionOption ¶
type InitializeConnectionOption = request.Option[InitializeConnectionOpts]
func WithInitializeConnectionField ¶
func WithInitializeConnectionField(key string, value any) InitializeConnectionOption
func WithInitializeConnectionOptions ¶
func WithInitializeConnectionOptions(value InitializeConnectionOpts) InitializeConnectionOption
type InitializeConnectionOpts ¶
type InitializeConnectionOpts = upstream.InitializeConnectionOpts
type InitializeConnectionResult ¶
type InitializeConnectionResult = upstream.InitializeConnectionResult
type ListOption ¶
func WithListOptions ¶
func WithListOptions(value ListOpts) ListOption
func WithListQuery ¶
func WithListQuery(key, value string) ListOption
type MetadataDeleteResult ¶
type MetadataDeleteResult = metadata.DeleteResult
MetadataDeleteResult retains each acknowledged key deletion or an actual clear response.
type MetadataOption ¶
MetadataOption configures only library-owned request headers.
func WithMetadataHeader ¶
func WithMetadataHeader(key, value string) MetadataOption
func WithMetadataHeaders ¶
func WithMetadataHeaders(headers map[string]string) MetadataOption
type MetadataResult ¶
MetadataResult retains the actual metadata response and HTTP evidence.
type MetadataScope ¶
type MetadataScope struct {
// contains filtered or unexported fields
}
MetadataScope fixes a parent ID and collection URL once. Response fields and later client URL changes cannot select a different metadata resource.
func (*MetadataScope) DeleteKeys ¶
func (s *MetadataScope) DeleteKeys(ctx context.Context, keys []string, options ...MetadataOption) (*MetadataDeleteResult, error)
DeleteKeys clears with PUT for nil keys. A nonnil empty slice performs no HTTP; other keys are deleted in order, retaining prior acknowledgements on error.
func (*MetadataScope) Get ¶
func (s *MetadataScope) Get(ctx context.Context, options ...MetadataOption) (*MetadataResult, error)
func (*MetadataScope) ID ¶
func (s *MetadataScope) ID() string
func (*MetadataScope) Merge ¶
func (s *MetadataScope) Merge(ctx context.Context, values map[string]string, options ...MetadataOption) (*MetadataResult, error)
Merge sends an explicit metadata object, including for a nil or empty map.
func (*MetadataScope) RawClient ¶
func (s *MetadataScope) RawClient() *gophercloud.ServiceClient
func (*MetadataScope) Replace ¶
func (s *MetadataScope) Replace(ctx context.Context, values map[string]string, options ...MetadataOption) (*MetadataResult, error)
Replace sends the complete replacement object; nil and empty maps clear it.
type MigrationPolicy ¶
type MigrationPolicy = upstream.MigrationPolicy
type ReImageOption ¶
type ReImageOption = request.Option[ReImageOpts]
func WithReImageField ¶
func WithReImageField(key string, value any) ReImageOption
func WithReImageOptions ¶
func WithReImageOptions(value ReImageOpts) ReImageOption
type ReImageOpts ¶
type ReImageOpts = upstream.ReImageOpts
type ReImageResult ¶
type ReImageResult = upstream.ReImageResult
type ReserveResult ¶
type ReserveResult = upstream.ReserveResult
type ResetStatusOption ¶
type ResetStatusOption = request.Option[ResetStatusOpts]
func WithResetStatusField ¶
func WithResetStatusField(key string, value any) ResetStatusOption
func WithResetStatusOptions ¶
func WithResetStatusOptions(value ResetStatusOpts) ResetStatusOption
type ResetStatusOpts ¶
type ResetStatusOpts = upstream.ResetStatusOpts
type ResetStatusResult ¶
type ResetStatusResult = upstream.ResetStatusResult
type SchedulerHintOpts ¶
type SchedulerHintOpts = upstream.SchedulerHintOpts
type SetBootableOption ¶
type SetBootableOption = request.Option[BootableOpts]
func WithSetBootableField ¶
func WithSetBootableField(key string, value any) SetBootableOption
func WithSetBootableOptions ¶
func WithSetBootableOptions(value BootableOpts) SetBootableOption
type SetBootableResult ¶
type SetBootableResult = upstream.SetBootableResult
type SetImageMetadataOption ¶
type SetImageMetadataOption = request.Option[ImageMetadataOpts]
func WithSetImageMetadataField ¶
func WithSetImageMetadataField(key string, value any) SetImageMetadataOption
func WithSetImageMetadataOptions ¶
func WithSetImageMetadataOptions(value ImageMetadataOpts) SetImageMetadataOption
type SetImageMetadataResult ¶
type SetImageMetadataResult = upstream.SetImageMetadataResult
type TerminateConnectionOption ¶
type TerminateConnectionOption = request.Option[TerminateConnectionOpts]
func WithTerminateConnectionField ¶
func WithTerminateConnectionField(key string, value any) TerminateConnectionOption
func WithTerminateConnectionOptions ¶
func WithTerminateConnectionOptions(value TerminateConnectionOpts) TerminateConnectionOption
type TerminateConnectionOpts ¶
type TerminateConnectionOpts = upstream.TerminateConnectionOpts
type TerminateConnectionResult ¶
type TerminateConnectionResult = upstream.TerminateConnectionResult
type UnmanageResult ¶
type UnmanageResult = upstream.UnmanageResult
type UnreserveResult ¶
type UnreserveResult = upstream.UnreserveResult
type UpdateOption ¶
type UpdateOption = request.Option[UpdateOpts]
func WithUpdateField ¶
func WithUpdateField(key string, value any) UpdateOption
func WithUpdateOptions ¶
func WithUpdateOptions(value UpdateOpts) UpdateOption
type UpdateOpts ¶
type UpdateOpts = upstream.UpdateOpts
type UpdateResult ¶
type UpdateResult = upstream.UpdateResult
type UploadImageOption ¶
type UploadImageOption = request.Option[UploadImageOpts]
func WithUploadImageField ¶
func WithUploadImageField(key string, value any) UploadImageOption
func WithUploadImageOptions ¶
func WithUploadImageOptions(value UploadImageOpts) UploadImageOption
type UploadImageOpts ¶
type UploadImageOpts = upstream.UploadImageOpts
type UploadImageResult ¶
type UploadImageResult = upstream.UploadImageResult
type VolumeActionResult ¶
type VolumeActionResult = cinderaction.Result
type VolumeExtendCompletionOption ¶
type VolumeExtendCompletionOption = cinderaction.ExtendCompletionOption
func WithVolumeExtendCompletionError ¶
func WithVolumeExtendCompletionError(value bool) VolumeExtendCompletionOption
func WithVolumeExtendCompletionOptions ¶
func WithVolumeExtendCompletionOptions(value VolumeExtendCompletionOpts) VolumeExtendCompletionOption
type VolumeExtendCompletionOpts ¶
type VolumeExtendCompletionOpts = cinderaction.ExtendCompletionOptions
func PrepareVolumeExtendCompletionOptions ¶
func PrepareVolumeExtendCompletionOptions(ctx context.Context, options ...VolumeExtendCompletionOption) (VolumeExtendCompletionOpts, error)
type VolumeImage ¶
type VolumeImage = upstream.VolumeImage
type VolumeImageMetadataDeleteOption ¶
type VolumeImageMetadataDeleteOption = cinderaction.ImageMetadataDeleteOption
func WithVolumeImageMetadataDeleteAll ¶
func WithVolumeImageMetadataDeleteAll() VolumeImageMetadataDeleteOption
WithVolumeImageMetadataDeleteAll restores the default all-keys intent.
func WithVolumeImageMetadataDeleteKeys ¶
func WithVolumeImageMetadataDeleteKeys(keys ...string) VolumeImageMetadataDeleteOption
WithVolumeImageMetadataDeleteKeys preserves order and duplicates. No keys selects an explicit no-op, including when expanded from a nil slice.
func WithVolumeImageMetadataDeleteOptions ¶
func WithVolumeImageMetadataDeleteOptions(value VolumeImageMetadataDeleteOpts) VolumeImageMetadataDeleteOption
type VolumeImageMetadataDeleteOpts ¶
type VolumeImageMetadataDeleteOpts = cinderaction.ImageMetadataDeleteOptions
func PrepareVolumeImageMetadataDeleteOptions ¶
func PrepareVolumeImageMetadataDeleteOptions(ctx context.Context, options ...VolumeImageMetadataDeleteOption) (VolumeImageMetadataDeleteOpts, error)
type VolumeImageMetadataDeleteResult ¶
type VolumeImageMetadataDeleteResult = cinderaction.ImageMetadataDeleteResult
type VolumeImageMetadataDeletion ¶
type VolumeImageMetadataDeletion = cinderaction.ImageMetadataDeletion
type VolumeImageMetadataOption ¶
type VolumeImageMetadataOption = cinderaction.ImageMetadataOption
func WithVolumeImageMetadata ¶
func WithVolumeImageMetadata(value map[string]string) VolumeImageMetadataOption
WithVolumeImageMetadata replaces the metadata object with string values.
func WithVolumeImageMetadataOptions ¶
func WithVolumeImageMetadataOptions(value VolumeImageMetadataOpts) VolumeImageMetadataOption
WithVolumeImageMetadataOptions replaces the entire owned policy.
func WithVolumeImageMetadataRaw ¶
func WithVolumeImageMetadataRaw(value map[string]json.RawMessage) VolumeImageMetadataOption
WithVolumeImageMetadataRaw replaces the object with owned JSON values.
func WithVolumeImageMetadataValue ¶
func WithVolumeImageMetadataValue(key, value string) VolumeImageMetadataOption
WithVolumeImageMetadataValue adds or replaces one string value.
type VolumeImageMetadataOpts ¶
type VolumeImageMetadataOpts = cinderaction.ImageMetadataOptions
func PrepareVolumeImageMetadataOptions ¶
func PrepareVolumeImageMetadataOptions(ctx context.Context, options ...VolumeImageMetadataOption) (VolumeImageMetadataOpts, error)
type VolumeImageUploadOption ¶
type VolumeImageUploadOption = cinderaction.ImageUploadOption
func WithVolumeImageUploadContainerFormat ¶
func WithVolumeImageUploadContainerFormat(value string) VolumeImageUploadOption
func WithVolumeImageUploadDiskFormat ¶
func WithVolumeImageUploadDiskFormat(value string) VolumeImageUploadOption
func WithVolumeImageUploadForce ¶
func WithVolumeImageUploadForce(value bool) VolumeImageUploadOption
func WithVolumeImageUploadOptions ¶
func WithVolumeImageUploadOptions(value VolumeImageUploadOpts) VolumeImageUploadOption
func WithVolumeImageUploadProtected ¶
func WithVolumeImageUploadProtected(value bool) VolumeImageUploadOption
func WithVolumeImageUploadVisibility ¶
func WithVolumeImageUploadVisibility(value string) VolumeImageUploadOption
type VolumeImageUploadOpts ¶
type VolumeImageUploadOpts = cinderaction.ImageUploadOptions
func PrepareVolumeImageUploadOptions ¶
func PrepareVolumeImageUploadOptions(ctx context.Context, options ...VolumeImageUploadOption) (VolumeImageUploadOpts, error)
type VolumeImageUploadResult ¶
type VolumeImageUploadResult = cinderaction.ImageUploadResult
type VolumeMigrationCompletionOption ¶
type VolumeMigrationCompletionOption = cinderaction.MigrationCompletionOption
func WithVolumeMigrationCompletionError ¶
func WithVolumeMigrationCompletionError(value bool) VolumeMigrationCompletionOption
func WithVolumeMigrationCompletionOptions ¶
func WithVolumeMigrationCompletionOptions(value VolumeMigrationCompletionOpts) VolumeMigrationCompletionOption
type VolumeMigrationCompletionOpts ¶
type VolumeMigrationCompletionOpts = cinderaction.MigrationCompletionOptions
func PrepareVolumeMigrationCompletionOptions ¶
func PrepareVolumeMigrationCompletionOptions(ctx context.Context, options ...VolumeMigrationCompletionOption) (VolumeMigrationCompletionOpts, error)
type VolumeMigrationOption ¶
type VolumeMigrationOption = cinderaction.MigrationOption
func WithVolumeMigrationCluster ¶
func WithVolumeMigrationCluster(value string) VolumeMigrationOption
func WithVolumeMigrationForceHostCopy ¶
func WithVolumeMigrationForceHostCopy(value bool) VolumeMigrationOption
func WithVolumeMigrationHost ¶
func WithVolumeMigrationHost(value string) VolumeMigrationOption
func WithVolumeMigrationLockVolume ¶
func WithVolumeMigrationLockVolume(value bool) VolumeMigrationOption
func WithVolumeMigrationOptions ¶
func WithVolumeMigrationOptions(value VolumeMigrationOpts) VolumeMigrationOption
type VolumeMigrationOpts ¶
type VolumeMigrationOpts = cinderaction.MigrationOptions
func PrepareVolumeMigrationOptions ¶
func PrepareVolumeMigrationOptions(ctx context.Context, options ...VolumeMigrationOption) (VolumeMigrationOpts, error)
type VolumePage ¶
type VolumePage = upstream.VolumePage
type VolumeReadonlyOption ¶
type VolumeReadonlyOption = cinderaction.ReadonlyOption
func WithVolumeReadonly ¶
func WithVolumeReadonly(value bool) VolumeReadonlyOption
func WithVolumeReadonlyOptions ¶
func WithVolumeReadonlyOptions(value VolumeReadonlyOpts) VolumeReadonlyOption
type VolumeReadonlyOpts ¶
type VolumeReadonlyOpts = cinderaction.ReadonlyOptions
func PrepareVolumeReadonlyOptions ¶
func PrepareVolumeReadonlyOptions(ctx context.Context, options ...VolumeReadonlyOption) (VolumeReadonlyOpts, error)
type VolumeRetypeOption ¶
type VolumeRetypeOption = cinderaction.RetypeOption
func WithVolumeRetypeMigrationPolicy ¶
func WithVolumeRetypeMigrationPolicy(value string) VolumeRetypeOption
func WithVolumeRetypeOptions ¶
func WithVolumeRetypeOptions(value VolumeRetypeOpts) VolumeRetypeOption
type VolumeRetypeOpts ¶
type VolumeRetypeOpts = cinderaction.RetypeOptions
func PrepareVolumeRetypeOptions ¶
func PrepareVolumeRetypeOptions(ctx context.Context, options ...VolumeRetypeOption) (VolumeRetypeOpts, error)
type VolumeStatusResetOption ¶
type VolumeStatusResetOption = cinderaction.StatusResetOption
func WithVolumeStatusResetAttachStatus ¶
func WithVolumeStatusResetAttachStatus(value string) VolumeStatusResetOption
func WithVolumeStatusResetMigrationStatus ¶
func WithVolumeStatusResetMigrationStatus(value string) VolumeStatusResetOption
func WithVolumeStatusResetOptions ¶
func WithVolumeStatusResetOptions(value VolumeStatusResetOpts) VolumeStatusResetOption
func WithVolumeStatusResetStatus ¶
func WithVolumeStatusResetStatus(value string) VolumeStatusResetOption
type VolumeStatusResetOpts ¶
type VolumeStatusResetOpts = cinderaction.StatusResetOptions
func PrepareVolumeStatusResetOptions ¶
func PrepareVolumeStatusResetOptions(ctx context.Context, options ...VolumeStatusResetOption) (VolumeStatusResetOpts, error)