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

Class ExecCompatApi

java.lang.Object

io.github.alersrt.pod4j.openapi.api.ExecCompatApi

public class ExecCompatApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ExecCompatApi()
ExecCompatApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	containerExec(String name, ContainerExecRequest control)	Create an exec instance Create an exec session to run a command inside a running container.
okhttp3.Call	containerExecAsync(String name, ContainerExecRequest control, ApiCallback<Void> _callback)	Create an exec instance (asynchronously) Create an exec session to run a command inside a running container.
okhttp3.Call	containerExecCall(String name, ContainerExecRequest control, ApiCallback _callback)	Build call for containerExec
ApiResponse<Void>	containerExecWithHttpInfo(@NotNull String name, ContainerExecRequest control)	Create an exec instance Create an exec session to run a command inside a running container.
InspectExecSession	execInspect(String id)	Inspect an exec instance Return low-level information about an exec instance.
okhttp3.Call	execInspectAsync(String id, ApiCallback<InspectExecSession> _callback)	Inspect an exec instance (asynchronously) Return low-level information about an exec instance.
okhttp3.Call	execInspectCall(String id, ApiCallback _callback)	Build call for execInspect
ApiResponse<InspectExecSession>	execInspectWithHttpInfo(@NotNull String id)	Inspect an exec instance Return low-level information about an exec instance.
void	execResize(String id, Integer h, Integer w, Boolean running)	Resize an exec instance Resize the TTY session used by an exec instance.
okhttp3.Call	execResizeAsync(String id, Integer h, Integer w, Boolean running, ApiCallback<Void> _callback)	Resize an exec instance (asynchronously) Resize the TTY session used by an exec instance.
okhttp3.Call	execResizeCall(String id, Integer h, Integer w, Boolean running, ApiCallback _callback)	Build call for execResize
ApiResponse<Void>	execResizeWithHttpInfo(@NotNull String id, Integer h, Integer w, Boolean running)	Resize an exec instance Resize the TTY session used by an exec instance.
void	execStart(String id, ExecStartRequest control)	Start an exec instance Starts a previously set up exec instance.
okhttp3.Call	execStartAsync(String id, ExecStartRequest control, ApiCallback<Void> _callback)	Start an exec instance (asynchronously) Starts a previously set up exec instance.
okhttp3.Call	execStartCall(String id, ExecStartRequest control, ApiCallback _callback)	Build call for execStart
ApiResponse<Void>	execStartWithHttpInfo(@NotNull String id, ExecStartRequest control)	Start an exec instance Starts a previously set up exec instance.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Details

ExecCompatApi

public ExecCompatApi()

ExecCompatApi

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

containerExecCall

public okhttp3.Call containerExecCall(String name,
 ContainerExecRequest control,
 ApiCallback _callback)
                               throws ApiException

Build call for containerExec

Parameters:

name - name of container (required)

