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

Class VolumesApi

java.lang.Object

io.github.alersrt.pod4j.openapi.api.VolumesApi

public class VolumesApi
extends Object

Constructor Summary

Constructors

Constructor	Description
VolumesApi()
VolumesApi(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)
VolumeConfigResponse	volumeCreateLibpod(VolumeCreateOptions create)	Create a volume
okhttp3.Call	volumeCreateLibpodAsync(VolumeCreateOptions create, ApiCallback<VolumeConfigResponse> _callback)	Create a volume (asynchronously)
okhttp3.Call	volumeCreateLibpodCall(VolumeCreateOptions create, ApiCallback _callback)	Build call for volumeCreateLibpod
ApiResponse<VolumeConfigResponse>	volumeCreateLibpodWithHttpInfo(VolumeCreateOptions create)	Create a volume
void	volumeDeleteLibpod(String name, Boolean force)	Remove volume
okhttp3.Call	volumeDeleteLibpodAsync(String name, Boolean force, ApiCallback<Void> _callback)	Remove volume (asynchronously)
okhttp3.Call	volumeDeleteLibpodCall(String name, Boolean force, ApiCallback _callback)	Build call for volumeDeleteLibpod
ApiResponse<Void>	volumeDeleteLibpodWithHttpInfo(@NotNull String name, Boolean force)	Remove volume
void	volumeExistsLibpod(String name)	Volume exists Check if a volume exists
okhttp3.Call	volumeExistsLibpodAsync(String name, ApiCallback<Void> _callback)	Volume exists (asynchronously) Check if a volume exists
okhttp3.Call	volumeExistsLibpodCall(String name, ApiCallback _callback)	Build call for volumeExistsLibpod
ApiResponse<Void>	volumeExistsLibpodWithHttpInfo(@NotNull String name)	Volume exists Check if a volume exists
VolumeConfigResponse	volumeInspectLibpod(String name)	Inspect volume
okhttp3.Call	volumeInspectLibpodAsync(String name, ApiCallback<VolumeConfigResponse> _callback)	Inspect volume (asynchronously)
okhttp3.Call	volumeInspectLibpodCall(String name, ApiCallback _callback)	Build call for volumeInspectLibpod
ApiResponse<VolumeConfigResponse>	volumeInspectLibpodWithHttpInfo(@NotNull String name)	Inspect volume
List<VolumeConfigResponse>	volumeListLibpod(String filters)	List volumes Returns a list of volumes
okhttp3.Call	volumeListLibpodAsync(String filters, ApiCallback<List<VolumeConfigResponse>> _callback)	List volumes (asynchronously) Returns a list of volumes
okhttp3.Call	volumeListLibpodCall(String filters, ApiCallback _callback)	Build call for volumeListLibpod
ApiResponse<List<VolumeConfigResponse>>	volumeListLibpodWithHttpInfo(String filters)	List volumes Returns a list of volumes
List<PruneReport>	volumePruneLibpod(String filters)	Prune volumes
okhttp3.Call	volumePruneLibpodAsync(String filters, ApiCallback<List<PruneReport>> _callback)	Prune volumes (asynchronously)
okhttp3.Call	volumePruneLibpodCall(String filters, ApiCallback _callback)	Build call for volumePruneLibpod
ApiResponse<List<PruneReport>>	volumePruneLibpodWithHttpInfo(String filters)	Prune volumes

Methods inherited from class java.lang.Object

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

Constructor Details

VolumesApi

public VolumesApi()

VolumesApi

public VolumesApi(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)

volumeCreateLibpodCall

public okhttp3.Call volumeCreateLibpodCall(VolumeCreateOptions create,
 ApiCallback _callback)
                                    throws ApiException

Build call for volumeCreateLibpod

Parameters:

