volume

package
v1.2.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 22, 2024 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateOption

type CreateOption struct {
	// Name of the volume driver to use.
	Driver string `json:"Driver,omitempty"`

	// A mapping of driver options and values. These options are
	// passed directly to the driver and are driver specific.
	//
	DriverOpts map[string]string `json:"DriverOpts,omitempty"`

	// User-defined key/value metadata.
	Labels map[string]string `json:"Labels,omitempty"`
}

type InspectOption

type InspectOption struct {
}

type ListOption

type ListOption struct {
	Filters filters.Args
}

type PruneOption

type PruneOption struct {
	Filters filters.Args
}

type RemoveOption

type RemoveOption struct {
	Force bool `json:"force"`
}

type Volume

type Volume interface {
	List(ctx context.Context, opts ...func(*ListOption)) ([]entity.Volume, error)
	Inspect(ctx context.Context, id string, opts ...func(*InspectOption)) (vo.Volume, error)
	//
	Create(ctx context.Context, name string, opts ...func(*CreateOption)) (vo.Volume, error)
	Remove(ctx context.Context, id string, opts ...func(opt *RemoveOption)) error
	//
	Prune(ctx context.Context, opts ...func(opt *PruneOption)) (types.VolumesPruneReport, error)
}

func New

func New(client *client.Client) Volume

New creates a docker image client

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL