volume

package
v0.0.0-...-8251c7d Latest Latest
Warning

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

 Go to latest Published: Mar 10, 2022 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client for volume API

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

func (*Client) VolumeCreate 

func (a *Client) VolumeCreate(params *VolumeCreateParams, opts ...ClientOption) (*VolumeCreateCreated, error)

VolumeCreate creates a volume

func (*Client) VolumeDelete 

func (a *Client) VolumeDelete(params *VolumeDeleteParams, opts ...ClientOption) (*VolumeDeleteNoContent, error)

VolumeDelete removes a volume

Instruct the driver to remove the volume.

func (*Client) VolumeInspect 

func (a *Client) VolumeInspect(params *VolumeInspectParams, opts ...ClientOption) (*VolumeInspectOK, error)

VolumeInspect inspects a volume

func (*Client) VolumeList 

func (a *Client) VolumeList(params *VolumeListParams, opts ...ClientOption) (*VolumeListOK, error)

VolumeList lists volumes

func (*Client) VolumePrune 

func (a *Client) VolumePrune(params *VolumePruneParams, opts ...ClientOption) (*VolumePruneOK, error)

VolumePrune deletes unused volumes

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService 

type ClientService interface {
	VolumeCreate(params *VolumeCreateParams, opts ...ClientOption) (*VolumeCreateCreated, error)

	VolumeDelete(params *VolumeDeleteParams, opts ...ClientOption) (*VolumeDeleteNoContent, error)

	VolumeInspect(params *VolumeInspectParams, opts ...ClientOption) (*VolumeInspectOK, error)

	VolumeList(params *VolumeListParams, opts ...ClientOption) (*VolumeListOK, error)

	VolumePrune(params *VolumePruneParams, opts ...ClientOption) (*VolumePruneOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new volume API client.

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 {
	Payload *models.Volume
}
VolumeCreateCreated describes a response with status code 201, with default header values.

The volume was created successfully

func NewVolumeCreateCreated 

func NewVolumeCreateCreated() *VolumeCreateCreated

NewVolumeCreateCreated creates a VolumeCreateCreated with default headers values

func (*VolumeCreateCreated) Error 

func (o *VolumeCreateCreated) Error() string

func (*VolumeCreateCreated) GetPayload 

func (o *VolumeCreateCreated) GetPayload() *models.Volume

func (*VolumeCreateCreated) IsClientError 

func (o *VolumeCreateCreated) IsClientError() bool

IsClientError returns true when this volume create created response has a 4xx status code

func (*VolumeCreateCreated) IsCode 

func (o *VolumeCreateCreated) IsCode(code int) bool

IsCode returns true when this volume create created response a status code equal to that given

func (*VolumeCreateCreated) IsRedirect 

func (o *VolumeCreateCreated) IsRedirect() bool

IsRedirect returns true when this volume create created response has a 3xx status code

func (*VolumeCreateCreated) IsServerError 

func (o *VolumeCreateCreated) IsServerError() bool

IsServerError returns true when this volume create created response has a 5xx status code

func (*VolumeCreateCreated) IsSuccess 

func (o *VolumeCreateCreated) IsSuccess() bool

IsSuccess returns true when this volume create created response has a 2xx status code

func (*VolumeCreateCreated) String 

func (o *VolumeCreateCreated) String() string

type VolumeCreateInternalServerError 

type VolumeCreateInternalServerError struct {
	Payload *models.ErrorResponse
}
VolumeCreateInternalServerError describes a response with status code 500, with default header values.

Server error

func NewVolumeCreateInternalServerError 

func NewVolumeCreateInternalServerError() *VolumeCreateInternalServerError

NewVolumeCreateInternalServerError creates a VolumeCreateInternalServerError with default headers values

func (*VolumeCreateInternalServerError) Error 

func (o *VolumeCreateInternalServerError) Error() string

func (*VolumeCreateInternalServerError) GetPayload 

func (o *VolumeCreateInternalServerError) GetPayload() *models.ErrorResponse

func (*VolumeCreateInternalServerError) IsClientError 

func (o *VolumeCreateInternalServerError) IsClientError() bool

IsClientError returns true when this volume create internal server error response has a 4xx status code

func (*VolumeCreateInternalServerError) IsCode 

func (o *VolumeCreateInternalServerError) IsCode(code int) bool

IsCode returns true when this volume create internal server error response a status code equal to that given

func (*VolumeCreateInternalServerError) IsRedirect 

func (o *VolumeCreateInternalServerError) IsRedirect() bool

IsRedirect returns true when this volume create internal server error response has a 3xx status code

func (*VolumeCreateInternalServerError) IsServerError 

func (o *VolumeCreateInternalServerError) IsServerError() bool

IsServerError returns true when this volume create internal server error response has a 5xx status code

func (*VolumeCreateInternalServerError) IsSuccess 

func (o *VolumeCreateInternalServerError) IsSuccess() bool

IsSuccess returns true when this volume create internal server error response has a 2xx status code

func (*VolumeCreateInternalServerError) String 

func (o *VolumeCreateInternalServerError) String() string

type VolumeCreateParams 

type VolumeCreateParams struct {

	/* VolumeConfig.

	   Volume configuration
	*/
	VolumeConfig VolumeCreateBody

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

VolumeCreateParams contains all the parameters to send to the API endpoint 

for the volume create operation.

Typically these are written to a http.Request.

func NewVolumeCreateParams 

func NewVolumeCreateParams() *VolumeCreateParams

NewVolumeCreateParams creates a new VolumeCreateParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewVolumeCreateParamsWithContext 

func NewVolumeCreateParamsWithContext(ctx context.Context) *VolumeCreateParams

NewVolumeCreateParamsWithContext creates a new VolumeCreateParams object with the ability to set a context for a request.

func NewVolumeCreateParamsWithHTTPClient 

func NewVolumeCreateParamsWithHTTPClient(client *http.Client) *VolumeCreateParams

NewVolumeCreateParamsWithHTTPClient creates a new VolumeCreateParams object with the ability to set a custom HTTPClient for a request.

func NewVolumeCreateParamsWithTimeout 

func NewVolumeCreateParamsWithTimeout(timeout time.Duration) *VolumeCreateParams

NewVolumeCreateParamsWithTimeout creates a new VolumeCreateParams object with the ability to set a timeout on a request.

func (*VolumeCreateParams) SetContext 

func (o *VolumeCreateParams) SetContext(ctx context.Context)

SetContext adds the context to the volume create params

func (*VolumeCreateParams) SetDefaults 

func (o *VolumeCreateParams) SetDefaults()

SetDefaults hydrates default values in the volume create params (not the query body).

All values with no default are reset to their zero value.

func (*VolumeCreateParams) SetHTTPClient 

func (o *VolumeCreateParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the volume create params

func (*VolumeCreateParams) SetTimeout 

func (o *VolumeCreateParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the volume create params

func (*VolumeCreateParams) SetVolumeConfig 

func (o *VolumeCreateParams) SetVolumeConfig(volumeConfig VolumeCreateBody)

SetVolumeConfig adds the volumeConfig to the volume create params

func (*VolumeCreateParams) WithContext 

func (o *VolumeCreateParams) WithContext(ctx context.Context) *VolumeCreateParams

WithContext adds the context to the volume create params

func (*VolumeCreateParams) WithDefaults 

func (o *VolumeCreateParams) WithDefaults() *VolumeCreateParams

WithDefaults hydrates default values in the volume create params (not the query body).

All values with no default are reset to their zero value.

func (*VolumeCreateParams) WithHTTPClient 

func (o *VolumeCreateParams) WithHTTPClient(client *http.Client) *VolumeCreateParams

WithHTTPClient adds the HTTPClient to the volume create params

func (*VolumeCreateParams) WithTimeout 

func (o *VolumeCreateParams) WithTimeout(timeout time.Duration) *VolumeCreateParams

WithTimeout adds the timeout to the volume create params

func (*VolumeCreateParams) WithVolumeConfig 

func (o *VolumeCreateParams) WithVolumeConfig(volumeConfig VolumeCreateBody) *VolumeCreateParams

WithVolumeConfig adds the volumeConfig to the volume create params

func (*VolumeCreateParams) WriteToRequest 

func (o *VolumeCreateParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type VolumeCreateReader 

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

VolumeCreateReader is a Reader for the VolumeCreate structure.

func (*VolumeCreateReader) ReadResponse 

func (o *VolumeCreateReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type VolumeDeleteConflict 

type VolumeDeleteConflict struct {
	Payload *models.ErrorResponse
}
VolumeDeleteConflict describes a response with status code 409, with default header values.

Volume is in use and cannot be removed

func NewVolumeDeleteConflict 

func NewVolumeDeleteConflict() *VolumeDeleteConflict

NewVolumeDeleteConflict creates a VolumeDeleteConflict with default headers values

func (*VolumeDeleteConflict) Error 

func (o *VolumeDeleteConflict) Error() string

func (*VolumeDeleteConflict) GetPayload 

func (o *VolumeDeleteConflict) GetPayload() *models.ErrorResponse

func (*VolumeDeleteConflict) IsClientError 

func (o *VolumeDeleteConflict) IsClientError() bool

IsClientError returns true when this volume delete conflict response has a 4xx status code

func (*VolumeDeleteConflict) IsCode 

func (o *VolumeDeleteConflict) IsCode(code int) bool

IsCode returns true when this volume delete conflict response a status code equal to that given

func (*VolumeDeleteConflict) IsRedirect 

func (o *VolumeDeleteConflict) IsRedirect() bool

IsRedirect returns true when this volume delete conflict response has a 3xx status code

func (*VolumeDeleteConflict) IsServerError 

func (o *VolumeDeleteConflict) IsServerError() bool

IsServerError returns true when this volume delete conflict response has a 5xx status code

func (*VolumeDeleteConflict) IsSuccess 

func (o *VolumeDeleteConflict) IsSuccess() bool

IsSuccess returns true when this volume delete conflict response has a 2xx status code

func (*VolumeDeleteConflict) String 

func (o *VolumeDeleteConflict) String() string

type VolumeDeleteInternalServerError 

type VolumeDeleteInternalServerError struct {
	Payload *models.ErrorResponse
}
VolumeDeleteInternalServerError describes a response with status code 500, with default header values.

Server error

func NewVolumeDeleteInternalServerError 

func NewVolumeDeleteInternalServerError() *VolumeDeleteInternalServerError

NewVolumeDeleteInternalServerError creates a VolumeDeleteInternalServerError with default headers values

func (*VolumeDeleteInternalServerError) Error 

func (o *VolumeDeleteInternalServerError) Error() string

func (*VolumeDeleteInternalServerError) GetPayload 

func (o *VolumeDeleteInternalServerError) GetPayload() *models.ErrorResponse

func (*VolumeDeleteInternalServerError) IsClientError 

func (o *VolumeDeleteInternalServerError) IsClientError() bool

IsClientError returns true when this volume delete internal server error response has a 4xx status code

func (*VolumeDeleteInternalServerError) IsCode 

func (o *VolumeDeleteInternalServerError) IsCode(code int) bool

IsCode returns true when this volume delete internal server error response a status code equal to that given

func (*VolumeDeleteInternalServerError) IsRedirect 

func (o *VolumeDeleteInternalServerError) IsRedirect() bool

IsRedirect returns true when this volume delete internal server error response has a 3xx status code

func (*VolumeDeleteInternalServerError) IsServerError 

func (o *VolumeDeleteInternalServerError) IsServerError() bool

IsServerError returns true when this volume delete internal server error response has a 5xx status code

func (*VolumeDeleteInternalServerError) IsSuccess 

func (o *VolumeDeleteInternalServerError) IsSuccess() bool

IsSuccess returns true when this volume delete internal server error response has a 2xx status code

func (*VolumeDeleteInternalServerError) String 

func (o *VolumeDeleteInternalServerError) String() string

type VolumeDeleteNoContent 

type VolumeDeleteNoContent struct {
}
VolumeDeleteNoContent describes a response with status code 204, with default header values.

The volume was removed

func NewVolumeDeleteNoContent 

func NewVolumeDeleteNoContent() *VolumeDeleteNoContent

NewVolumeDeleteNoContent creates a VolumeDeleteNoContent with default headers values

func (*VolumeDeleteNoContent) Error 

func (o *VolumeDeleteNoContent) Error() string

func (*VolumeDeleteNoContent) IsClientError 

func (o *VolumeDeleteNoContent) IsClientError() bool

IsClientError returns true when this volume delete no content response has a 4xx status code

func (*VolumeDeleteNoContent) IsCode 

func (o *VolumeDeleteNoContent) IsCode(code int) bool

IsCode returns true when this volume delete no content response a status code equal to that given

func (*VolumeDeleteNoContent) IsRedirect 

func (o *VolumeDeleteNoContent) IsRedirect() bool

IsRedirect returns true when this volume delete no content response has a 3xx status code

func (*VolumeDeleteNoContent) IsServerError 

func (o *VolumeDeleteNoContent) IsServerError() bool

IsServerError returns true when this volume delete no content response has a 5xx status code

func (*VolumeDeleteNoContent) IsSuccess 

func (o *VolumeDeleteNoContent) IsSuccess() bool

IsSuccess returns true when this volume delete no content response has a 2xx status code

func (*VolumeDeleteNoContent) String 

func (o *VolumeDeleteNoContent) String() string

type VolumeDeleteNotFound 

type VolumeDeleteNotFound struct {
	Payload *models.ErrorResponse
}
VolumeDeleteNotFound describes a response with status code 404, with default header values.

No such volume or volume driver

func NewVolumeDeleteNotFound 

func NewVolumeDeleteNotFound() *VolumeDeleteNotFound

NewVolumeDeleteNotFound creates a VolumeDeleteNotFound with default headers values

func (*VolumeDeleteNotFound) Error 

func (o *VolumeDeleteNotFound) Error() string

func (*VolumeDeleteNotFound) GetPayload 

func (o *VolumeDeleteNotFound) GetPayload() *models.ErrorResponse

func (*VolumeDeleteNotFound) IsClientError 

func (o *VolumeDeleteNotFound) IsClientError() bool

IsClientError returns true when this volume delete not found response has a 4xx status code

func (*VolumeDeleteNotFound) IsCode 

func (o *VolumeDeleteNotFound) IsCode(code int) bool

IsCode returns true when this volume delete not found response a status code equal to that given

func (*VolumeDeleteNotFound) IsRedirect 

func (o *VolumeDeleteNotFound) IsRedirect() bool

IsRedirect returns true when this volume delete not found response has a 3xx status code

func (*VolumeDeleteNotFound) IsServerError 

func (o *VolumeDeleteNotFound) IsServerError() bool

IsServerError returns true when this volume delete not found response has a 5xx status code

func (*VolumeDeleteNotFound) IsSuccess 

func (o *VolumeDeleteNotFound) IsSuccess() bool

IsSuccess returns true when this volume delete not found response has a 2xx status code

func (*VolumeDeleteNotFound) String 

func (o *VolumeDeleteNotFound) String() string

type VolumeDeleteParams 

type VolumeDeleteParams struct {

	/* Force.

	   Force the removal of the volume
	*/
	Force *bool

	/* Name.

	   Volume name or ID
	*/
	Name string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

VolumeDeleteParams contains all the parameters to send to the API endpoint 

for the volume delete operation.

Typically these are written to a http.Request.

func NewVolumeDeleteParams 

func NewVolumeDeleteParams() *VolumeDeleteParams

NewVolumeDeleteParams creates a new VolumeDeleteParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewVolumeDeleteParamsWithContext 

func NewVolumeDeleteParamsWithContext(ctx context.Context) *VolumeDeleteParams

NewVolumeDeleteParamsWithContext creates a new VolumeDeleteParams object with the ability to set a context for a request.

func NewVolumeDeleteParamsWithHTTPClient 

func NewVolumeDeleteParamsWithHTTPClient(client *http.Client) *VolumeDeleteParams

NewVolumeDeleteParamsWithHTTPClient creates a new VolumeDeleteParams object with the ability to set a custom HTTPClient for a request.

func NewVolumeDeleteParamsWithTimeout 

func NewVolumeDeleteParamsWithTimeout(timeout time.Duration) *VolumeDeleteParams

NewVolumeDeleteParamsWithTimeout creates a new VolumeDeleteParams object with the ability to set a timeout on a request.

func (*VolumeDeleteParams) SetContext 

func (o *VolumeDeleteParams) SetContext(ctx context.Context)

SetContext adds the context to the volume delete params

func (*VolumeDeleteParams) SetDefaults 

func (o *VolumeDeleteParams) SetDefaults()

SetDefaults hydrates default values in the volume delete params (not the query body).

All values with no default are reset to their zero value.

func (*VolumeDeleteParams) SetForce 

func (o *VolumeDeleteParams) SetForce(force *bool)

SetForce adds the force to the volume delete params

func (*VolumeDeleteParams) SetHTTPClient 

func (o *VolumeDeleteParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the volume delete params

func (*VolumeDeleteParams) SetName 

func (o *VolumeDeleteParams) SetName(name string)

SetName adds the name to the volume delete params

func (*VolumeDeleteParams) SetTimeout 

func (o *VolumeDeleteParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the volume delete params

func (*VolumeDeleteParams) WithContext 

func (o *VolumeDeleteParams) WithContext(ctx context.Context) *VolumeDeleteParams

WithContext adds the context to the volume delete params

func (*VolumeDeleteParams) WithDefaults 

func (o *VolumeDeleteParams) WithDefaults() *VolumeDeleteParams

WithDefaults hydrates default values in the volume delete params (not the query body).

All values with no default are reset to their zero value.

func (*VolumeDeleteParams) WithForce 

func (o *VolumeDeleteParams) WithForce(force *bool) *VolumeDeleteParams

WithForce adds the force to the volume delete params

func (*VolumeDeleteParams) WithHTTPClient 

func (o *VolumeDeleteParams) WithHTTPClient(client *http.Client) *VolumeDeleteParams

WithHTTPClient adds the HTTPClient to the volume delete params

func (*VolumeDeleteParams) WithName 

func (o *VolumeDeleteParams) WithName(name string) *VolumeDeleteParams

WithName adds the name to the volume delete params

func (*VolumeDeleteParams) WithTimeout 

func (o *VolumeDeleteParams) WithTimeout(timeout time.Duration) *VolumeDeleteParams

WithTimeout adds the timeout to the volume delete params

func (*VolumeDeleteParams) WriteToRequest 

func (o *VolumeDeleteParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type VolumeDeleteReader 

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

VolumeDeleteReader is a Reader for the VolumeDelete structure.

func (*VolumeDeleteReader) ReadResponse 

func (o *VolumeDeleteReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type VolumeInspectInternalServerError 

type VolumeInspectInternalServerError struct {
	Payload *models.ErrorResponse
}
VolumeInspectInternalServerError describes a response with status code 500, with default header values.

Server error

func NewVolumeInspectInternalServerError 

func NewVolumeInspectInternalServerError() *VolumeInspectInternalServerError

NewVolumeInspectInternalServerError creates a VolumeInspectInternalServerError with default headers values

func (*VolumeInspectInternalServerError) Error 

func (o *VolumeInspectInternalServerError) Error() string

func (*VolumeInspectInternalServerError) GetPayload 

func (o *VolumeInspectInternalServerError) GetPayload() *models.ErrorResponse

func (*VolumeInspectInternalServerError) IsClientError 

func (o *VolumeInspectInternalServerError) IsClientError() bool

IsClientError returns true when this volume inspect internal server error response has a 4xx status code

func (*VolumeInspectInternalServerError) IsCode 

func (o *VolumeInspectInternalServerError) IsCode(code int) bool

IsCode returns true when this volume inspect internal server error response a status code equal to that given

func (*VolumeInspectInternalServerError) IsRedirect 

func (o *VolumeInspectInternalServerError) IsRedirect() bool

IsRedirect returns true when this volume inspect internal server error response has a 3xx status code

func (*VolumeInspectInternalServerError) IsServerError 

func (o *VolumeInspectInternalServerError) IsServerError() bool

IsServerError returns true when this volume inspect internal server error response has a 5xx status code

func (*VolumeInspectInternalServerError) IsSuccess 

func (o *VolumeInspectInternalServerError) IsSuccess() bool

IsSuccess returns true when this volume inspect internal server error response has a 2xx status code

func (*VolumeInspectInternalServerError) String 

func (o *VolumeInspectInternalServerError) String() string

type VolumeInspectNotFound 

type VolumeInspectNotFound struct {
	Payload *models.ErrorResponse
}
VolumeInspectNotFound describes a response with status code 404, with default header values.

No such volume

func NewVolumeInspectNotFound 

func NewVolumeInspectNotFound() *VolumeInspectNotFound

NewVolumeInspectNotFound creates a VolumeInspectNotFound with default headers values

func (*VolumeInspectNotFound) Error 

func (o *VolumeInspectNotFound) Error() string

func (*VolumeInspectNotFound) GetPayload 

func (o *VolumeInspectNotFound) GetPayload() *models.ErrorResponse

func (*VolumeInspectNotFound) IsClientError 

func (o *VolumeInspectNotFound) IsClientError() bool

IsClientError returns true when this volume inspect not found response has a 4xx status code

func (*VolumeInspectNotFound) IsCode 

func (o *VolumeInspectNotFound) IsCode(code int) bool

IsCode returns true when this volume inspect not found response a status code equal to that given

func (*VolumeInspectNotFound) IsRedirect 

func (o *VolumeInspectNotFound) IsRedirect() bool

IsRedirect returns true when this volume inspect not found response has a 3xx status code

func (*VolumeInspectNotFound) IsServerError 

func (o *VolumeInspectNotFound) IsServerError() bool

IsServerError returns true when this volume inspect not found response has a 5xx status code

func (*VolumeInspectNotFound) IsSuccess 

func (o *VolumeInspectNotFound) IsSuccess() bool

IsSuccess returns true when this volume inspect not found response has a 2xx status code

func (*VolumeInspectNotFound) String 

func (o *VolumeInspectNotFound) String() string

type VolumeInspectOK 

type VolumeInspectOK struct {
	Payload *models.Volume
}
VolumeInspectOK describes a response with status code 200, with default header values.

No error

func NewVolumeInspectOK 

func NewVolumeInspectOK() *VolumeInspectOK

NewVolumeInspectOK creates a VolumeInspectOK with default headers values

func (*VolumeInspectOK) Error 

func (o *VolumeInspectOK) Error() string

func (*VolumeInspectOK) GetPayload 

func (o *VolumeInspectOK) GetPayload() *models.Volume

func (*VolumeInspectOK) IsClientError 

func (o *VolumeInspectOK) IsClientError() bool

IsClientError returns true when this volume inspect o k response has a 4xx status code

func (*VolumeInspectOK) IsCode 

func (o *VolumeInspectOK) IsCode(code int) bool

IsCode returns true when this volume inspect o k response a status code equal to that given

func (*VolumeInspectOK) IsRedirect 

func (o *VolumeInspectOK) IsRedirect() bool

IsRedirect returns true when this volume inspect o k response has a 3xx status code

func (*VolumeInspectOK) IsServerError 

func (o *VolumeInspectOK) IsServerError() bool

IsServerError returns true when this volume inspect o k response has a 5xx status code

func (*VolumeInspectOK) IsSuccess 

func (o *VolumeInspectOK) IsSuccess() bool

IsSuccess returns true when this volume inspect o k response has a 2xx status code

func (*VolumeInspectOK) String 

func (o *VolumeInspectOK) String() string

type VolumeInspectParams 

type VolumeInspectParams struct {

	/* Name.

	   Volume name or ID
	*/
	Name string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

VolumeInspectParams contains all the parameters to send to the API endpoint 

for the volume inspect operation.

Typically these are written to a http.Request.

func NewVolumeInspectParams 

func NewVolumeInspectParams() *VolumeInspectParams

NewVolumeInspectParams creates a new VolumeInspectParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewVolumeInspectParamsWithContext 

func NewVolumeInspectParamsWithContext(ctx context.Context) *VolumeInspectParams

NewVolumeInspectParamsWithContext creates a new VolumeInspectParams object with the ability to set a context for a request.

func NewVolumeInspectParamsWithHTTPClient 

func NewVolumeInspectParamsWithHTTPClient(client *http.Client) *VolumeInspectParams

NewVolumeInspectParamsWithHTTPClient creates a new VolumeInspectParams object with the ability to set a custom HTTPClient for a request.

func NewVolumeInspectParamsWithTimeout 

func NewVolumeInspectParamsWithTimeout(timeout time.Duration) *VolumeInspectParams

NewVolumeInspectParamsWithTimeout creates a new VolumeInspectParams object with the ability to set a timeout on a request.

func (*VolumeInspectParams) SetContext 

func (o *VolumeInspectParams) SetContext(ctx context.Context)

SetContext adds the context to the volume inspect params

func (*VolumeInspectParams) SetDefaults 

func (o *VolumeInspectParams) SetDefaults()

SetDefaults hydrates default values in the volume inspect params (not the query body).

All values with no default are reset to their zero value.

func (*VolumeInspectParams) SetHTTPClient 

func (o *VolumeInspectParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the volume inspect params

func (*VolumeInspectParams) SetName 

func (o *VolumeInspectParams) SetName(name string)

SetName adds the name to the volume inspect params

func (*VolumeInspectParams) SetTimeout 

func (o *VolumeInspectParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the volume inspect params

func (*VolumeInspectParams) WithContext 

func (o *VolumeInspectParams) WithContext(ctx context.Context) *VolumeInspectParams

WithContext adds the context to the volume inspect params

func (*VolumeInspectParams) WithDefaults 

func (o *VolumeInspectParams) WithDefaults() *VolumeInspectParams

WithDefaults hydrates default values in the volume inspect params (not the query body).

All values with no default are reset to their zero value.

func (*VolumeInspectParams) WithHTTPClient 

func (o *VolumeInspectParams) WithHTTPClient(client *http.Client) *VolumeInspectParams

WithHTTPClient adds the HTTPClient to the volume inspect params

func (*VolumeInspectParams) WithName 

func (o *VolumeInspectParams) WithName(name string) *VolumeInspectParams

WithName adds the name to the volume inspect params

func (*VolumeInspectParams) WithTimeout 

func (o *VolumeInspectParams) WithTimeout(timeout time.Duration) *VolumeInspectParams

WithTimeout adds the timeout to the volume inspect params

func (*VolumeInspectParams) WriteToRequest 

func (o *VolumeInspectParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type VolumeInspectReader 

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

VolumeInspectReader is a Reader for the VolumeInspect structure.

func (*VolumeInspectReader) ReadResponse 

func (o *VolumeInspectReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type VolumeListInternalServerError 

type VolumeListInternalServerError struct {
	Payload *models.ErrorResponse
}
VolumeListInternalServerError describes a response with status code 500, with default header values.

Server error

func NewVolumeListInternalServerError 

func NewVolumeListInternalServerError() *VolumeListInternalServerError

NewVolumeListInternalServerError creates a VolumeListInternalServerError with default headers values

func (*VolumeListInternalServerError) Error 

func (o *VolumeListInternalServerError) Error() string

func (*VolumeListInternalServerError) GetPayload 

func (o *VolumeListInternalServerError) GetPayload() *models.ErrorResponse

func (*VolumeListInternalServerError) IsClientError 

func (o *VolumeListInternalServerError) IsClientError() bool

IsClientError returns true when this volume list internal server error response has a 4xx status code

func (*VolumeListInternalServerError) IsCode 

func (o *VolumeListInternalServerError) IsCode(code int) bool

IsCode returns true when this volume list internal server error response a status code equal to that given

func (*VolumeListInternalServerError) IsRedirect 

func (o *VolumeListInternalServerError) IsRedirect() bool

IsRedirect returns true when this volume list internal server error response has a 3xx status code

func (*VolumeListInternalServerError) IsServerError 

func (o *VolumeListInternalServerError) IsServerError() bool

IsServerError returns true when this volume list internal server error response has a 5xx status code

func (*VolumeListInternalServerError) IsSuccess 

func (o *VolumeListInternalServerError) IsSuccess() bool

IsSuccess returns true when this volume list internal server error response has a 2xx status code

func (*VolumeListInternalServerError) String 

func (o *VolumeListInternalServerError) String() string

type VolumeListOK 

type VolumeListOK struct {
	Payload *VolumeListOKBody
}
VolumeListOK describes a response with status code 200, with default header values.

Summary volume data that matches the query

func NewVolumeListOK 

func NewVolumeListOK() *VolumeListOK

NewVolumeListOK creates a VolumeListOK with default headers values

func (*VolumeListOK) Error 

func (o *VolumeListOK) Error() string

func (*VolumeListOK) GetPayload 

func (o *VolumeListOK) GetPayload() *VolumeListOKBody

func (*VolumeListOK) IsClientError 

func (o *VolumeListOK) IsClientError() bool

IsClientError returns true when this volume list o k response has a 4xx status code

func (*VolumeListOK) IsCode 

func (o *VolumeListOK) IsCode(code int) bool

IsCode returns true when this volume list o k response a status code equal to that given

func (*VolumeListOK) IsRedirect 

func (o *VolumeListOK) IsRedirect() bool

IsRedirect returns true when this volume list o k response has a 3xx status code

func (*VolumeListOK) IsServerError 

func (o *VolumeListOK) IsServerError() bool

IsServerError returns true when this volume list o k response has a 5xx status code

func (*VolumeListOK) IsSuccess 

func (o *VolumeListOK) IsSuccess() bool

IsSuccess returns true when this volume list o k response has a 2xx status code

func (*VolumeListOK) String 

func (o *VolumeListOK) String() string

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 {

	/* Filters.

	     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.


	     Format: json
	*/
	Filters *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

VolumeListParams contains all the parameters to send to the API endpoint 

for the volume list operation.

Typically these are written to a http.Request.

func NewVolumeListParams 

func NewVolumeListParams() *VolumeListParams

NewVolumeListParams creates a new VolumeListParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewVolumeListParamsWithContext 

func NewVolumeListParamsWithContext(ctx context.Context) *VolumeListParams

NewVolumeListParamsWithContext creates a new VolumeListParams object with the ability to set a context for a request.

func NewVolumeListParamsWithHTTPClient 

func NewVolumeListParamsWithHTTPClient(client *http.Client) *VolumeListParams

NewVolumeListParamsWithHTTPClient creates a new VolumeListParams object with the ability to set a custom HTTPClient for a request.

func NewVolumeListParamsWithTimeout 

func NewVolumeListParamsWithTimeout(timeout time.Duration) *VolumeListParams

NewVolumeListParamsWithTimeout creates a new VolumeListParams object with the ability to set a timeout on a request.

func (*VolumeListParams) SetContext 

func (o *VolumeListParams) SetContext(ctx context.Context)

SetContext adds the context to the volume list params

func (*VolumeListParams) SetDefaults 

func (o *VolumeListParams) SetDefaults()

SetDefaults hydrates default values in the volume list params (not the query body).

All values with no default are reset to their zero value.

func (*VolumeListParams) SetFilters 

func (o *VolumeListParams) SetFilters(filters *string)

SetFilters adds the filters to the volume list params

func (*VolumeListParams) SetHTTPClient 

func (o *VolumeListParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the volume list params

func (*VolumeListParams) SetTimeout 

func (o *VolumeListParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the volume list params

func (*VolumeListParams) WithContext 

func (o *VolumeListParams) WithContext(ctx context.Context) *VolumeListParams

WithContext adds the context to the volume list params

func (*VolumeListParams) WithDefaults 

func (o *VolumeListParams) WithDefaults() *VolumeListParams

WithDefaults hydrates default values in the volume list params (not the query body).

All values with no default are reset to their zero value.

func (*VolumeListParams) WithFilters 

func (o *VolumeListParams) WithFilters(filters *string) *VolumeListParams

WithFilters adds the filters to the volume list params

func (*VolumeListParams) WithHTTPClient 

func (o *VolumeListParams) WithHTTPClient(client *http.Client) *VolumeListParams

WithHTTPClient adds the HTTPClient to the volume list params

func (*VolumeListParams) WithTimeout 

func (o *VolumeListParams) WithTimeout(timeout time.Duration) *VolumeListParams

WithTimeout adds the timeout to the volume list params

func (*VolumeListParams) WriteToRequest 

func (o *VolumeListParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type VolumeListReader 

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

VolumeListReader is a Reader for the VolumeList structure.

func (*VolumeListReader) ReadResponse 

func (o *VolumeListReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type VolumePruneInternalServerError 

type VolumePruneInternalServerError struct {
	Payload *models.ErrorResponse
}
VolumePruneInternalServerError describes a response with status code 500, with default header values.

Server error

func NewVolumePruneInternalServerError 

func NewVolumePruneInternalServerError() *VolumePruneInternalServerError

NewVolumePruneInternalServerError creates a VolumePruneInternalServerError with default headers values

func (*VolumePruneInternalServerError) Error 

func (o *VolumePruneInternalServerError) Error() string

func (*VolumePruneInternalServerError) GetPayload 

func (o *VolumePruneInternalServerError) GetPayload() *models.ErrorResponse

func (*VolumePruneInternalServerError) IsClientError 

func (o *VolumePruneInternalServerError) IsClientError() bool

IsClientError returns true when this volume prune internal server error response has a 4xx status code

func (*VolumePruneInternalServerError) IsCode 

func (o *VolumePruneInternalServerError) IsCode(code int) bool

IsCode returns true when this volume prune internal server error response a status code equal to that given

func (*VolumePruneInternalServerError) IsRedirect 

func (o *VolumePruneInternalServerError) IsRedirect() bool

IsRedirect returns true when this volume prune internal server error response has a 3xx status code

func (*VolumePruneInternalServerError) IsServerError 

func (o *VolumePruneInternalServerError) IsServerError() bool

IsServerError returns true when this volume prune internal server error response has a 5xx status code

func (*VolumePruneInternalServerError) IsSuccess 

func (o *VolumePruneInternalServerError) IsSuccess() bool

IsSuccess returns true when this volume prune internal server error response has a 2xx status code

func (*VolumePruneInternalServerError) String 

func (o *VolumePruneInternalServerError) String() string

type VolumePruneOK 

type VolumePruneOK struct {
	Payload *VolumePruneOKBody
}
VolumePruneOK describes a response with status code 200, with default header values.

No error

func NewVolumePruneOK 

func NewVolumePruneOK() *VolumePruneOK

NewVolumePruneOK creates a VolumePruneOK with default headers values

func (*VolumePruneOK) Error 

func (o *VolumePruneOK) Error() string

func (*VolumePruneOK) GetPayload 

func (o *VolumePruneOK) GetPayload() *VolumePruneOKBody

func (*VolumePruneOK) IsClientError 

func (o *VolumePruneOK) IsClientError() bool

IsClientError returns true when this volume prune o k response has a 4xx status code

func (*VolumePruneOK) IsCode 

func (o *VolumePruneOK) IsCode(code int) bool

IsCode returns true when this volume prune o k response a status code equal to that given

func (*VolumePruneOK) IsRedirect 

func (o *VolumePruneOK) IsRedirect() bool

IsRedirect returns true when this volume prune o k response has a 3xx status code

func (*VolumePruneOK) IsServerError 

func (o *VolumePruneOK) IsServerError() bool

IsServerError returns true when this volume prune o k response has a 5xx status code

func (*VolumePruneOK) IsSuccess 

func (o *VolumePruneOK) IsSuccess() bool

IsSuccess returns true when this volume prune o k response has a 2xx status code

func (*VolumePruneOK) String 

func (o *VolumePruneOK) String() string

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 {

	/* Filters.

	     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.

	*/
	Filters *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

VolumePruneParams contains all the parameters to send to the API endpoint 

for the volume prune operation.

Typically these are written to a http.Request.

func NewVolumePruneParams 

func NewVolumePruneParams() *VolumePruneParams

NewVolumePruneParams creates a new VolumePruneParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewVolumePruneParamsWithContext 

func NewVolumePruneParamsWithContext(ctx context.Context) *VolumePruneParams

NewVolumePruneParamsWithContext creates a new VolumePruneParams object with the ability to set a context for a request.

func NewVolumePruneParamsWithHTTPClient 

func NewVolumePruneParamsWithHTTPClient(client *http.Client) *VolumePruneParams

NewVolumePruneParamsWithHTTPClient creates a new VolumePruneParams object with the ability to set a custom HTTPClient for a request.

func NewVolumePruneParamsWithTimeout 

func NewVolumePruneParamsWithTimeout(timeout time.Duration) *VolumePruneParams

NewVolumePruneParamsWithTimeout creates a new VolumePruneParams object with the ability to set a timeout on a request.

func (*VolumePruneParams) SetContext 

func (o *VolumePruneParams) SetContext(ctx context.Context)

SetContext adds the context to the volume prune params

func (*VolumePruneParams) SetDefaults 

func (o *VolumePruneParams) SetDefaults()

SetDefaults hydrates default values in the volume prune params (not the query body).

All values with no default are reset to their zero value.

func (*VolumePruneParams) SetFilters 

func (o *VolumePruneParams) SetFilters(filters *string)

SetFilters adds the filters to the volume prune params

func (*VolumePruneParams) SetHTTPClient 

func (o *VolumePruneParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the volume prune params

func (*VolumePruneParams) SetTimeout 

func (o *VolumePruneParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the volume prune params

func (*VolumePruneParams) WithContext 

func (o *VolumePruneParams) WithContext(ctx context.Context) *VolumePruneParams

WithContext adds the context to the volume prune params

func (*VolumePruneParams) WithDefaults 

func (o *VolumePruneParams) WithDefaults() *VolumePruneParams

WithDefaults hydrates default values in the volume prune params (not the query body).

All values with no default are reset to their zero value.

func (*VolumePruneParams) WithFilters 

func (o *VolumePruneParams) WithFilters(filters *string) *VolumePruneParams

WithFilters adds the filters to the volume prune params

func (*VolumePruneParams) WithHTTPClient 

func (o *VolumePruneParams) WithHTTPClient(client *http.Client) *VolumePruneParams

WithHTTPClient adds the HTTPClient to the volume prune params

func (*VolumePruneParams) WithTimeout 

func (o *VolumePruneParams) WithTimeout(timeout time.Duration) *VolumePruneParams

WithTimeout adds the timeout to the volume prune params

func (*VolumePruneParams) WriteToRequest 

func (o *VolumePruneParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type VolumePruneReader 

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

VolumePruneReader is a Reader for the VolumePrune structure.

func (*VolumePruneReader) ReadResponse 

func (o *VolumePruneReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.