volumes

Documentation

Overview

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Index

• func Create(ctx context.Context, config entitiesTypes.VolumeCreateOptions, ...) (*entitiesTypes.VolumeConfigResponse, error)
• func Exists(ctx context.Context, nameOrID string, options *ExistsOptions) (bool, error)
• func Inspect(ctx context.Context, nameOrID string, options *InspectOptions) (*entitiesTypes.VolumeConfigResponse, error)
• func List(ctx context.Context, options *ListOptions) ([]*entitiesTypes.VolumeListReport, error)
• func Prune(ctx context.Context, options *PruneOptions) ([]*reports.PruneReport, error)
• func Remove(ctx context.Context, nameOrID string, options *RemoveOptions) error
• type CreateOptions
  • func (o *CreateOptions) Changed(fieldName string) bool
  • func (o *CreateOptions) ToParams() (url.Values, error)
• type ExistsOptions
  • func (o *ExistsOptions) Changed(fieldName string) bool
  • func (o *ExistsOptions) ToParams() (url.Values, error)
• type InspectOptions
  • func (o *InspectOptions) Changed(fieldName string) bool
  • func (o *InspectOptions) ToParams() (url.Values, error)
• type ListOptions
  • func (o *ListOptions) Changed(fieldName string) bool
  • func (o *ListOptions) GetFilters() map[string][]string
  • func (o *ListOptions) ToParams() (url.Values, error)
  • func (o *ListOptions) WithFilters(value map[string][]string) *ListOptions
• type PruneOptions
  • func (o *PruneOptions) Changed(fieldName string) bool
  • func (o *PruneOptions) GetFilters() map[string][]string
  • func (o *PruneOptions) ToParams() (url.Values, error)
  • func (o *PruneOptions) WithFilters(value map[string][]string) *PruneOptions
• type RemoveOptions
  • func (o *RemoveOptions) Changed(fieldName string) bool
  • func (o *RemoveOptions) GetForce() bool
  • func (o *RemoveOptions) GetTimeout() uint
  • func (o *RemoveOptions) ToParams() (url.Values, error)
  • func (o *RemoveOptions) WithForce(value bool) *RemoveOptions
  • func (o *RemoveOptions) WithTimeout(value uint) *RemoveOptions

Functions

func Create

func Create(ctx context.Context, config entitiesTypes.VolumeCreateOptions, options *CreateOptions) (*entitiesTypes.VolumeConfigResponse, error)

Create creates a volume given its configuration.

func Exists

func Exists(ctx context.Context, nameOrID string, options *ExistsOptions) (bool, error)

Exists returns true if a given volume exists

func Inspect

func Inspect(ctx context.Context, nameOrID string, options *InspectOptions) (*entitiesTypes.VolumeConfigResponse, error)

Inspect returns low-level information about a volume.

func List

func List(ctx context.Context, options *ListOptions) ([]*entitiesTypes.VolumeListReport, error)

List returns the configurations for existing volumes in the form of a slice. Optionally, filters can be used to refine the list of volumes.

func Prune

func Prune(ctx context.Context, options *PruneOptions) ([]*reports.PruneReport, error)

Prune removes unused volumes from the local filesystem.

func Remove

func Remove(ctx context.Context, nameOrID string, options *RemoveOptions) error

Remove deletes the given volume from storage. The optional force parameter is used to remove a volume even if it is being used by a container.

Types

type CreateOptions

type CreateOptions struct {
}

CreateOptions are optional options for creating volumes

func (*CreateOptions) Changed

func (o *CreateOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*CreateOptions) ToParams

func (o *CreateOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

type ExistsOptions

type ExistsOptions struct {
}

ExistsOptions are optional options for checking if a volume exists

func (*ExistsOptions) Changed

func (o *ExistsOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*ExistsOptions) ToParams

func (o *ExistsOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

type InspectOptions

type InspectOptions struct {
}

InspectOptions are optional options for inspecting volumes

func (*InspectOptions) Changed

func (o *InspectOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*InspectOptions) ToParams

func (o *InspectOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

type ListOptions

type ListOptions struct {
	// Filters applied to the listing of volumes
	Filters map[string][]string
}

ListOptions are optional options for listing volumes

func (*ListOptions) Changed

func (o *ListOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*ListOptions) GetFilters

func (o *ListOptions) GetFilters() map[string][]string

GetFilters returns value of field Filters

func (*ListOptions) ToParams

func (o *ListOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*ListOptions) WithFilters

func (o *ListOptions) WithFilters(value map[string][]string) *ListOptions

WithFilters set field Filters to given value

type PruneOptions

type PruneOptions struct {
	// Filters applied to the pruning of volumes
	Filters map[string][]string
}

PruneOptions are optional options for pruning volumes

func (*PruneOptions) Changed

func (o *PruneOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*PruneOptions) GetFilters

func (o *PruneOptions) GetFilters() map[string][]string

GetFilters returns value of field Filters

func (*PruneOptions) ToParams

func (o *PruneOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*PruneOptions) WithFilters

func (o *PruneOptions) WithFilters(value map[string][]string) *PruneOptions

WithFilters set field Filters to given value

type RemoveOptions

type RemoveOptions struct {
	// Force removes the volume even if it is being used
	Force   *bool
	Timeout *uint
}

RemoveOptions are optional options for removing volumes

func (*RemoveOptions) Changed

func (o *RemoveOptions) Changed(fieldName string) bool

Changed returns true if named field has been set

func (*RemoveOptions) GetForce

func (o *RemoveOptions) GetForce() bool

GetForce returns value of field Force

func (*RemoveOptions) GetTimeout

func (o *RemoveOptions) GetTimeout() uint

GetTimeout returns value of field Timeout

func (*RemoveOptions) ToParams

func (o *RemoveOptions) ToParams() (url.Values, error)

ToParams formats struct fields to be passed to API service

func (*RemoveOptions) WithForce

func (o *RemoveOptions) WithForce(value bool) *RemoveOptions

WithForce set field Force to given value

func (*RemoveOptions) WithTimeout

func (o *RemoveOptions) WithTimeout(value uint) *RemoveOptions

WithTimeout set field Timeout to given value