volume

package
v0.0.0-...-193a162 Latest Latest
Warning

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

Go to latest
Published: Feb 11, 2018 License: MIT Imports: 11 Imported by: 1

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 New

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

New creates a new volume API client.

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) (*VolumeCreateCreated, error)

VolumeCreate creates a volume

func (*Client) VolumeDelete

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

VolumeDelete removes a volume

Instruct the driver to remove the volume.

func (*Client) VolumeInspect

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

VolumeInspect inspects a volume

func (*Client) VolumeList

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

VolumeList lists volumes

func (*Client) VolumePrune

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

VolumePrune deletes unused volumes

type VolumeCreateCreated

type VolumeCreateCreated struct {
	Payload *models.Volume
}

VolumeCreateCreated handles this case 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

type VolumeCreateInternalServerError

type VolumeCreateInternalServerError struct {
	Payload *models.ErrorResponse
}

VolumeCreateInternalServerError handles this case with default header values.

Server error

func NewVolumeCreateInternalServerError

func NewVolumeCreateInternalServerError() *VolumeCreateInternalServerError

NewVolumeCreateInternalServerError creates a VolumeCreateInternalServerError with default headers values

func (*VolumeCreateInternalServerError) Error

type VolumeCreateParams

type VolumeCreateParams struct {

	/*VolumeConfig
	  Volume configuration

	*/
	VolumeConfig *models.VolumeCreateParamsBody

	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 values initialized.

func NewVolumeCreateParamsWithContext

func NewVolumeCreateParamsWithContext(ctx context.Context) *VolumeCreateParams

NewVolumeCreateParamsWithContext creates a new VolumeCreateParams object with the default values initialized, and 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 default values initialized, and 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 default values initialized, and 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) 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 *models.VolumeCreateParamsBody)

SetVolumeConfig adds the volumeConfig to the volume create params

func (*VolumeCreateParams) WithContext

WithContext adds the context to the volume create params

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 *models.VolumeCreateParamsBody) *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 handles this case 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

type VolumeDeleteInternalServerError

type VolumeDeleteInternalServerError struct {
	Payload *models.ErrorResponse
}

VolumeDeleteInternalServerError handles this case with default header values.

Server error

func NewVolumeDeleteInternalServerError

func NewVolumeDeleteInternalServerError() *VolumeDeleteInternalServerError

NewVolumeDeleteInternalServerError creates a VolumeDeleteInternalServerError with default headers values

func (*VolumeDeleteInternalServerError) Error

type VolumeDeleteNoContent

type VolumeDeleteNoContent struct {
}

VolumeDeleteNoContent handles this case 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

type VolumeDeleteNotFound

type VolumeDeleteNotFound struct {
	Payload *models.ErrorResponse
}

VolumeDeleteNotFound handles this case 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

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 values initialized.

func NewVolumeDeleteParamsWithContext

func NewVolumeDeleteParamsWithContext(ctx context.Context) *VolumeDeleteParams

NewVolumeDeleteParamsWithContext creates a new VolumeDeleteParams object with the default values initialized, and 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 default values initialized, and 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 default values initialized, and 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) 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

WithContext adds the context to the volume delete params

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 handles this case with default header values.

Server error

func NewVolumeInspectInternalServerError

func NewVolumeInspectInternalServerError() *VolumeInspectInternalServerError

NewVolumeInspectInternalServerError creates a VolumeInspectInternalServerError with default headers values

func (*VolumeInspectInternalServerError) Error

type VolumeInspectNotFound

type VolumeInspectNotFound struct {
	Payload *models.ErrorResponse
}

VolumeInspectNotFound handles this case 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

type VolumeInspectOK

type VolumeInspectOK struct {
	Payload *models.Volume
}

VolumeInspectOK handles this case 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

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 values initialized.

func NewVolumeInspectParamsWithContext

func NewVolumeInspectParamsWithContext(ctx context.Context) *VolumeInspectParams

NewVolumeInspectParamsWithContext creates a new VolumeInspectParams object with the default values initialized, and 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 default values initialized, and 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 default values initialized, and 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) 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

WithContext adds the context to the volume inspect params

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 handles this case with default header values.

Server error

func NewVolumeListInternalServerError

func NewVolumeListInternalServerError() *VolumeListInternalServerError

NewVolumeListInternalServerError creates a VolumeListInternalServerError with default headers values

func (*VolumeListInternalServerError) Error

type VolumeListOK

type VolumeListOK struct {
	Payload *models.VolumeListOKBody
}

VolumeListOK handles this case 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

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.


	*/
	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 values initialized.

func NewVolumeListParamsWithContext

func NewVolumeListParamsWithContext(ctx context.Context) *VolumeListParams

NewVolumeListParamsWithContext creates a new VolumeListParams object with the default values initialized, and 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 default values initialized, and 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 default values initialized, and 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) 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) 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 handles this case with default header values.

Server error

func NewVolumePruneInternalServerError

func NewVolumePruneInternalServerError() *VolumePruneInternalServerError

NewVolumePruneInternalServerError creates a VolumePruneInternalServerError with default headers values

func (*VolumePruneInternalServerError) Error

type VolumePruneOK

type VolumePruneOK struct {
	Payload *models.VolumePruneOKBody
}

VolumePruneOK handles this case 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

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 values initialized.

func NewVolumePruneParamsWithContext

func NewVolumePruneParamsWithContext(ctx context.Context) *VolumePruneParams

NewVolumePruneParamsWithContext creates a new VolumePruneParams object with the default values initialized, and 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 default values initialized, and 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 default values initialized, and 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) 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) 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.

Jump to

Keyboard shortcuts

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