volume

package
v0.0.0-...-f9bae2f Latest Latest
Warning

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

Go to latest
Published: Oct 24, 2021 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source
const VolumeCreateCreatedCode int = 201

VolumeCreateCreatedCode is the HTTP code returned for type VolumeCreateCreated

View Source
const VolumeCreateInternalServerErrorCode int = 500

VolumeCreateInternalServerErrorCode is the HTTP code returned for type VolumeCreateInternalServerError

View Source
const VolumeDeleteConflictCode int = 409

VolumeDeleteConflictCode is the HTTP code returned for type VolumeDeleteConflict

View Source
const VolumeDeleteInternalServerErrorCode int = 500

VolumeDeleteInternalServerErrorCode is the HTTP code returned for type VolumeDeleteInternalServerError

View Source
const VolumeDeleteNoContentCode int = 204

VolumeDeleteNoContentCode is the HTTP code returned for type VolumeDeleteNoContent

View Source
const VolumeDeleteNotFoundCode int = 404

VolumeDeleteNotFoundCode is the HTTP code returned for type VolumeDeleteNotFound

View Source
const VolumeInspectInternalServerErrorCode int = 500

VolumeInspectInternalServerErrorCode is the HTTP code returned for type VolumeInspectInternalServerError

View Source
const VolumeInspectNotFoundCode int = 404

VolumeInspectNotFoundCode is the HTTP code returned for type VolumeInspectNotFound

View Source
const VolumeInspectOKCode int = 200

VolumeInspectOKCode is the HTTP code returned for type VolumeInspectOK

View Source
const VolumeListInternalServerErrorCode int = 500

VolumeListInternalServerErrorCode is the HTTP code returned for type VolumeListInternalServerError

View Source
const VolumeListOKCode int = 200

VolumeListOKCode is the HTTP code returned for type VolumeListOK

View Source
const VolumePruneInternalServerErrorCode int = 500

VolumePruneInternalServerErrorCode is the HTTP code returned for type VolumePruneInternalServerError

View Source
const VolumePruneOKCode int = 200

VolumePruneOKCode is the HTTP code returned for type VolumePruneOK

Variables

This section is empty.

Functions

This section is empty.

Types

type VolumeCreate

type VolumeCreate struct {
	Context *middleware.Context
	Handler VolumeCreateHandler
}
VolumeCreate swagger:route POST /volumes/create Volume volumeCreate

Create a volume

func NewVolumeCreate

func NewVolumeCreate(ctx *middleware.Context, handler VolumeCreateHandler) *VolumeCreate

NewVolumeCreate creates a new http.Handler for the volume create operation

func (*VolumeCreate) ServeHTTP

func (o *VolumeCreate) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type VolumeCreateBody

type VolumeCreateBody 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"`

	// The new volume's name. If not specified, Docker generates a name.
	//
	Name string `json:"Name,omitempty"`
}

VolumeCreateBody VolumeConfig

Volume configuration Example: {"Driver":"custom","Labels":{"com.example.some-label":"some-value","com.example.some-other-label":"some-other-value"},"Name":"tardis"}

swagger:model VolumeCreateBody

func (*VolumeCreateBody) ContextValidate