control - Attributes for create (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	no error	-
404	No such container	-
409	container is paused	-
500	Internal server error	-

containerExec

public void containerExec(String name,
 ContainerExecRequest control)
                   throws ApiException

Create an exec instance Create an exec session to run a command inside a running container. Exec sessions will be automatically removed 5 minutes after they exit.

Parameters:

name - name of container (required)

control - Attributes for create (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
201	no error	-
404	No such container	-
409	container is paused	-
500	Internal server error	-

containerExecWithHttpInfo

public ApiResponse<Void> containerExecWithHttpInfo(@NotNull
 @NotNull String name,
 ContainerExecRequest control)
                                            throws ApiException

Create an exec instance Create an exec session to run a command inside a running container. Exec sessions will be automatically removed 5 minutes after they exit.

Parameters:

name - name of container (required)

control - Attributes for create (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
201	no error	-
404	No such container	-
409	container is paused	-
500	Internal server error	-

containerExecAsync

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

Create an exec instance (asynchronously) Create an exec session to run a command inside a running container. Exec sessions will be automatically removed 5 minutes after they exit.

Parameters:

name - name of container (required)

control - Attributes for create (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	no error	-
404	No such container	-
409	container is paused	-
500	Internal server error	-

execInspectCall

public okhttp3.Call execInspectCall(String id,
 ApiCallback _callback)
                             throws ApiException

Build call for execInspect

Parameters:

id - Exec instance ID (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	Exec Session Inspect	-
404	No such exec instance	-
500	Internal server error	-

execInspect

public InspectExecSession execInspect(String id)
                               throws ApiException

Inspect an exec instance Return low-level information about an exec instance.

Parameters:

id - Exec instance ID (required)

Returns:

InspectExecSession

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	Exec Session Inspect	-
404	No such exec instance	-
500	Internal server error	-

execInspectWithHttpInfo

public ApiResponse<InspectExecSession> execInspectWithHttpInfo(@NotNull
 @NotNull String id)
                                                        throws ApiException

Inspect an exec instance Return low-level information about an exec instance.

Parameters:

id - Exec instance ID (required)

Returns:

ApiResponse<InspectExecSession>

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	Exec Session Inspect	-
404	No such exec instance	-
500	Internal server error	-

execInspectAsync

public okhttp3.Call execInspectAsync(String id,
 ApiCallback<InspectExecSession> _callback)
                              throws ApiException

Inspect an exec instance (asynchronously) Return low-level information about an exec instance.

Parameters:

id - Exec instance ID (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	Exec Session Inspect	-
404	No such exec instance	-
500	Internal server error	-

execResizeCall

public okhttp3.Call execResizeCall(String id,
 Integer h,
 Integer w,
 Boolean running,
 ApiCallback _callback)
                            throws ApiException

Build call for execResize

Parameters:

id - Exec instance ID (required)

h - Height of the TTY session in characters (optional)

w - Width of the TTY session in characters (optional)

running - Ignore containers not running errors (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	no error	-
404	No such exec instance	-
500	Internal server error	-

execResize

public void execResize(String id,
 Integer h,
 Integer w,
 Boolean running)
                throws ApiException

Resize an exec instance Resize the TTY session used by an exec instance. This endpoint only works if tty was specified as part of creating and starting the exec instance.

Parameters:

id - Exec instance ID (required)

h - Height of the TTY session in characters (optional)

w - Width of the TTY session in characters (optional)

running - Ignore containers not running errors (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
201	no error	-
404	No such exec instance	-
500	Internal server error	-

execResizeWithHttpInfo

public ApiResponse<Void> execResizeWithHttpInfo(@NotNull
 @NotNull String id,
 Integer h,
 Integer w,
 Boolean running)
                                         throws ApiException

Resize an exec instance Resize the TTY session used by an exec instance. This endpoint only works if tty was specified as part of creating and starting the exec instance.

Parameters:

id - Exec instance ID (required)

h - Height of the TTY session in characters (optional)

w - Width of the TTY session in characters (optional)

running - Ignore containers not running errors (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
201	no error	-
404	No such exec instance	-
500	Internal server error	-

execResizeAsync

public okhttp3.Call execResizeAsync(String id,
 Integer h,
 Integer w,
 Boolean running,
 ApiCallback<Void> _callback)
                             throws ApiException

Resize an exec instance (asynchronously) Resize the TTY session used by an exec instance. This endpoint only works if tty was specified as part of creating and starting the exec instance.

Parameters:

id - Exec instance ID (required)

h - Height of the TTY session in characters (optional)

w - Width of the TTY session in characters (optional)

running - Ignore containers not running errors (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	no error	-
404	No such exec instance	-
500	Internal server error	-

execStartCall

public okhttp3.Call execStartCall(String id,
 ExecStartRequest control,
 ApiCallback _callback)
                           throws ApiException

Build call for execStart

Parameters:

id - Exec instance ID (required)

control - Attributes for start (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	no error	-
404	No such exec instance	-
409	container is not running	-
500	Internal server error	-

execStart

public void execStart(String id,
 ExecStartRequest control)
               throws ApiException

Start an exec instance Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.

Parameters:

id - Exec instance ID (required)

control - Attributes for start (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
200	no error	-
404	No such exec instance	-
409	container is not running	-
500	Internal server error	-

execStartWithHttpInfo

public ApiResponse<Void> execStartWithHttpInfo(@NotNull
 @NotNull String id,
 ExecStartRequest control)
                                        throws ApiException

Start an exec instance Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.

Parameters:

id - Exec instance ID (required)

control - Attributes for start (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
200	no error	-
404	No such exec instance	-
409	container is not running	-
500	Internal server error	-

execStartAsync

public okhttp3.Call execStartAsync(String id,
 ExecStartRequest control,
 ApiCallback<Void> _callback)
                            throws ApiException

Start an exec instance (asynchronously) Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.

Parameters:

id - Exec instance ID (required)

control - Attributes for start (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	no error	-
404	No such exec instance	-
409	container is not running	-
500	Internal server error	-