create - attributes for creating a volume (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	Volume details	-
500	Internal server error	-

volumeCreateLibpod

public VolumeConfigResponse volumeCreateLibpod(VolumeCreateOptions create)
                                        throws ApiException

Create a volume

Parameters:

create - attributes for creating a volume (optional)

Returns:

VolumeConfigResponse

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	Volume details	-
500	Internal server error	-

volumeCreateLibpodWithHttpInfo

public ApiResponse<VolumeConfigResponse> volumeCreateLibpodWithHttpInfo(VolumeCreateOptions create)
                                                                 throws ApiException

Create a volume

Parameters:

create - attributes for creating a volume (optional)

Returns:

ApiResponse<VolumeConfigResponse>

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	Volume details	-
500	Internal server error	-

volumeCreateLibpodAsync

public okhttp3.Call volumeCreateLibpodAsync(VolumeCreateOptions create,
 ApiCallback<VolumeConfigResponse> _callback)
                                     throws ApiException

Create a volume (asynchronously)

Parameters:

create - attributes for creating a volume (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	Volume details	-
500	Internal server error	-

volumeDeleteLibpodCall

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

Build call for volumeDeleteLibpod

Parameters:

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

force - force removal (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	-

volumeDeleteLibpod

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

Remove volume

Parameters:

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

force - force removal (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	-

volumeDeleteLibpodWithHttpInfo

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

Remove volume

Parameters:

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

force - force removal (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	-

volumeDeleteLibpodAsync

public okhttp3.Call volumeDeleteLibpodAsync(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 (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	-

volumeExistsLibpodCall

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

Build call for volumeExistsLibpod

Parameters:

name - the name 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
204	volume exists	-
404	No such volume	-
500	Internal server error	-

volumeExistsLibpod

public void volumeExistsLibpod(String name)
                        throws ApiException

Volume exists Check if a volume exists

Parameters:

name - the name of the volume (required)

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	volume exists	-
404	No such volume	-
500	Internal server error	-

volumeExistsLibpodWithHttpInfo

public ApiResponse<Void> volumeExistsLibpodWithHttpInfo(@NotNull
 @NotNull String name)
                                                 throws ApiException

Volume exists Check if a volume exists

Parameters:

name - the name of the volume (required)

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	volume exists	-
404	No such volume	-
500	Internal server error	-

volumeExistsLibpodAsync

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

Volume exists (asynchronously) Check if a volume exists

Parameters:

name - the name 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
204	volume exists	-
404	No such volume	-
500	Internal server error	-

volumeInspectLibpodCall

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

Build call for volumeInspectLibpod

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	Volume details	-
404	No such volume	-
500	Internal server error	-

volumeInspectLibpod

public VolumeConfigResponse volumeInspectLibpod(String name)
                                         throws ApiException

Inspect volume

Parameters:

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

Returns:

VolumeConfigResponse

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 details	-
404	No such volume	-
500	Internal server error	-

volumeInspectLibpodWithHttpInfo

public ApiResponse<VolumeConfigResponse> volumeInspectLibpodWithHttpInfo(@NotNull
 @NotNull String name)
                                                                  throws ApiException

Inspect volume

Parameters:

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

Returns:

ApiResponse<VolumeConfigResponse>

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 details	-
404	No such volume	-
500	Internal server error	-

volumeInspectLibpodAsync

public okhttp3.Call volumeInspectLibpodAsync(String name,
 ApiCallback<VolumeConfigResponse> _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	Volume details	-
404	No such volume	-
500	Internal server error	-

volumeListLibpodCall

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

Build call for volumeListLibpod

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. - opt=<driver-option> Matches a storage driver options - `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. (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	-

volumeListLibpod

public List<VolumeConfigResponse> volumeListLibpod(String filters)
                                            throws ApiException

List volumes Returns a list of volumes

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. - opt=<driver-option> Matches a storage driver options - `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. (optional)

Returns:

List<VolumeConfigResponse>

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	-

volumeListLibpodWithHttpInfo

public ApiResponse<List<VolumeConfigResponse>> volumeListLibpodWithHttpInfo(String filters)
                                                                     throws ApiException

List volumes Returns a list of volumes

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. - opt=<driver-option> Matches a storage driver options - `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. (optional)

Returns:

ApiResponse<List<VolumeConfigResponse>>

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	-

volumeListLibpodAsync

public okhttp3.Call volumeListLibpodAsync(String filters,
 ApiCallback<List<VolumeConfigResponse>> _callback)
                                   throws ApiException

List volumes (asynchronously) Returns a list of volumes

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. - opt=<driver-option> Matches a storage driver options - `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. (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	-

volumePruneLibpodCall

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

Build call for volumePruneLibpod

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	-

volumePruneLibpod

public List<PruneReport> volumePruneLibpod(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:

List<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	-

volumePruneLibpodWithHttpInfo

public ApiResponse<List<PruneReport>> volumePruneLibpodWithHttpInfo(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<List<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	-

volumePruneLibpodAsync

public okhttp3.Call volumePruneLibpodAsync(String filters,
 ApiCallback<List<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	-