Package io.github.alersrt.pod4j.openapi.api

Class VolumesCompatApi

java.lang.Object

io.github.alersrt.pod4j.openapi.api.VolumesCompatApi

public class VolumesCompatApi
extends Object

Constructor Summary

Constructors

Constructor	Description
VolumesCompatApi()
VolumesCompatApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
Volume	volumeCreate(VolumeCreate create)	Create a volume
okhttp3.Call	volumeCreateAsync(VolumeCreate create, ApiCallback<Volume> _callback)	Create a volume (asynchronously)
okhttp3.Call	volumeCreateCall(VolumeCreate create, ApiCallback _callback)	Build call for volumeCreate
ApiResponse<Volume>	volumeCreateWithHttpInfo(VolumeCreate create)	Create a volume
void	volumeDelete(String name, Boolean force)	Remove volume
okhttp3.Call	volumeDeleteAsync(String name, Boolean force, ApiCallback<Void> _callback)	Remove volume (asynchronously)
okhttp3.Call	volumeDeleteCall(String name, Boolean force, ApiCallback _callback)	Build call for volumeDelete
ApiResponse<Void>	volumeDeleteWithHttpInfo(@NotNull String name, Boolean force)	Remove volume
Volume	volumeInspect(String name)	Inspect volume
okhttp3.Call	volumeInspectAsync(String name, ApiCallback<Volume> _callback)	Inspect volume (asynchronously)
okhttp3.Call	volumeInspectCall(String name, ApiCallback _callback)	Build call for volumeInspect
ApiResponse<Volume>	volumeInspectWithHttpInfo(@NotNull String name)	Inspect volume
ListResponse	volumeList(String filters)	List volumes Returns a list of volume
okhttp3.Call	volumeListAsync(String filters, ApiCallback<ListResponse> _callback)	List volumes (asynchronously) Returns a list of volume
okhttp3.Call	volumeListCall(String filters, ApiCallback _callback)	Build call for volumeList
ApiResponse<ListResponse>	volumeListWithHttpInfo(String filters)	List volumes Returns a list of volume
PruneReport	volumePrune(String filters)	Prune volumes
okhttp3.Call	volumePruneAsync(String filters, ApiCallback<PruneReport> _callback)	Prune volumes (asynchronously)
okhttp3.Call	volumePruneCall(String filters, ApiCallback _callback)	Build call for volumePrune
ApiResponse<PruneReport>	volumePruneWithHttpInfo(String filters)	Prune volumes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VolumesCompatApi

public VolumesCompatApi()

VolumesCompatApi

public VolumesCompatApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

volumeCreateCall

public okhttp3.Call volumeCreateCall(VolumeCreate create,
 ApiCallback _callback)
                              throws ApiException

Build call for volumeCreate

Parameters:

create - attributes for creating a volume. Note: If a volume by the same name exists, a 201 response with that volume's information will be generated. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
201	This response definition is used for both the create and inspect endpoints	-
500	Internal server error	-

volumeCreate

public Volume volumeCreate(VolumeCreate create)
                    throws ApiException

Create a volume

Parameters:

create - attributes for creating a volume. Note: If a volume by the same name exists, a 201 response with that volume's information will be generated. (optional)

Returns:

Volume

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
201	This response definition is used for both the create and inspect endpoints	-
500	Internal server error	-

volumeCreateWithHttpInfo

public ApiResponse<Volume> volumeCreateWithHttpInfo(VolumeCreate create)
                                             throws ApiException

Create a volume

Parameters:

create - attributes for creating a volume. Note: If a volume by the same name exists, a 201 response with that volume's information will be generated. (optional)

Returns:

ApiResponse<Volume>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
201	This response definition is used for both the create and inspect endpoints	-
500	Internal server error	-

volumeCreateAsync

public okhttp3.Call volumeCreateAsync(VolumeCreate create,
 ApiCallback<Volume> _callback)
                               throws ApiException

Create a volume (asynchronously)

Parameters:

create - attributes for creating a volume. Note: If a volume by the same name exists, a 201 response with that volume's information will be generated. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
201	This response definition is used for both the create and inspect endpoints	-
500	Internal server error	-

volumeDeleteCall

public okhttp3.Call volumeDeleteCall(String name,
 Boolean force,
 ApiCallback _callback)
                              throws ApiException

Build call for volumeDelete

Parameters:

name - the name or ID of the volume (required)

force - Force removal of the volume. This actually only causes errors due to the names volume not being found to be suppressed, which is the behaviour Docker implements. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
204	no error	-
404	No such volume	-
409	Volume is in use and cannot be removed	-
500	Internal server error	-

volumeDelete

public void volumeDelete(String name,
 Boolean force)
                  throws ApiException

Remove volume

Parameters:

name - the name or ID of the volume (required)

force - Force removal of the volume. This actually only causes errors due to the names volume not being found to be suppressed, which is the behaviour Docker implements. (optional)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
204	no error	-
404	No such volume	-
409	Volume is in use and cannot be removed	-
500	Internal server error	-

volumeDeleteWithHttpInfo

public ApiResponse<Void> volumeDeleteWithHttpInfo(@NotNull
 @NotNull String name,
 Boolean force)
                                           throws ApiException

Remove volume

Parameters:

name - the name or ID of the volume (required)

