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

Class ExecApi

java.lang.Object

io.github.alersrt.pod4j.openapi.api.ExecApi

public class ExecApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ExecApi()
ExecApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	containerExecLibpod(String name, ContainerExecRequest control)	Create an exec instance Create an exec session to run a command inside a running container.
okhttp3.Call	containerExecLibpodAsync(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	containerExecLibpodCall(String name, ContainerExecRequest control, ApiCallback _callback)	Build call for containerExecLibpod
ApiResponse<Void>	containerExecLibpodWithHttpInfo(@NotNull String name, ContainerExecRequest control)	Create an exec instance Create an exec session to run a command inside a running container.
void	execInspectLibpod(String id)	Inspect an exec instance Return low-level information about an exec instance.
okhttp3.Call	execInspectLibpodAsync(String id, ApiCallback<Void> _callback)	Inspect an exec instance (asynchronously) Return low-level information about an exec instance.
okhttp3.Call	execInspectLibpodCall(String id, ApiCallback _callback)	Build call for execInspectLibpod
ApiResponse<Void>	execInspectLibpodWithHttpInfo(@NotNull String id)	Inspect an exec instance Return low-level information about an exec instance.
void	execResizeLibpod(String id, Integer h, Integer w)	Resize an exec instance Resize the TTY session used by an exec instance.
okhttp3.Call	execResizeLibpodAsync(String id, Integer h, Integer w, ApiCallback<Void> _callback)	Resize an exec instance (asynchronously) Resize the TTY session used by an exec instance.
okhttp3.Call	execResizeLibpodCall(String id, Integer h, Integer w, ApiCallback _callback)	Build call for execResizeLibpod
ApiResponse<Void>	execResizeLibpodWithHttpInfo(@NotNull String id, Integer h, Integer w)	Resize an exec instance Resize the TTY session used by an exec instance.
void	execStartLibpod(String id, ExecStartLibpodRequest control)	Start an exec instance Starts a previously set up exec instance.
okhttp3.Call	execStartLibpodAsync(String id, ExecStartLibpodRequest control, ApiCallback<Void> _callback)	Start an exec instance (asynchronously) Starts a previously set up exec instance.
okhttp3.Call	execStartLibpodCall(String id, ExecStartLibpodRequest control, ApiCallback _callback)	Build call for execStartLibpod
ApiResponse<Void>	execStartLibpodWithHttpInfo(@NotNull String id, ExecStartLibpodRequest 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

ExecApi

public ExecApi()

ExecApi

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

containerExecLibpodCall

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

Build call for containerExecLibpod

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	-

containerExecLibpod

public void containerExecLibpod(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	-

containerExecLibpodWithHttpInfo

public ApiResponse<Void> containerExecLibpodWithHttpInfo(@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	-

containerExecLibpodAsync

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

execInspectLibpodCall

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

Build call for execInspectLibpod

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

execInspectLibpod

public void execInspectLibpod(String id)
                       throws ApiException

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

Parameters:

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

execInspectLibpodWithHttpInfo

public ApiResponse<Void> execInspectLibpodWithHttpInfo(@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<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	-
500	Internal server error	-

execInspectLibpodAsync

public okhttp3.Call execInspectLibpodAsync(String id,
 ApiCallback<Void> _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	no error	-
404	No such exec instance	-
500	Internal server error	-

execResizeLibpodCall

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

Build call for execResizeLibpod

Parameters:

id - Exec instance ID (required)

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

w - Width of the TTY session in characters (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	-

execResizeLibpod

public void execResizeLibpod(String id,
 Integer h,
 Integer w)
                      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)

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	-

execResizeLibpodWithHttpInfo

public ApiResponse<Void> execResizeLibpodWithHttpInfo(@NotNull
 @NotNull String id,
 Integer h,
 Integer w)
                                               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)

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	-

execResizeLibpodAsync

public okhttp3.Call execResizeLibpodAsync(String id,
 Integer h,
 Integer w,
 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)

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

execStartLibpodCall

public okhttp3.Call execStartLibpodCall(String id,
 ExecStartLibpodRequest control,
 ApiCallback _callback)
                                 throws ApiException

Build call for execStartLibpod

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	-

execStartLibpod

public void execStartLibpod(String id,
 ExecStartLibpodRequest 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. The stream format is the same as the attach endpoint.

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	-

execStartLibpodWithHttpInfo

public ApiResponse<Void> execStartLibpodWithHttpInfo(@NotNull
 @NotNull String id,
 ExecStartLibpodRequest 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. The stream format is the same as the attach endpoint.

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	-

execStartLibpodAsync

public okhttp3.Call execStartLibpodAsync(String id,
 ExecStartLibpodRequest 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. The stream format is the same as the attach endpoint.

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	-