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

Class ExecCompatApi

java.lang.Object

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

public class ExecCompatApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ExecCompatApi.APIcontainerExecRequest
class	ExecCompatApi.APIexecInspectRequest
class	ExecCompatApi.APIexecResizeRequest
class	ExecCompatApi.APIexecStartRequest

Constructor Summary

Constructors

Constructor	Description
ExecCompatApi()
ExecCompatApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ExecCompatApi.APIcontainerExecRequest	containerExec(String name)	Create an exec instance Create an exec session to run a command inside a running container.
ExecCompatApi.APIexecInspectRequest	execInspect(String id)	Inspect an exec instance Return low-level information about an exec instance.
ExecCompatApi.APIexecResizeRequest	execResize(String id)	Resize an exec instance Resize the TTY session used by an exec instance.
ExecCompatApi.APIexecStartRequest	execStart(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

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)

containerExec

public ExecCompatApi.APIcontainerExecRequest containerExec(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:

APIcontainerExecRequest

Http Response Details

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

execInspect

public ExecCompatApi.APIexecInspectRequest execInspect(String id)

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

Parameters:

id - Exec instance ID (required)

Returns:

APIexecInspectRequest

Http Response Details

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

execResize

public ExecCompatApi.APIexecResizeRequest execResize(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:

APIexecResizeRequest

Http Response Details

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

execStart

public ExecCompatApi.APIexecStartRequest execStart(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.

Parameters:

id - Exec instance ID (required)

Returns:

APIexecStartRequest

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	-