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

Class VolumesCompatApi.APIvolumeDeleteRequest

java.lang.Object

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

Enclosing class:

VolumesCompatApi

public class VolumesCompatApi.APIvolumeDeleteRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for volumeDelete
void	execute()	Execute volumeDelete request
okhttp3.Call	executeAsync(ApiCallback<Void> _callback)	Execute volumeDelete request (asynchronously)
ApiResponse<Void>	executeWithHttpInfo()	Execute volumeDelete request with HTTP info returned
VolumesCompatApi.APIvolumeDeleteRequest	force(Boolean force)	Set force

Methods inherited from class java.lang.Object

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

Method Details

force

public VolumesCompatApi.APIvolumeDeleteRequest force(Boolean force)

Set force

Parameters:

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:

APIvolumeDeleteRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for volumeDelete

Parameters:

_callback - ApiCallback API callback

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	-

execute

public void execute()
             throws ApiException

Execute volumeDelete request

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	-

executeWithHttpInfo

public ApiResponse<Void> executeWithHttpInfo()
                                      throws ApiException

Execute volumeDelete request with HTTP info returned

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	-

executeAsync

public okhttp3.Call executeAsync(ApiCallback<Void> _callback)
                          throws ApiException

Execute volumeDelete request (asynchronously)

Parameters:

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