force - Force removal of the volume. This actually only causes errors due to the names volume not being found to be suppressed, which is the behaviour Docker implements. (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
204	no error	-
404	No such volume	-
409	Volume is in use and cannot be removed	-
500	Internal server error	-

volumeDeleteAsync

public okhttp3.Call volumeDeleteAsync(String name,
 Boolean force,
 ApiCallback<Void> _callback)
                               throws ApiException

Remove volume (asynchronously)

Parameters:

name - the name or ID of the volume (required)

force - Force removal of the volume. This actually only causes errors due to the names volume not being found to be suppressed, which is the behaviour Docker implements. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
204	no error	-
404	No such volume	-
409	Volume is in use and cannot be removed	-
500	Internal server error	-

volumeInspectCall

public okhttp3.Call volumeInspectCall(String name,
 ApiCallback _callback)
                               throws ApiException

Build call for volumeInspect

Parameters:

name - the name or ID of the volume (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	This response definition is used for both the create and inspect endpoints	-
500	Internal server error	-

volumeInspect

public Volume volumeInspect(String name)
                     throws ApiException

Inspect volume

Parameters:

name - the name or ID of the volume (required)

Returns:

Volume

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	This response definition is used for both the create and inspect endpoints	-
500	Internal server error	-

volumeInspectWithHttpInfo

public ApiResponse<Volume> volumeInspectWithHttpInfo(@NotNull
 @NotNull String name)
                                              throws ApiException

Inspect volume

Parameters:

name - the name or ID of the volume (required)

Returns:

ApiResponse<Volume>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	This response definition is used for both the create and inspect endpoints	-
500	Internal server error	-

volumeInspectAsync

public okhttp3.Call volumeInspectAsync(String name,
 ApiCallback<Volume> _callback)
                                throws ApiException

Inspect volume (asynchronously)

Parameters:

name - the name or ID of the volume (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	This response definition is used for both the create and inspect endpoints	-
500	Internal server error	-

volumeListCall

public okhttp3.Call volumeListCall(String filters,
 ApiCallback _callback)
                            throws ApiException

Build call for volumeList

Parameters:

filters - JSON encoded value of the filters (a map[string][]string) to process on the volumes list. Available filters: - 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 of volume name. - `until=<timestamp>` List volumes created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. Note: The boolean `dangling` filter is not yet implemented for this endpoint. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	Volume List	-
500	Internal server error	-

volumeList

public ListResponse volumeList(String filters)
                        throws ApiException

List volumes Returns a list of volume

Parameters:

filters - JSON encoded value of the filters (a map[string][]string) to process on the volumes list. Available filters: - 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 of volume name. - `until=<timestamp>` List volumes created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. Note: The boolean `dangling` filter is not yet implemented for this endpoint. (optional)

Returns:

ListResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	Volume List	-
500	Internal server error	-

volumeListWithHttpInfo

public ApiResponse<ListResponse> volumeListWithHttpInfo(String filters)
                                                 throws ApiException

List volumes Returns a list of volume

Parameters:

filters - JSON encoded value of the filters (a map[string][]string) to process on the volumes list. Available filters: - 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 of volume name. - `until=<timestamp>` List volumes created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. Note: The boolean `dangling` filter is not yet implemented for this endpoint. (optional)

Returns:

ApiResponse<ListResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	Volume List	-
500	Internal server error	-

volumeListAsync

public okhttp3.Call volumeListAsync(String filters,
 ApiCallback<ListResponse> _callback)
                             throws ApiException

List volumes (asynchronously) Returns a list of volume

Parameters:

filters - JSON encoded value of the filters (a map[string][]string) to process on the volumes list. Available filters: - 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 of volume name. - `until=<timestamp>` List volumes created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. Note: The boolean `dangling` filter is not yet implemented for this endpoint. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	Volume List	-
500	Internal server error	-

volumePruneCall

public okhttp3.Call volumePruneCall(String filters,
 ApiCallback _callback)
                             throws ApiException

Build call for volumePrune

Parameters:

filters - JSON encoded value of filters (a map[string][]string) to match volumes against before pruning. Available filters: - `until=<timestamp>` Prune volumes created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. - `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. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	Volume prune	-
500	Internal server error	-

volumePrune

public PruneReport volumePrune(String filters)
                        throws ApiException

Prune volumes

Parameters:

filters - JSON encoded value of filters (a map[string][]string) to match volumes against before pruning. Available filters: - `until=<timestamp>` Prune volumes created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. - `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. (optional)

Returns:

PruneReport

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	Volume prune	-
500	Internal server error	-

volumePruneWithHttpInfo

public ApiResponse<PruneReport> volumePruneWithHttpInfo(String filters)
                                                 throws ApiException

Prune volumes

Parameters:

filters - JSON encoded value of filters (a map[string][]string) to match volumes against before pruning. Available filters: - `until=<timestamp>` Prune volumes created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. - `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. (optional)

Returns:

ApiResponse<PruneReport>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	Volume prune	-
500	Internal server error	-

volumePruneAsync

public okhttp3.Call volumePruneAsync(String filters,
 ApiCallback<PruneReport> _callback)
                              throws ApiException

Prune volumes (asynchronously)

Parameters:

filters - JSON encoded value of filters (a map[string][]string) to match volumes against before pruning. Available filters: - `until=<timestamp>` Prune volumes created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. - `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. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	Volume prune	-
500	Internal server error	-