volumes

Documentation

Index

• func Create(ctx context.Context, config entities.VolumeCreateOptions) (*entities.VolumeConfigResponse, error)
• func Inspect(ctx context.Context, nameOrID string) (*entities.VolumeConfigResponse, error)
• func List(ctx context.Context, filters map[string][]string) ([]*entities.VolumeListReport, error)
• func Prune(ctx context.Context) ([]*entities.VolumePruneReport, error)
• func Remove(ctx context.Context, nameOrID string, force *bool) error

Functions

func Create

func Create(ctx context.Context, config entities.VolumeCreateOptions) (*entities.VolumeConfigResponse, error)

Create creates a volume given its configuration.

func Inspect

func Inspect(ctx context.Context, nameOrID string) (*entities.VolumeConfigResponse, error)

Inspect returns low-level information about a volume.

func List

func List(ctx context.Context, filters map[string][]string) ([]*entities.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) ([]*entities.VolumePruneReport, error)

Prune removes unused volumes from the local filesystem.

func Remove

func Remove(ctx context.Context, nameOrID string, force *bool) 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.