func (o *VolumeCreateBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this volume create body based on context it is used

func (*VolumeCreateBody) MarshalBinary

func (o *VolumeCreateBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*VolumeCreateBody) UnmarshalBinary

func (o *VolumeCreateBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*VolumeCreateBody) Validate

func (o *VolumeCreateBody) Validate(formats strfmt.Registry) error

Validate validates this volume create body

type VolumeCreateCreated

type VolumeCreateCreated struct {

	/*
	  In: Body
	*/
	Payload *models.Volume `json:"body,omitempty"`
}

VolumeCreateCreated The volume was created successfully

swagger:response volumeCreateCreated

func NewVolumeCreateCreated

func NewVolumeCreateCreated() *VolumeCreateCreated

NewVolumeCreateCreated creates VolumeCreateCreated with default headers values

func (*VolumeCreateCreated) SetPayload

func (o *VolumeCreateCreated) SetPayload(payload *models.Volume)

SetPayload sets the payload to the volume create created response

func (*VolumeCreateCreated) WithPayload

func (o *VolumeCreateCreated) WithPayload(payload *models.Volume) *VolumeCreateCreated

WithPayload adds the payload to the volume create created response

func (*VolumeCreateCreated) WriteResponse

func (o *VolumeCreateCreated) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type VolumeCreateHandler

type VolumeCreateHandler interface {
	Handle(VolumeCreateParams) middleware.Responder
}

VolumeCreateHandler interface for that can handle valid volume create params

type VolumeCreateHandlerFunc

type VolumeCreateHandlerFunc func(VolumeCreateParams) middleware.Responder

VolumeCreateHandlerFunc turns a function with the right signature into a volume create handler

func (VolumeCreateHandlerFunc) Handle

Handle executing the request and returning a response

type VolumeCreateInternalServerError

type VolumeCreateInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *models.ErrorResponse `json:"body,omitempty"`
}

VolumeCreateInternalServerError Server error

swagger:response volumeCreateInternalServerError

func NewVolumeCreateInternalServerError

func NewVolumeCreateInternalServerError() *VolumeCreateInternalServerError

NewVolumeCreateInternalServerError creates VolumeCreateInternalServerError with default headers values

func (*VolumeCreateInternalServerError) SetPayload

func (o *VolumeCreateInternalServerError) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the volume create internal server error response

func (*VolumeCreateInternalServerError) WithPayload

WithPayload adds the payload to the volume create internal server error response

func (*VolumeCreateInternalServerError) WriteResponse

func (o *VolumeCreateInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type VolumeCreateParams

type VolumeCreateParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*Volume configuration
	  Required: true
	  In: body
	*/
	VolumeConfig VolumeCreateBody
}

VolumeCreateParams contains all the bound params for the volume create operation typically these are obtained from a http.Request

swagger:parameters VolumeCreate

func NewVolumeCreateParams

func NewVolumeCreateParams() VolumeCreateParams

NewVolumeCreateParams creates a new VolumeCreateParams object

There are no default values defined in the spec.

func (*VolumeCreateParams) BindRequest

func (o *VolumeCreateParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewVolumeCreateParams() beforehand.

type VolumeCreateURL

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

VolumeCreateURL generates an URL for the volume create operation

func (*VolumeCreateURL) Build

func (o *VolumeCreateURL) Build() (*url.URL, error)

Build a url path and query string

func (*VolumeCreateURL) BuildFull

func (o *VolumeCreateURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*VolumeCreateURL) Must

func (o *VolumeCreateURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*VolumeCreateURL) SetBasePath

func (o *VolumeCreateURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*VolumeCreateURL) String

func (o *VolumeCreateURL) String() string

String returns the string representation of the path with query string

func (*VolumeCreateURL) StringFull

func (o *VolumeCreateURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*VolumeCreateURL) WithBasePath

func (o *VolumeCreateURL) WithBasePath(bp string) *VolumeCreateURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type VolumeDelete

type VolumeDelete struct {
	Context *middleware.Context
	Handler VolumeDeleteHandler
}
VolumeDelete swagger:route DELETE /volumes/{name} Volume volumeDelete

Remove a volume

Instruct the driver to remove the volume.

func NewVolumeDelete

func NewVolumeDelete(ctx *middleware.Context, handler VolumeDeleteHandler) *VolumeDelete

NewVolumeDelete creates a new http.Handler for the volume delete operation

func (*VolumeDelete) ServeHTTP

func (o *VolumeDelete) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type VolumeDeleteConflict

type VolumeDeleteConflict struct {

	/*
	  In: Body
	*/
	Payload *models.ErrorResponse `json:"body,omitempty"`
}

VolumeDeleteConflict Volume is in use and cannot be removed

swagger:response volumeDeleteConflict

func NewVolumeDeleteConflict

func NewVolumeDeleteConflict() *VolumeDeleteConflict

NewVolumeDeleteConflict creates VolumeDeleteConflict with default headers values

func (*VolumeDeleteConflict) SetPayload

func (o *VolumeDeleteConflict) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the volume delete conflict response

func (*VolumeDeleteConflict) WithPayload

WithPayload adds the payload to the volume delete conflict response

func (*VolumeDeleteConflict) WriteResponse

func (o *VolumeDeleteConflict) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type VolumeDeleteHandler

type VolumeDeleteHandler interface {
	Handle(VolumeDeleteParams) middleware.Responder
}

VolumeDeleteHandler interface for that can handle valid volume delete params

type VolumeDeleteHandlerFunc

type VolumeDeleteHandlerFunc func(VolumeDeleteParams) middleware.Responder

VolumeDeleteHandlerFunc turns a function with the right signature into a volume delete handler

func (VolumeDeleteHandlerFunc) Handle

Handle executing the request and returning a response

type VolumeDeleteInternalServerError

type VolumeDeleteInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *models.ErrorResponse `json:"body,omitempty"`
}

