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

Class ContainersCompatApi

java.lang.Object

io.github.alersrt.pod4j.openapi.api.ContainersCompatApi

public class ContainersCompatApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ContainersCompatApi.APIcontainerArchiveLibpodRequest
class	ContainersCompatApi.APIcontainerArchiveRequest
class	ContainersCompatApi.APIcontainerAttachRequest
class	ContainersCompatApi.APIcontainerChangesLibpodRequest
class	ContainersCompatApi.APIcontainerCreateRequest
class	ContainersCompatApi.APIcontainerDeleteRequest
class	ContainersCompatApi.APIcontainerExportRequest
class	ContainersCompatApi.APIcontainerInspectRequest
class	ContainersCompatApi.APIcontainerKillRequest
class	ContainersCompatApi.APIcontainerListRequest
class	ContainersCompatApi.APIcontainerLogsRequest
class	ContainersCompatApi.APIcontainerPauseRequest
class	ContainersCompatApi.APIcontainerPruneRequest
class	ContainersCompatApi.APIcontainerRenameRequest
class	ContainersCompatApi.APIcontainerResizeRequest
class	ContainersCompatApi.APIcontainerRestartRequest
class	ContainersCompatApi.APIcontainerStartRequest
class	ContainersCompatApi.APIcontainerStatsRequest
class	ContainersCompatApi.APIcontainerStopRequest
class	ContainersCompatApi.APIcontainerTopRequest
class	ContainersCompatApi.APIcontainerUnpauseRequest
class	ContainersCompatApi.APIcontainerUpdateRequest
class	ContainersCompatApi.APIcontainerWaitRequest
class	ContainersCompatApi.APIimageCommitRequest
class	ContainersCompatApi.APIputContainerArchiveRequest

Constructor Summary

Constructors

