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

Class ExecApi

java.lang.Object

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

public class ExecApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ExecApi.APIcontainerExecLibpodRequest
class	ExecApi.APIexecInspectLibpodRequest
class	ExecApi.APIexecResizeLibpodRequest
class	ExecApi.APIexecStartLibpodRequest

Constructor Summary

Constructors

Constructor	Description
ExecApi()
ExecApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ExecApi.APIcontainerExecLibpodRequest	containerExecLibpod(String name)	Create an exec instance Create an exec session to run a command inside a running container.
ExecApi.APIexecInspectLibpodRequest	execInspectLibpod(String id)	Inspect an exec instance Return low-level information about an exec instance.
ExecApi.APIexecResizeLibpodRequest	execResizeLibpod(String id)	Resize an exec instance Resize the TTY session used by an exec instance.
ExecApi.APIexecStartLibpodRequest	execStartLibpod(String id)	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)

containerExecLibpod

public ExecApi.APIcontainerExecLibpodRequest containerExecLibpod(String name)

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)

Returns:

APIcontainerExecLibpodRequest

Http Response Details

Status Code	Description	Response Headers
201	no error	-
404	No such container	-
409	container is paused	-
500	Internal server error	-

execInspectLibpod

public ExecApi.APIexecInspectLibpodRequest execInspectLibpod(String id)

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

Parameters:

id - Exec instance ID (required)

Returns:

APIexecInspectLibpodRequest

Http Response Details

Status Code	Description	Response Headers
200	no error	-
404	No such exec instance	-
500	Internal server error	-

execResizeLibpod

public ExecApi.APIexecResizeLibpodRequest execResizeLibpod(String id)

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)

Returns:

APIexecResizeLibpodRequest

Http Response Details

Status Code	Description	Response Headers
201	no error	-
404	No such exec instance	-
500	Internal server error	-

execStartLibpod

public ExecApi.APIexecStartLibpodRequest execStartLibpod(String id)

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)

Returns:

APIexecStartLibpodRequest

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	-