VolumeDeleteInternalServerError Server error

swagger:response volumeDeleteInternalServerError

func NewVolumeDeleteInternalServerError

func NewVolumeDeleteInternalServerError() *VolumeDeleteInternalServerError

NewVolumeDeleteInternalServerError creates VolumeDeleteInternalServerError with default headers values

func (*VolumeDeleteInternalServerError) SetPayload

func (o *VolumeDeleteInternalServerError) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the volume delete internal server error response

func (*VolumeDeleteInternalServerError) WithPayload

WithPayload adds the payload to the volume delete internal server error response

func (*VolumeDeleteInternalServerError) WriteResponse

func (o *VolumeDeleteInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type VolumeDeleteNoContent

type VolumeDeleteNoContent struct {
}

VolumeDeleteNoContent The volume was removed

swagger:response volumeDeleteNoContent

func NewVolumeDeleteNoContent

func NewVolumeDeleteNoContent() *VolumeDeleteNoContent

NewVolumeDeleteNoContent creates VolumeDeleteNoContent with default headers values

func (*VolumeDeleteNoContent) WriteResponse

func (o *VolumeDeleteNoContent) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type VolumeDeleteNotFound

type VolumeDeleteNotFound struct {

	/*
	  In: Body
	*/
	Payload *models.ErrorResponse `json:"body,omitempty"`
}

VolumeDeleteNotFound No such volume or volume driver

swagger:response volumeDeleteNotFound

func NewVolumeDeleteNotFound

func NewVolumeDeleteNotFound() *VolumeDeleteNotFound

NewVolumeDeleteNotFound creates VolumeDeleteNotFound with default headers values

func (*VolumeDeleteNotFound) SetPayload

func (o *VolumeDeleteNotFound) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the volume delete not found response

func (*VolumeDeleteNotFound) WithPayload

WithPayload adds the payload to the volume delete not found response

func (*VolumeDeleteNotFound) WriteResponse

func (o *VolumeDeleteNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type VolumeDeleteParams

type VolumeDeleteParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*Force the removal of the volume
	  In: query
	  Default: false
	*/
	Force *bool
	/*Volume name or ID
	  Required: true
	  In: path
	*/
	Name string
}

VolumeDeleteParams contains all the bound params for the volume delete operation typically these are obtained from a http.Request

swagger:parameters VolumeDelete

func NewVolumeDeleteParams

func NewVolumeDeleteParams() VolumeDeleteParams

NewVolumeDeleteParams creates a new VolumeDeleteParams object with the default values initialized.

func (*VolumeDeleteParams) BindRequest

func (o *VolumeDeleteParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewVolumeDeleteParams() beforehand.

type VolumeDeleteURL

type VolumeDeleteURL struct {
	Name string

	Force *bool
	// contains filtered or unexported fields
}

VolumeDeleteURL generates an URL for the volume delete operation

func (*VolumeDeleteURL) Build

func (o *VolumeDeleteURL) Build() (*url.URL, error)

Build a url path and query string

func (*VolumeDeleteURL) BuildFull

func (o *VolumeDeleteURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*VolumeDeleteURL) Must

func (o *VolumeDeleteURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*VolumeDeleteURL) SetBasePath

func (o *VolumeDeleteURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*VolumeDeleteURL) String

func (o *VolumeDeleteURL) String() string

String returns the string representation of the path with query string

func (*VolumeDeleteURL) StringFull

func (o *VolumeDeleteURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*VolumeDeleteURL) WithBasePath

func (o *VolumeDeleteURL) WithBasePath(bp string) *VolumeDeleteURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type VolumeInspect

type VolumeInspect struct {
	Context *middleware.Context
	Handler VolumeInspectHandler
}
VolumeInspect swagger:route GET /volumes/{name} Volume volumeInspect

Inspect a volume

func NewVolumeInspect

func NewVolumeInspect(ctx *middleware.Context, handler VolumeInspectHandler) *VolumeInspect

NewVolumeInspect creates a new http.Handler for the volume inspect operation

func (*VolumeInspect) ServeHTTP

func (o *VolumeInspect) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type VolumeInspectHandler

type VolumeInspectHandler interface {
	Handle(VolumeInspectParams) middleware.Responder
}

VolumeInspectHandler interface for that can handle valid volume inspect params

type VolumeInspectHandlerFunc

type VolumeInspectHandlerFunc func(VolumeInspectParams) middleware.Responder

VolumeInspectHandlerFunc turns a function with the right signature into a volume inspect handler

func (VolumeInspectHandlerFunc) Handle

Handle executing the request and returning a response

type VolumeInspectInternalServerError

type VolumeInspectInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *models.ErrorResponse `json:"body,omitempty"`
}

VolumeInspectInternalServerError Server error

swagger:response volumeInspectInternalServerError

func NewVolumeInspectInternalServerError

func NewVolumeInspectInternalServerError() *VolumeInspectInternalServerError

NewVolumeInspectInternalServerError creates VolumeInspectInternalServerError with default headers values

func (*VolumeInspectInternalServerError) SetPayload

func (o *VolumeInspectInternalServerError) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the volume inspect internal server error response

func (*VolumeInspectInternalServerError) WithPayload

WithPayload adds the payload to the volume inspect internal server error response

func (*VolumeInspectInternalServerError) WriteResponse

func (o *VolumeInspectInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type VolumeInspectNotFound

type VolumeInspectNotFound struct {

	/*
	  In: Body
	*/
	Payload *models.ErrorResponse `json:"body,omitempty"`
}

VolumeInspectNotFound No such volume

swagger:response volumeInspectNotFound

func NewVolumeInspectNotFound

func NewVolumeInspectNotFound() *VolumeInspectNotFound

NewVolumeInspectNotFound creates VolumeInspectNotFound with default headers values

func (*VolumeInspectNotFound) SetPayload

func (o *VolumeInspectNotFound) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the volume inspect not found response

func (*VolumeInspectNotFound) WithPayload

WithPayload adds the payload to the volume inspect not found response

func (*VolumeInspectNotFound) WriteResponse

func (o *VolumeInspectNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type VolumeInspectOK

type VolumeInspectOK struct {

	/*
	  In: Body
	*/
	Payload *models.Volume `json:"body,omitempty"`
}

VolumeInspectOK No error

swagger:response volumeInspectOK

func NewVolumeInspectOK

func NewVolumeInspectOK() *VolumeInspectOK

NewVolumeInspectOK creates VolumeInspectOK with default headers values

func (*VolumeInspectOK) SetPayload

func (o *VolumeInspectOK) SetPayload(payload *models.Volume)

SetPayload sets the payload to the volume inspect o k response

func (*VolumeInspectOK) WithPayload

func (o *VolumeInspectOK) WithPayload(payload *models.Volume) *VolumeInspectOK

WithPayload adds the payload to the volume inspect o k response

func (*VolumeInspectOK) WriteResponse

func (o *VolumeInspectOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type VolumeInspectParams

type VolumeInspectParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*Volume name or ID
	  Required: true
	  In: path
	*/
	Name string
}

VolumeInspectParams contains all the bound params for the volume inspect operation typically these are obtained from a http.Request

swagger:parameters VolumeInspect

func NewVolumeInspectParams

func NewVolumeInspectParams() VolumeInspectParams

NewVolumeInspectParams creates a new VolumeInspectParams object

There are no default values defined in the spec.

func (*VolumeInspectParams) BindRequest

func (o *VolumeInspectParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewVolumeInspectParams() beforehand.

type VolumeInspectURL

type VolumeInspectURL struct {
	Name string
	// contains filtered or unexported fields
}

VolumeInspectURL generates an URL for the volume inspect operation

func (*VolumeInspectURL) Build

func (o *VolumeInspectURL) Build() (*url.URL, error)

Build a url path and query string

func (*VolumeInspectURL) BuildFull

func (o *VolumeInspectURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*VolumeInspectURL) Must

func (o *VolumeInspectURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*VolumeInspectURL) SetBasePath

func (o *VolumeInspectURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*VolumeInspectURL) String

func (o *VolumeInspectURL) String() string

String returns the string representation of the path with query string

func (*VolumeInspectURL) StringFull

func (o *VolumeInspectURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*VolumeInspectURL) WithBasePath

func (o *VolumeInspectURL) WithBasePath(bp string) *VolumeInspectURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type VolumeList

type VolumeList struct {
	Context *middleware.Context
	Handler VolumeListHandler
}
VolumeList swagger:route GET /volumes Volume volumeList

List volumes

func NewVolumeList

func NewVolumeList(ctx *middleware.Context, handler VolumeListHandler) *VolumeList

NewVolumeList creates a new http.Handler for the volume list operation

func (*VolumeList) ServeHTTP

func (o *VolumeList) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type VolumeListHandler

type VolumeListHandler interface {
	Handle(VolumeListParams) middleware.Responder
}

VolumeListHandler interface for that can handle valid volume list params

type VolumeListHandlerFunc

type VolumeListHandlerFunc func(VolumeListParams) middleware.Responder

VolumeListHandlerFunc turns a function with the right signature into a volume list handler

func (VolumeListHandlerFunc) Handle

Handle executing the request and returning a response

type VolumeListInternalServerError

type VolumeListInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *models.ErrorResponse `json:"body,omitempty"`
}

VolumeListInternalServerError Server error

swagger:response volumeListInternalServerError

func NewVolumeListInternalServerError

func NewVolumeListInternalServerError() *VolumeListInternalServerError

NewVolumeListInternalServerError creates VolumeListInternalServerError with default headers values

func (*VolumeListInternalServerError) SetPayload

func (o *VolumeListInternalServerError) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the volume list internal server error response

func (*VolumeListInternalServerError) WithPayload

WithPayload adds the payload to the volume list internal server error response

func (*VolumeListInternalServerError) WriteResponse

func (o *VolumeListInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type VolumeListOK

type VolumeListOK struct {

	/*
	  In: Body
	*/
	Payload *VolumeListOKBody `json:"body,omitempty"`
}

VolumeListOK Summary volume data that matches the query

swagger:response volumeListOK

func NewVolumeListOK

func NewVolumeListOK() *VolumeListOK

NewVolumeListOK creates VolumeListOK with default headers values

func (*VolumeListOK) SetPayload

func (o *VolumeListOK) SetPayload(payload *VolumeListOKBody)

SetPayload sets the payload to the volume list o k response

func (*VolumeListOK) WithPayload

func (o *VolumeListOK) WithPayload(payload *VolumeListOKBody) *VolumeListOK

WithPayload adds the payload to the volume list o k response

func (*VolumeListOK) WriteResponse

func (o *VolumeListOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type VolumeListOKBody

type VolumeListOKBody struct {

	// List of volumes
	// Required: true
	Volumes []*models.Volume `json:"Volumes"`

	// Warnings that occurred when fetching the list of volumes.
	//
	// Required: true
	Warnings []string `json:"Warnings"`
}

VolumeListOKBody VolumeListResponse

Volume list response

swagger:model VolumeListOKBody

func (*VolumeListOKBody) ContextValidate

func (o *VolumeListOKBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this volume list o k body based on the context it is used

func (*VolumeListOKBody) MarshalBinary

func (o *VolumeListOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*VolumeListOKBody) UnmarshalBinary

func (o *VolumeListOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*VolumeListOKBody) Validate

func (o *VolumeListOKBody) Validate(formats strfmt.Registry) error

Validate validates this volume list o k body

type VolumeListParams

type VolumeListParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*JSON encoded value of the filters (a `map[string][]string`) to
	process on the volumes list. Available filters:

	- `dangling=<boolean>` When set to `true` (or `1`), returns all
	   volumes that are not in use by a container. When set to `false`
	   (or `0`), only volumes that are in use by one or more
	   containers are returned.
	- `driver=<volume-driver-name>` Matches volumes based on their driver.
	- `label=<key>` or `label=<key>:<value>` Matches volumes based on
	   the presence of a `label` alone or a `label` and a value.
	- `name=<volume-name>` Matches all or part of a volume name.

	  In: query
	*/
	Filters *string
}

VolumeListParams contains all the bound params for the volume list operation typically these are obtained from a http.Request

swagger:parameters VolumeList

func NewVolumeListParams

func NewVolumeListParams() VolumeListParams

NewVolumeListParams creates a new VolumeListParams object

There are no default values defined in the spec.

func (*VolumeListParams) BindRequest

func (o *VolumeListParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewVolumeListParams() beforehand.

type VolumeListURL

type VolumeListURL struct {
	Filters *string
	// contains filtered or unexported fields
}

VolumeListURL generates an URL for the volume list operation

func (*VolumeListURL) Build

func (o *VolumeListURL) Build() (*url.URL, error)

Build a url path and query string

func (*VolumeListURL) BuildFull

func (o *VolumeListURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*VolumeListURL) Must

func (o *VolumeListURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*VolumeListURL) SetBasePath

func (o *VolumeListURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*VolumeListURL) String

func (o *VolumeListURL) String() string

String returns the string representation of the path with query string

func (*VolumeListURL) StringFull

func (o *VolumeListURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*VolumeListURL) WithBasePath

func (o *VolumeListURL) WithBasePath(bp string) *VolumeListURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type VolumePrune

type VolumePrune struct {
	Context *middleware.Context
	Handler VolumePruneHandler
}
VolumePrune swagger:route POST /volumes/prune Volume volumePrune

Delete unused volumes

func NewVolumePrune

func NewVolumePrune(ctx *middleware.Context, handler VolumePruneHandler) *VolumePrune

NewVolumePrune creates a new http.Handler for the volume prune operation

func (*VolumePrune) ServeHTTP

func (o *VolumePrune) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type VolumePruneHandler

type VolumePruneHandler interface {
	Handle(VolumePruneParams) middleware.Responder
}

VolumePruneHandler interface for that can handle valid volume prune params

type VolumePruneHandlerFunc

type VolumePruneHandlerFunc func(VolumePruneParams) middleware.Responder

VolumePruneHandlerFunc turns a function with the right signature into a volume prune handler

func (VolumePruneHandlerFunc) Handle

Handle executing the request and returning a response

type VolumePruneInternalServerError

type VolumePruneInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *models.ErrorResponse `json:"body,omitempty"`
}

VolumePruneInternalServerError Server error

swagger:response volumePruneInternalServerError

func NewVolumePruneInternalServerError

func NewVolumePruneInternalServerError() *VolumePruneInternalServerError

NewVolumePruneInternalServerError creates VolumePruneInternalServerError with default headers values

func (*VolumePruneInternalServerError) SetPayload

func (o *VolumePruneInternalServerError) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the volume prune internal server error response

func (*VolumePruneInternalServerError) WithPayload

WithPayload adds the payload to the volume prune internal server error response

func (*VolumePruneInternalServerError) WriteResponse

func (o *VolumePruneInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type VolumePruneOK

type VolumePruneOK struct {

	/*
	  In: Body
	*/
	Payload *VolumePruneOKBody `json:"body,omitempty"`
}

VolumePruneOK No error

swagger:response volumePruneOK

func NewVolumePruneOK

func NewVolumePruneOK() *VolumePruneOK

NewVolumePruneOK creates VolumePruneOK with default headers values

func (*VolumePruneOK) SetPayload

func (o *VolumePruneOK) SetPayload(payload *VolumePruneOKBody)

SetPayload sets the payload to the volume prune o k response

func (*VolumePruneOK) WithPayload

func (o *VolumePruneOK) WithPayload(payload *VolumePruneOKBody) *VolumePruneOK

WithPayload adds the payload to the volume prune o k response

func (*VolumePruneOK) WriteResponse

func (o *VolumePruneOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type VolumePruneOKBody

type VolumePruneOKBody struct {

	// Disk space reclaimed in bytes
	SpaceReclaimed int64 `json:"SpaceReclaimed,omitempty"`

	// Volumes that were deleted
	VolumesDeleted []string `json:"VolumesDeleted"`
}

VolumePruneOKBody VolumePruneResponse

swagger:model VolumePruneOKBody

func (*VolumePruneOKBody) ContextValidate

func (o *VolumePruneOKBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this volume prune o k body based on context it is used

func (*VolumePruneOKBody) MarshalBinary

func (o *VolumePruneOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*VolumePruneOKBody) UnmarshalBinary

func (o *VolumePruneOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*VolumePruneOKBody) Validate

func (o *VolumePruneOKBody) Validate(formats strfmt.Registry) error

Validate validates this volume prune o k body

type VolumePruneParams

type VolumePruneParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*Filters to process on the prune list, encoded as JSON (a `map[string][]string`).

	Available filters:
	- `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune volumes with (or without, in case `label!=...` is used) the specified labels.

	  In: query
	*/
	Filters *string
}

VolumePruneParams contains all the bound params for the volume prune operation typically these are obtained from a http.Request

swagger:parameters VolumePrune

func NewVolumePruneParams

func NewVolumePruneParams() VolumePruneParams

NewVolumePruneParams creates a new VolumePruneParams object

There are no default values defined in the spec.

func (*VolumePruneParams) BindRequest

func (o *VolumePruneParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewVolumePruneParams() beforehand.

type VolumePruneURL

type VolumePruneURL struct {
	Filters *string
	// contains filtered or unexported fields
}

VolumePruneURL generates an URL for the volume prune operation

func (*VolumePruneURL) Build

func (o *VolumePruneURL) Build() (*url.URL, error)

Build a url path and query string

func (*VolumePruneURL) BuildFull

func (o *VolumePruneURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*VolumePruneURL) Must

func (o *VolumePruneURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*VolumePruneURL) SetBasePath

func (o *VolumePruneURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*VolumePruneURL) String

func (o *VolumePruneURL) String() string

String returns the string representation of the path with query string

func (*VolumePruneURL) StringFull

func (o *VolumePruneURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*VolumePruneURL) WithBasePath

func (o *VolumePruneURL) WithBasePath(bp string) *VolumePruneURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

Jump to

Keyboard shortcuts

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