Constructor	Description
ContainersCompatApi()
ContainersCompatApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ContainersCompatApi.APIcontainerArchiveRequest	containerArchive(String name, String path)	Get files from a container Get a tar archive of files from a container
ContainersCompatApi.APIcontainerArchiveLibpodRequest	containerArchiveLibpod(String name, String path)	Copy files from a container Copy a tar archive of files from a container
ContainersCompatApi.APIcontainerAttachRequest	containerAttach(String name)	Attach to a container Attach to a container to read its output or send it input.
ContainersCompatApi.APIcontainerChangesLibpodRequest	containerChangesLibpod(String name)	Report on changes to container's filesystem; adds, deletes or modifications.
ContainersCompatApi.APIcontainerCreateRequest	containerCreate(CreateContainerConfig body)	Create a container
ContainersCompatApi.APIcontainerDeleteRequest	containerDelete(String name)	Remove a container
ContainersCompatApi.APIcontainerExportRequest	containerExport(String name)	Export a container Export the contents of a container as a tarball.
ContainersCompatApi.APIcontainerInspectRequest	containerInspect(String name)	Inspect container Return low-level information about a container.
ContainersCompatApi.APIcontainerKillRequest	containerKill(String name)	Kill container Signal to send to the container as an integer or string (e.g.
ContainersCompatApi.APIcontainerListRequest	containerList()	List containers Returns a list of containers
ContainersCompatApi.APIcontainerLogsRequest	containerLogs(String name)	Get container logs Get stdout and stderr logs from a container.
ContainersCompatApi.APIcontainerPauseRequest	containerPause(String name)	Pause container Use the cgroups freezer to suspend all processes in a container.
ContainersCompatApi.APIcontainerPruneRequest	containerPrune()	Delete stopped containers Remove containers not in use
ContainersCompatApi.APIcontainerRenameRequest	containerRename(String name, String name2)	Rename an existing container Change the name of an existing container.
ContainersCompatApi.APIcontainerResizeRequest	containerResize(String name)	Resize a container's TTY Resize the terminal attached to a container (for use with Attach).
ContainersCompatApi.APIcontainerRestartRequest	containerRestart(String name)	Restart container
ContainersCompatApi.APIcontainerStartRequest	containerStart(String name)	Start a container
ContainersCompatApi.APIcontainerStatsRequest	containerStats(String name)	Get stats for a container This returns a live stream of a container’s resource usage statistics.
ContainersCompatApi.APIcontainerStopRequest	containerStop(String name)	Stop a container Stop a container
ContainersCompatApi.APIcontainerTopRequest	containerTop(String name)	List processes running inside a container
ContainersCompatApi.APIcontainerUnpauseRequest	containerUnpause(String name)	Unpause container Resume a paused container
ContainersCompatApi.APIcontainerUpdateRequest	containerUpdate(String name)	Update configuration of an existing container Change configuration settings for an existing container without requiring recreation.
ContainersCompatApi.APIcontainerWaitRequest	containerWait(String name)	Wait on a container Block until a container stops or given condition is met.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
ContainersCompatApi.APIimageCommitRequest	imageCommit()	New Image Create a new image from a container
ContainersCompatApi.APIputContainerArchiveRequest	putContainerArchive(String name, String path)	Put files into a container Put a tar archive of files into a container
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

ContainersCompatApi

public ContainersCompatApi()

ContainersCompatApi

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

containerArchive

public ContainersCompatApi.APIcontainerArchiveRequest containerArchive(String name,
 String path)

Get files from a container Get a tar archive of files from a container

Parameters:

name - container name or id (required)

path - Path to a directory in the container to extract (required)

Returns:

APIcontainerArchiveRequest

Http Response Details

Status Code	Description	Response Headers
200	no error	-
400	Bad parameter in request	-
404	No such container	-
500	Internal server error	-

containerArchiveLibpod

public ContainersCompatApi.APIcontainerArchiveLibpodRequest containerArchiveLibpod(String name,
 String path)

Copy files from a container Copy a tar archive of files from a container

Parameters:

name - container name or id (required)

path - Path to a directory in the container to extract (required)

Returns:

APIcontainerArchiveLibpodRequest

Http Response Details

Status Code	Description	Response Headers
200	no error	-
400	Bad parameter in request	-
404	No such container	-
500	Internal server error	-

containerAttach

public ContainersCompatApi.APIcontainerAttachRequest containerAttach(String name)

Attach to a container Attach to a container to read its output or send it input. You can attach to the same container multiple times and you can reattach to containers that have been detached. It uses the same stream format as docker, see the libpod attach endpoint for a description of the format.

Parameters:

name - the name or ID of the container (required)

Returns:

APIcontainerAttachRequest

Http Response Details

Status Code	Description	Response Headers
101	No error, connection has been hijacked for transporting streams.	-
400	Bad parameter in request	-
404	No such container	-
500	Internal server error	-

containerChangesLibpod

public ContainersCompatApi.APIcontainerChangesLibpodRequest containerChangesLibpod(String name)

Report on changes to container's filesystem; adds, deletes or modifications. Returns which files in a container's filesystem have been added, deleted, or modified. The Kind of modification can be one of: 0: Modified 1: Added 2: Deleted

Parameters:

name - the name or id of the container (required)

Returns:

APIcontainerChangesLibpodRequest

Http Response Details

Status Code	Description	Response Headers
200	Array of Changes	-
404	No such container	-
500	Internal server error	-

containerCreate

public ContainersCompatApi.APIcontainerCreateRequest containerCreate(CreateContainerConfig body)

Create a container

Parameters:

body - Container to create (required)

Returns:

APIcontainerCreateRequest

Http Response Details

Status Code	Description	Response Headers
201	Create container	-
400	Bad parameter in request	-
404	No such container	-
409	Conflict error in operation	-
500	Internal server error	-

containerDelete

public ContainersCompatApi.APIcontainerDeleteRequest containerDelete(String name)

Remove a container

Parameters:

name - the name or ID of the container (required)

Returns:

APIcontainerDeleteRequest

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	-

containerExport

public ContainersCompatApi.APIcontainerExportRequest containerExport(String name)

Export a container Export the contents of a container as a tarball.

Parameters:

name - the name or ID of the container (required)

Returns:

APIcontainerExportRequest

Http Response Details

Status Code	Description	Response Headers
200	tarball is returned in body	-
404	No such container	-
500	Internal server error	-

containerInspect

public ContainersCompatApi.APIcontainerInspectRequest containerInspect(String name)

Inspect container Return low-level information about a container.

Parameters:

name - the name or id of the container (required)

Returns:

APIcontainerInspectRequest

Http Response Details

Status Code	Description	Response Headers
200	Inspect container	-
404	No such container	-
500	Internal server error	-

containerKill

public ContainersCompatApi.APIcontainerKillRequest containerKill(String name)

Kill container Signal to send to the container as an integer or string (e.g. SIGINT)

Parameters:

name - the name or ID of the container (required)

Returns:

APIcontainerKillRequest

Http Response Details

Status Code	Description	Response Headers
204	no error	-
404	No such container	-
409	Conflict error in operation	-
500	Internal server error	-

containerList

public ContainersCompatApi.APIcontainerListRequest containerList()

List containers Returns a list of containers

Returns:

APIcontainerListRequest

Http Response Details

Status Code	Description	Response Headers
200	List Containers	-
400	Bad parameter in request	-
500	Internal server error	-

containerLogs

public ContainersCompatApi.APIcontainerLogsRequest containerLogs(String name)

Get container logs Get stdout and stderr logs from a container.

Parameters:

name - the name or ID of the container (required)

Returns:

APIcontainerLogsRequest

Http Response Details

Status Code	Description	Response Headers
200	logs returned as a stream in response body.	-
404	No such container	-
500	Internal server error	-

containerPause

public ContainersCompatApi.APIcontainerPauseRequest containerPause(String name)

Pause container Use the cgroups freezer to suspend all processes in a container.

Parameters:

name - the name or ID of the container (required)

Returns:

APIcontainerPauseRequest

Http Response Details

Status Code	Description	Response Headers
204	no error	-
404	No such container	-
500	Internal server error	-

containerPrune

public ContainersCompatApi.APIcontainerPruneRequest containerPrune()

Delete stopped containers Remove containers not in use

Returns:

APIcontainerPruneRequest

Http Response Details

Status Code	Description	Response Headers
200	Prune Containers	-
500	Internal server error	-

containerRename

public ContainersCompatApi.APIcontainerRenameRequest containerRename(String name,
 String name2)

Rename an existing container Change the name of an existing container.

Parameters:

name - Full or partial ID or full name of the container to rename (required)

name2 - New name for the container (required)

Returns:

APIcontainerRenameRequest

Http Response Details

Status Code	Description	Response Headers
204	no error	-
404	No such container	-
409	Conflict error in operation	-
500	Internal server error	-

containerResize

public ContainersCompatApi.APIcontainerResizeRequest containerResize(String name)

Resize a container's TTY Resize the terminal attached to a container (for use with Attach).

Parameters:

name - the name or ID of the container (required)

Returns:

APIcontainerResizeRequest

Http Response Details

Status Code	Description	Response Headers
200	Success	-
404	No such container	-
500	Internal server error	-

containerRestart

public ContainersCompatApi.APIcontainerRestartRequest containerRestart(String name)

Restart container

Parameters:

name - the name or ID of the container (required)

Returns:

APIcontainerRestartRequest

Http Response Details

Status Code	Description	Response Headers
204	no error	-
404	No such container	-
500	Internal server error	-

containerStart

public ContainersCompatApi.APIcontainerStartRequest containerStart(String name)

Start a container

Parameters:

name - the name or ID of the container (required)

Returns:

APIcontainerStartRequest

Http Response Details

Status Code	Description	Response Headers
204	no error	-
304	Container already started	-
404	No such container	-
500	Internal server error	-

containerStats

public ContainersCompatApi.APIcontainerStatsRequest containerStats(String name)

Get stats for a container This returns a live stream of a container’s resource usage statistics.

Parameters:

name - the name or ID of the container (required)

Returns:

APIcontainerStatsRequest

Http Response Details

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

containerStop

public ContainersCompatApi.APIcontainerStopRequest containerStop(String name)

Stop a container Stop a container

Parameters:

name - the name or ID of the container (required)

Returns:

APIcontainerStopRequest

Http Response Details

Status Code	Description	Response Headers
204	no error	-
304	Container already stopped	-
404	No such container	-
500	Internal server error	-

containerTop

public ContainersCompatApi.APIcontainerTopRequest containerTop(String name)

List processes running inside a container

Parameters:

name - the name or ID of the container (required)

Returns:

APIcontainerTopRequest

Http Response Details

Status Code	Description	Response Headers
200	List processes in container	-
404	No such container	-
500	Internal server error	-

containerUnpause

public ContainersCompatApi.APIcontainerUnpauseRequest containerUnpause(String name)

Unpause container Resume a paused container

Parameters:

name - the name or ID of the container (required)

Returns:

APIcontainerUnpauseRequest

Http Response Details

Status Code	Description	Response Headers
204	no error	-
404	No such container	-
500	Internal server error	-

containerUpdate

public ContainersCompatApi.APIcontainerUpdateRequest containerUpdate(String name)

Update configuration of an existing container Change configuration settings for an existing container without requiring recreation.

Parameters:

name - Full or partial ID or full name of the container to rename (required)

Returns:

APIcontainerUpdateRequest

Http Response Details

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

containerWait

public ContainersCompatApi.APIcontainerWaitRequest containerWait(String name)

Wait on a container Block until a container stops or given condition is met.

Parameters:

name - the name or ID of the container (required)

Returns:

APIcontainerWaitRequest

Http Response Details

Status Code	Description	Response Headers
200	Wait container	-
404	No such container	-
500	Internal server error	-

imageCommit

public ContainersCompatApi.APIimageCommitRequest imageCommit()

New Image Create a new image from a container

Returns:

APIimageCommitRequest

Http Response Details

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

putContainerArchive

public ContainersCompatApi.APIputContainerArchiveRequest putContainerArchive(String name,
 String path)

Put files into a container Put a tar archive of files into a container

Parameters:

name - container name or id (required)

path - Path to a directory in the container to extract (required)

Returns:

APIputContainerArchiveRequest

Http Response Details

Status Code	Description	Response Headers
200	no error	-
400	Bad parameter in request	-
403	the container rootfs is read-only	-
404	No such container	-
500	Internal server error	-