Class ContainersCompatApi.APIcontainerDeleteRequest
java.lang.Object
io.github.alersrt.pod4j.openapi.api.ContainersCompatApi.APIcontainerDeleteRequest
- Enclosing class:
- ContainersCompatApi
-
Method Summary
Modifier and TypeMethodDescriptionokhttp3.CallbuildCall(ApiCallback _callback) Build call for containerDeletevoidexecute()Execute containerDelete requestokhttp3.CallexecuteAsync(ApiCallback<Void> _callback) Execute containerDelete request (asynchronously)Execute containerDelete request with HTTP info returnedSet forceSet linkSet v
-
Method Details
-
force
Set force- Parameters:
force- If the container is running, kill it before removing it. (optional, default to false)- Returns:
- APIcontainerDeleteRequest
-
v
Set v- Parameters:
v- Remove the volumes associated with the container. (optional, default to false)- Returns:
- APIcontainerDeleteRequest
-
link
Set link- Parameters:
link- not supported (optional)- Returns:
- APIcontainerDeleteRequest
-
buildCall
Build call for containerDelete- 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 - 400 Bad parameter in request - 404 No such container - 409 Conflict error in operation - 500 Internal server error -
-
execute
Execute containerDelete 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 - 400 Bad parameter in request - 404 No such container - 409 Conflict error in operation - 500 Internal server error -
-
executeWithHttpInfo
Execute containerDelete 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 - 400 Bad parameter in request - 404 No such container - 409 Conflict error in operation - 500 Internal server error -
-
executeAsync
Execute containerDelete 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 - 400 Bad parameter in request - 404 No such container - 409 Conflict error in operation - 500 Internal server error -
-