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

Class ContainersCompatApi

java.lang.Object
io.github.alersrt.pod4j.openapi.api.ContainersCompatApi
public class ContainersCompatApi extends Object

  • 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)

    • containerArchiveCall

      public okhttp3.Call containerArchiveCall(String name, String path, ApiCallback _callback) throws ApiException
      Build call for containerArchive
      Parameters:
      name - container name or id (required)
      path - Path to a directory in the container to extract (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 -
      400 Bad parameter in request -
      404 No such container -
      500 Internal server error -

    • containerArchive

      public File containerArchive(String name, String path) throws ApiException
      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:
      File
      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 -
      400 Bad parameter in request -
      404 No such container -
      500 Internal server error -

    • containerArchiveWithHttpInfo

      public ApiResponse<File> containerArchiveWithHttpInfo(String name, String path) throws ApiException
      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:
      ApiResponse<File>
      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 -
      400 Bad parameter in request -
      404 No such container -
      500 Internal server error -

    • containerArchiveAsync

      public okhttp3.Call containerArchiveAsync(String name, String path, ApiCallback<File> _callback) throws ApiException
      Get files from a container (asynchronously) 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)
      _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 -
      400 Bad parameter in request -
      404 No such container -
      500 Internal server error -

    • containerArchiveLibpodCall

      public okhttp3.Call containerArchiveLibpodCall(String name, String path, String rename, ApiCallback _callback) throws ApiException
      Build call for containerArchiveLibpod
      Parameters:
      name - container name or id (required)
      path - Path to a directory in the container to extract (required)
      rename - JSON encoded map[string]string to translate paths (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 -
      400 Bad parameter in request -
      404 No such container -
      500 Internal server error -

    • containerArchiveLibpod

      public File containerArchiveLibpod(String name, String path, String rename) throws ApiException
      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)
      rename - JSON encoded map[string]string to translate paths (optional)
      Returns:
      File
      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 -
      400 Bad parameter in request -
      404 No such container -
      500 Internal server error -

    • containerArchiveLibpodWithHttpInfo

      public ApiResponse<File> containerArchiveLibpodWithHttpInfo(String name, String path, String rename) throws ApiException
      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)
      rename - JSON encoded map[string]string to translate paths (optional)
      Returns:
      ApiResponse<File>
      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 -
      400 Bad parameter in request -
      404 No such container -
      500 Internal server error -

    • containerArchiveLibpodAsync

      public okhttp3.Call containerArchiveLibpodAsync(String name, String path, String rename, ApiCallback<File> _callback) throws ApiException
      Copy files from a container (asynchronously) 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)
      rename - JSON encoded map[string]string to translate paths (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 -
      400 Bad parameter in request -
      404 No such container -
      500 Internal server error -

    • containerAttachCall

      public okhttp3.Call containerAttachCall(String name, String detachKeys, Boolean logs, Boolean stream, Boolean stdout, Boolean stderr, Boolean stdin, ApiCallback _callback) throws ApiException
      Build call for containerAttach
      Parameters:
      name - the name or ID of the container (required)
      detachKeys - keys to use for detaching from the container (optional)
      logs - Stream all logs from the container across the connection. Happens before streaming attach (if requested). At least one of logs or stream must be set (optional)
      stream - Attach to the container. If unset, and logs is set, only the container's logs will be sent. At least one of stream or logs must be set (optional, default to true)
      stdout - Attach to container STDOUT (optional)
      stderr - Attach to container STDERR (optional)
      stdin - Attach to container STDIN (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
      101 No error, connection has been hijacked for transporting streams. -
      400 Bad parameter in request -
      404 No such container -
      500 Internal server error -

    • containerAttach

      public void containerAttach(String name, String detachKeys, Boolean logs, Boolean stream, Boolean stdout, Boolean stderr, Boolean stdin) throws ApiException
      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)
      detachKeys - keys to use for detaching from the container (optional)
      logs - Stream all logs from the container across the connection. Happens before streaming attach (if requested). At least one of logs or stream must be set (optional)
      stream - Attach to the container. If unset, and logs is set, only the container's logs will be sent. At least one of stream or logs must be set (optional, default to true)
      stdout - Attach to container STDOUT (optional)
      stderr - Attach to container STDERR (optional)
      stdin - Attach to container STDIN (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
      101 No error, connection has been hijacked for transporting streams. -
      400 Bad parameter in request -
      404 No such container -
      500 Internal server error -

    • containerAttachWithHttpInfo

      public ApiResponse<Void> containerAttachWithHttpInfo(String name, String detachKeys, Boolean logs, Boolean stream, Boolean stdout, Boolean stderr, Boolean stdin) throws ApiException
      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)
      detachKeys - keys to use for detaching from the container (optional)
      logs - Stream all logs from the container across the connection. Happens before streaming attach (if requested). At least one of logs or stream must be set (optional)
      stream - Attach to the container. If unset, and logs is set, only the container's logs will be sent. At least one of stream or logs must be set (optional, default to true)
      stdout - Attach to container STDOUT (optional)
      stderr - Attach to container STDERR (optional)
      stdin - Attach to container STDIN (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
      101 No error, connection has been hijacked for transporting streams. -
      400 Bad parameter in request -
      404 No such container -
      500 Internal server error -

    • containerAttachAsync

      public okhttp3.Call containerAttachAsync(String name, String detachKeys, Boolean logs, Boolean stream, Boolean stdout, Boolean stderr, Boolean stdin, ApiCallback<Void> _callback) throws ApiException
      Attach to a container (asynchronously) 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)
      detachKeys - keys to use for detaching from the container (optional)
      logs - Stream all logs from the container across the connection. Happens before streaming attach (if requested). At least one of logs or stream must be set (optional)
      stream - Attach to the container. If unset, and logs is set, only the container's logs will be sent. At least one of stream or logs must be set (optional, default to true)
      stdout - Attach to container STDOUT (optional)
      stderr - Attach to container STDERR (optional)
      stdin - Attach to container STDIN (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
      101 No error, connection has been hijacked for transporting streams. -
      400 Bad parameter in request -
      404 No such container -
      500 Internal server error -

    • containerChangesLibpodCall

      public okhttp3.Call containerChangesLibpodCall(String name, String parent, String diffType, ApiCallback _callback) throws ApiException
      Build call for containerChangesLibpod
      Parameters:
      name - the name or id of the container (required)
      parent - specify a second layer which is used to compare against it instead of the parent layer (optional)
      diffType - select what you want to match, default is all (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 Array of Changes -
      404 No such container -
      500 Internal server error -

    • containerChangesLibpod

      public void containerChangesLibpod(String name, String parent, String diffType) throws ApiException
      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)
      parent - specify a second layer which is used to compare against it instead of the parent layer (optional)
      diffType - select what you want to match, default is all (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 Array of Changes -
      404 No such container -
      500 Internal server error -

    • containerChangesLibpodWithHttpInfo

      public ApiResponse<Void> containerChangesLibpodWithHttpInfo(String name, String parent, String diffType) throws ApiException
      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)
      parent - specify a second layer which is used to compare against it instead of the parent layer (optional)
      diffType - select what you want to match, default is all (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 Array of Changes -
      404 No such container -
      500 Internal server error -

    • containerChangesLibpodAsync

      public okhttp3.Call containerChangesLibpodAsync(String name, String parent, String diffType, ApiCallback<Void> _callback) throws ApiException
      Report on changes to container's filesystem; adds, deletes or modifications. (asynchronously) 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)
      parent - specify a second layer which is used to compare against it instead of the parent layer (optional)
      diffType - select what you want to match, default is all (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 Array of Changes -
      404 No such container -
      500 Internal server error -

    • containerCreateCall

      public okhttp3.Call containerCreateCall(CreateContainerConfig body, String name, ApiCallback _callback) throws ApiException
      Build call for containerCreate
      Parameters:
      body - Container to create (required)
      name - container name (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 Create container -
      400 Bad parameter in request -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerCreate

      public ContainerCreateResponse containerCreate(CreateContainerConfig body, String name) throws ApiException
      Create a container
      Parameters:
      body - Container to create (required)
      name - container name (optional)
      Returns:
      ContainerCreateResponse
      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 Create container -
      400 Bad parameter in request -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerCreateWithHttpInfo

      public ApiResponse<ContainerCreateResponse> containerCreateWithHttpInfo(CreateContainerConfig body, String name) throws ApiException
      Create a container
      Parameters:
      body - Container to create (required)
      name - container name (optional)
      Returns:
      ApiResponse<ContainerCreateResponse>
      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 Create container -
      400 Bad parameter in request -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerCreateAsync

      public okhttp3.Call containerCreateAsync(CreateContainerConfig body, String name, ApiCallback<ContainerCreateResponse> _callback) throws ApiException
      Create a container (asynchronously)
      Parameters:
      body - Container to create (required)
      name - container name (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 Create container -
      400 Bad parameter in request -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerDeleteCall

      public okhttp3.Call containerDeleteCall(String name, Boolean force, Boolean v, Boolean link, ApiCallback _callback) throws ApiException
      Build call for containerDelete
      Parameters:
      name - the name or ID of the container (required)
      force - If the container is running, kill it before removing it. (optional, default to false)
      v - Remove the volumes associated with the container. (optional, default to false)
      link - not supported (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
      204 no error -
      400 Bad parameter in request -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerDelete

      public void containerDelete(String name, Boolean force, Boolean v, Boolean link) throws ApiException
      Remove a container
      Parameters:
      name - the name or ID of the container (required)
      force - If the container is running, kill it before removing it. (optional, default to false)
      v - Remove the volumes associated with the container. (optional, default to false)
      link - not supported (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
      204 no error -
      400 Bad parameter in request -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerDeleteWithHttpInfo

      public ApiResponse<Void> containerDeleteWithHttpInfo(String name, Boolean force, Boolean v, Boolean link) throws ApiException
      Remove a container
      Parameters:
      name - the name or ID of the container (required)
      force - If the container is running, kill it before removing it. (optional, default to false)
      v - Remove the volumes associated with the container. (optional, default to false)
      link - not supported (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
      204 no error -
      400 Bad parameter in request -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerDeleteAsync

      public okhttp3.Call containerDeleteAsync(String name, Boolean force, Boolean v, Boolean link, ApiCallback<Void> _callback) throws ApiException
      Remove a container (asynchronously)
      Parameters:
      name - the name or ID of the container (required)
      force - If the container is running, kill it before removing it. (optional, default to false)
      v - Remove the volumes associated with the container. (optional, default to false)
      link - not supported (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
      204 no error -
      400 Bad parameter in request -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerExportCall

      public okhttp3.Call containerExportCall(String name, ApiCallback _callback) throws ApiException
      Build call for containerExport
      Parameters:
      name - the name or ID of the container (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 tarball is returned in body -
      404 No such container -
      500 Internal server error -

    • containerExport

      public void containerExport(String name) throws ApiException
      Export a container Export the contents of a container as a tarball.
      Parameters:
      name - the name or ID of the container (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 tarball is returned in body -
      404 No such container -
      500 Internal server error -

    • containerExportWithHttpInfo

      public ApiResponse<Void> containerExportWithHttpInfo(String name) throws ApiException
      Export a container Export the contents of a container as a tarball.
      Parameters:
      name - the name or ID of the container (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 tarball is returned in body -
      404 No such container -
      500 Internal server error -

    • containerExportAsync

      public okhttp3.Call containerExportAsync(String name, ApiCallback<Void> _callback) throws ApiException
      Export a container (asynchronously) Export the contents of a container as a tarball.
      Parameters:
      name - the name or ID of the container (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 tarball is returned in body -
      404 No such container -
      500 Internal server error -

    • containerInspectCall

      public okhttp3.Call containerInspectCall(String name, Boolean size, ApiCallback _callback) throws ApiException
      Build call for containerInspect
      Parameters:
      name - the name or id of the container (required)
      size - include the size of the container (optional, default to false)
      _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 Inspect container -
      404 No such container -
      500 Internal server error -

    • containerInspect

      public ContainerJSON containerInspect(String name, Boolean size) throws ApiException
      Inspect container Return low-level information about a container.
      Parameters:
      name - the name or id of the container (required)
      size - include the size of the container (optional, default to false)
      Returns:
      ContainerJSON
      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 Inspect container -
      404 No such container -
      500 Internal server error -

    • containerInspectWithHttpInfo

      public ApiResponse<ContainerJSON> containerInspectWithHttpInfo(String name, Boolean size) throws ApiException
      Inspect container Return low-level information about a container.
      Parameters:
      name - the name or id of the container (required)
      size - include the size of the container (optional, default to false)
      Returns:
      ApiResponse<ContainerJSON>
      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 Inspect container -
      404 No such container -
      500 Internal server error -

    • containerInspectAsync

      public okhttp3.Call containerInspectAsync(String name, Boolean size, ApiCallback<ContainerJSON> _callback) throws ApiException
      Inspect container (asynchronously) Return low-level information about a container.
      Parameters:
      name - the name or id of the container (required)
      size - include the size of the container (optional, default to false)
      _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 Inspect container -
      404 No such container -
      500 Internal server error -

    • containerKillCall

      public okhttp3.Call containerKillCall(String name, Boolean all, String signal, ApiCallback _callback) throws ApiException
      Build call for containerKill
      Parameters:
      name - the name or ID of the container (required)
      all - Send kill signal to all containers (optional, default to false)
      signal - signal to be sent to container (optional, default to SIGKILL)
      _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
      204 no error -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerKill

      public void containerKill(String name, Boolean all, String signal) throws ApiException
      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)
      all - Send kill signal to all containers (optional, default to false)
      signal - signal to be sent to container (optional, default to SIGKILL)
      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
      204 no error -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerKillWithHttpInfo

      public ApiResponse<Void> containerKillWithHttpInfo(String name, Boolean all, String signal) throws ApiException
      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)
      all - Send kill signal to all containers (optional, default to false)
      signal - signal to be sent to container (optional, default to SIGKILL)
      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
      204 no error -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerKillAsync

      public okhttp3.Call containerKillAsync(String name, Boolean all, String signal, ApiCallback<Void> _callback) throws ApiException
      Kill container (asynchronously) Signal to send to the container as an integer or string (e.g. SIGINT)
      Parameters:
      name - the name or ID of the container (required)
      all - Send kill signal to all containers (optional, default to false)
      signal - signal to be sent to container (optional, default to SIGKILL)
      _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
      204 no error -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerListCall

      public okhttp3.Call containerListCall(Boolean all, Boolean external, Integer limit, Boolean size, String filters, ApiCallback _callback) throws ApiException
      Build call for containerList
      Parameters:
      all - Return all containers. By default, only running containers are shown (optional, default to false)
      external - Return containers in storage not controlled by Podman (optional, default to false)
      limit - Return this number of most recently created containers, including non-running ones. (optional)
      size - Return the size of container as fields SizeRw and SizeRootFs. (optional, default to false)
      filters - A JSON encoded value of the filters (a `map[string][]string`) to process on the containers list. Available filters: - `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`) - `before`=(`<container id>` or `<container name>`) - `expose`=(`<port>[/<proto>]` or `<startport-endport>/[<proto>]`) - `exited=<int>` containers with exit code of `<int>` - `health`=(`starting`, `healthy`, `unhealthy` or `none`) - `id=<ID>` a container's ID - `is-task`=(`true` or `false`) - `label`=(`key` or `\"key=value\"`) of a container label - `name=<name>` a container's name - `network`=(`<network id>` or `<network name>`) - `publish`=(`<port>[/<proto>]` or `<startport-endport>/[<proto>]`) - `since`=(`<container id>` or `<container name>`) - `status`=(`created`, `restarting`, `running`, `removing`, `paused`, `exited` or `dead`) - `volume`=(`<volume name>` or `<mount point destination>`) (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 List Containers -
      400 Bad parameter in request -
      500 Internal server error -

    • containerList

      public List<Container> containerList(Boolean all, Boolean external, Integer limit, Boolean size, String filters) throws ApiException
      List containers Returns a list of containers
      Parameters:
      all - Return all containers. By default, only running containers are shown (optional, default to false)
      external - Return containers in storage not controlled by Podman (optional, default to false)
      limit - Return this number of most recently created containers, including non-running ones. (optional)
      size - Return the size of container as fields SizeRw and SizeRootFs. (optional, default to false)
      filters - A JSON encoded value of the filters (a `map[string][]string`) to process on the containers list. Available filters: - `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`) - `before`=(`<container id>` or `<container name>`) - `expose`=(`<port>[/<proto>]` or `<startport-endport>/[<proto>]`) - `exited=<int>` containers with exit code of `<int>` - `health`=(`starting`, `healthy`, `unhealthy` or `none`) - `id=<ID>` a container's ID - `is-task`=(`true` or `false`) - `label`=(`key` or `\"key=value\"`) of a container label - `name=<name>` a container's name - `network`=(`<network id>` or `<network name>`) - `publish`=(`<port>[/<proto>]` or `<startport-endport>/[<proto>]`) - `since`=(`<container id>` or `<container name>`) - `status`=(`created`, `restarting`, `running`, `removing`, `paused`, `exited` or `dead`) - `volume`=(`<volume name>` or `<mount point destination>`) (optional)
      Returns:
      List<Container>
      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 List Containers -
      400 Bad parameter in request -
      500 Internal server error -

    • containerListWithHttpInfo

      public ApiResponse<List<Container>> containerListWithHttpInfo(Boolean all, Boolean external, Integer limit, Boolean size, String filters) throws ApiException
      List containers Returns a list of containers
      Parameters:
      all - Return all containers. By default, only running containers are shown (optional, default to false)
      external - Return containers in storage not controlled by Podman (optional, default to false)
      limit - Return this number of most recently created containers, including non-running ones. (optional)
      size - Return the size of container as fields SizeRw and SizeRootFs. (optional, default to false)
      filters - A JSON encoded value of the filters (a `map[string][]string`) to process on the containers list. Available filters: - `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`) - `before`=(`<container id>` or `<container name>`) - `expose`=(`<port>[/<proto>]` or `<startport-endport>/[<proto>]`) - `exited=<int>` containers with exit code of `<int>` - `health`=(`starting`, `healthy`, `unhealthy` or `none`) - `id=<ID>` a container's ID - `is-task`=(`true` or `false`) - `label`=(`key` or `\"key=value\"`) of a container label - `name=<name>` a container's name - `network`=(`<network id>` or `<network name>`) - `publish`=(`<port>[/<proto>]` or `<startport-endport>/[<proto>]`) - `since`=(`<container id>` or `<container name>`) - `status`=(`created`, `restarting`, `running`, `removing`, `paused`, `exited` or `dead`) - `volume`=(`<volume name>` or `<mount point destination>`) (optional)
      Returns:
      ApiResponse<List<Container>>
      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 List Containers -
      400 Bad parameter in request -
      500 Internal server error -

    • containerListAsync

      public okhttp3.Call containerListAsync(Boolean all, Boolean external, Integer limit, Boolean size, String filters, ApiCallback<List<Container>> _callback) throws ApiException
      List containers (asynchronously) Returns a list of containers
      Parameters:
      all - Return all containers. By default, only running containers are shown (optional, default to false)
      external - Return containers in storage not controlled by Podman (optional, default to false)
      limit - Return this number of most recently created containers, including non-running ones. (optional)
      size - Return the size of container as fields SizeRw and SizeRootFs. (optional, default to false)
      filters - A JSON encoded value of the filters (a `map[string][]string`) to process on the containers list. Available filters: - `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`) - `before`=(`<container id>` or `<container name>`) - `expose`=(`<port>[/<proto>]` or `<startport-endport>/[<proto>]`) - `exited=<int>` containers with exit code of `<int>` - `health`=(`starting`, `healthy`, `unhealthy` or `none`) - `id=<ID>` a container's ID - `is-task`=(`true` or `false`) - `label`=(`key` or `\"key=value\"`) of a container label - `name=<name>` a container's name - `network`=(`<network id>` or `<network name>`) - `publish`=(`<port>[/<proto>]` or `<startport-endport>/[<proto>]`) - `since`=(`<container id>` or `<container name>`) - `status`=(`created`, `restarting`, `running`, `removing`, `paused`, `exited` or `dead`) - `volume`=(`<volume name>` or `<mount point destination>`) (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 List Containers -
      400 Bad parameter in request -
      500 Internal server error -

    • containerLogsCall

      public okhttp3.Call containerLogsCall(String name, Boolean follow, Boolean stdout, Boolean stderr, String since, String until, Boolean timestamps, String tail, ApiCallback _callback) throws ApiException
      Build call for containerLogs
      Parameters:
      name - the name or ID of the container (required)
      follow - Keep connection after returning logs. (optional)
      stdout - Return logs from stdout (optional)
      stderr - Return logs from stderr (optional)
      since - Only return logs since this time, as a UNIX timestamp (optional)
      until - Only return logs before this time, as a UNIX timestamp (optional)
      timestamps - Add timestamps to every log line (optional, default to false)
      tail - Only return this number of log lines from the end of the logs (optional, default to all)
      _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 logs returned as a stream in response body. -
      404 No such container -
      500 Internal server error -

    • containerLogs

      public void containerLogs(String name, Boolean follow, Boolean stdout, Boolean stderr, String since, String until, Boolean timestamps, String tail) throws ApiException
      Get container logs Get stdout and stderr logs from a container.
      Parameters:
      name - the name or ID of the container (required)
      follow - Keep connection after returning logs. (optional)
      stdout - Return logs from stdout (optional)
      stderr - Return logs from stderr (optional)
      since - Only return logs since this time, as a UNIX timestamp (optional)
      until - Only return logs before this time, as a UNIX timestamp (optional)
      timestamps - Add timestamps to every log line (optional, default to false)
      tail - Only return this number of log lines from the end of the logs (optional, default to all)
      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 logs returned as a stream in response body. -
      404 No such container -
      500 Internal server error -

    • containerLogsWithHttpInfo

      public ApiResponse<Void> containerLogsWithHttpInfo(String name, Boolean follow, Boolean stdout, Boolean stderr, String since, String until, Boolean timestamps, String tail) throws ApiException
      Get container logs Get stdout and stderr logs from a container.
      Parameters:
      name - the name or ID of the container (required)
      follow - Keep connection after returning logs. (optional)
      stdout - Return logs from stdout (optional)
      stderr - Return logs from stderr (optional)
      since - Only return logs since this time, as a UNIX timestamp (optional)
      until - Only return logs before this time, as a UNIX timestamp (optional)
      timestamps - Add timestamps to every log line (optional, default to false)
      tail - Only return this number of log lines from the end of the logs (optional, default to all)
      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 logs returned as a stream in response body. -
      404 No such container -
      500 Internal server error -

    • containerLogsAsync

      public okhttp3.Call containerLogsAsync(String name, Boolean follow, Boolean stdout, Boolean stderr, String since, String until, Boolean timestamps, String tail, ApiCallback<Void> _callback) throws ApiException
      Get container logs (asynchronously) Get stdout and stderr logs from a container.
      Parameters:
      name - the name or ID of the container (required)
      follow - Keep connection after returning logs. (optional)
      stdout - Return logs from stdout (optional)
      stderr - Return logs from stderr (optional)
      since - Only return logs since this time, as a UNIX timestamp (optional)
      until - Only return logs before this time, as a UNIX timestamp (optional)
      timestamps - Add timestamps to every log line (optional, default to false)
      tail - Only return this number of log lines from the end of the logs (optional, default to all)
      _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 logs returned as a stream in response body. -
      404 No such container -
      500 Internal server error -

    • containerPauseCall

      public okhttp3.Call containerPauseCall(String name, ApiCallback _callback) throws ApiException
      Build call for containerPause
      Parameters:
      name - the name or ID of the container (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
      204 no error -
      404 No such container -
      500 Internal server error -

    • containerPause

      public void containerPause(String name) throws ApiException
      Pause container Use the cgroups freezer to suspend all processes in a container.
      Parameters:
      name - the name or ID of the container (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
      204 no error -
      404 No such container -
      500 Internal server error -

    • containerPauseWithHttpInfo

      public ApiResponse<Void> containerPauseWithHttpInfo(String name) throws ApiException
      Pause container Use the cgroups freezer to suspend all processes in a container.
      Parameters:
      name - the name or ID of the container (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
      204 no error -
      404 No such container -
      500 Internal server error -

    • containerPauseAsync

      public okhttp3.Call containerPauseAsync(String name, ApiCallback<Void> _callback) throws ApiException
      Pause container (asynchronously) Use the cgroups freezer to suspend all processes in a container.
      Parameters:
      name - the name or ID of the container (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
      204 no error -
      404 No such container -
      500 Internal server error -

    • containerPruneCall

      public okhttp3.Call containerPruneCall(String filters, ApiCallback _callback) throws ApiException
      Build call for containerPrune
      Parameters:
      filters - Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters: - `until=<timestamp>` Prune containers created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune containers with (or without, in case `label!=...` is used) the specified labels. (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 Prune Containers -
      500 Internal server error -

    • containerPrune

      public List<ContainersPruneReport> containerPrune(String filters) throws ApiException
      Delete stopped containers Remove containers not in use
      Parameters:
      filters - Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters: - `until=<timestamp>` Prune containers created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune containers with (or without, in case `label!=...` is used) the specified labels. (optional)
      Returns:
      List<ContainersPruneReport>
      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 Prune Containers -
      500 Internal server error -

    • containerPruneWithHttpInfo

      public ApiResponse<List<ContainersPruneReport>> containerPruneWithHttpInfo(String filters) throws ApiException
      Delete stopped containers Remove containers not in use
      Parameters:
      filters - Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters: - `until=<timestamp>` Prune containers created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune containers with (or without, in case `label!=...` is used) the specified labels. (optional)
      Returns:
      ApiResponse<List<ContainersPruneReport>>
      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 Prune Containers -
      500 Internal server error -

    • containerPruneAsync

      public okhttp3.Call containerPruneAsync(String filters, ApiCallback<List<ContainersPruneReport>> _callback) throws ApiException
      Delete stopped containers (asynchronously) Remove containers not in use
      Parameters:
      filters - Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters: - `until=<timestamp>` Prune containers created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune containers with (or without, in case `label!=...` is used) the specified labels. (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 Prune Containers -
      500 Internal server error -

    • containerRenameCall

      public okhttp3.Call containerRenameCall(String name, String name2, ApiCallback _callback) throws ApiException
      Build call for containerRename
      Parameters:
      name - Full or partial ID or full name of the container to rename (required)
      name2 - New name for the container (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
      204 no error -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerRename

      public void containerRename(String name, String name2) throws ApiException
      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)
      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
      204 no error -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerRenameWithHttpInfo

      public ApiResponse<Void> containerRenameWithHttpInfo(String name, String name2) throws ApiException
      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:
      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
      204 no error -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerRenameAsync

      public okhttp3.Call containerRenameAsync(String name, String name2, ApiCallback<Void> _callback) throws ApiException
      Rename an existing container (asynchronously) 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)
      _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
      204 no error -
      404 No such container -
      409 Conflict error in operation -
      500 Internal server error -

    • containerResizeCall

      public okhttp3.Call containerResizeCall(String name, Integer h, Integer w, Boolean running, ApiCallback _callback) throws ApiException
      Build call for containerResize
      Parameters:
      name - the name or ID of the container (required)
      h - Height to set for the terminal, in characters (optional)
      w - Width to set for the terminal, 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
      200 Success -
      404 No such container -
      500 Internal server error -

    • containerResize

      public Object containerResize(String name, Integer h, Integer w, Boolean running) throws ApiException
      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)
      h - Height to set for the terminal, in characters (optional)
      w - Width to set for the terminal, in characters (optional)
      running - Ignore containers not running errors (optional)
      Returns:
      Object
      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 Success -
      404 No such container -
      500 Internal server error -

    • containerResizeWithHttpInfo

      public ApiResponse<Object> containerResizeWithHttpInfo(String name, Integer h, Integer w, Boolean running) throws ApiException
      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)
      h - Height to set for the terminal, in characters (optional)
      w - Width to set for the terminal, in characters (optional)
      running - Ignore containers not running errors (optional)
      Returns:
      ApiResponse<Object>
      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 Success -
      404 No such container -
      500 Internal server error -

    • containerResizeAsync

      public okhttp3.Call containerResizeAsync(String name, Integer h, Integer w, Boolean running, ApiCallback<Object> _callback) throws ApiException
      Resize a container's TTY (asynchronously) Resize the terminal attached to a container (for use with Attach).
      Parameters:
      name - the name or ID of the container (required)
      h - Height to set for the terminal, in characters (optional)
      w - Width to set for the terminal, 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
      200 Success -
      404 No such container -
      500 Internal server error -

    • containerRestartCall

      public okhttp3.Call containerRestartCall(String name, Integer t, ApiCallback _callback) throws ApiException
      Build call for containerRestart
      Parameters:
      name - the name or ID of the container (required)
      t - timeout before sending kill signal to container (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
      204 no error -
      404 No such container -
      500 Internal server error -

    • containerRestart

      public void containerRestart(String name, Integer t) throws ApiException
      Restart container
      Parameters:
      name - the name or ID of the container (required)
      t - timeout before sending kill signal to container (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
      204 no error -
      404 No such container -
      500 Internal server error -

    • containerRestartWithHttpInfo

      public ApiResponse<Void> containerRestartWithHttpInfo(String name, Integer t) throws ApiException
      Restart container
      Parameters:
      name - the name or ID of the container (required)
      t - timeout before sending kill signal to container (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
      204 no error -
      404 No such container -
      500 Internal server error -

    • containerRestartAsync

      public okhttp3.Call containerRestartAsync(String name, Integer t, ApiCallback<Void> _callback) throws ApiException
      Restart container (asynchronously)
      Parameters:
      name - the name or ID of the container (required)
      t - timeout before sending kill signal to container (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
      204 no error -
      404 No such container -
      500 Internal server error -

    • containerStartCall

      public okhttp3.Call containerStartCall(String name, String detachKeys, ApiCallback _callback) throws ApiException
      Build call for containerStart
      Parameters:
      name - the name or ID of the container (required)
      detachKeys - Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _. (optional, default to ctrl-p,ctrl-q)
      _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
      204 no error -
      304 Container already started -
      404 No such container -
      500 Internal server error -

    • containerStart

      public void containerStart(String name, String detachKeys) throws ApiException
      Start a container
      Parameters:
      name - the name or ID of the container (required)
      detachKeys - Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _. (optional, default to ctrl-p,ctrl-q)
      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
      204 no error -
      304 Container already started -
      404 No such container -
      500 Internal server error -

    • containerStartWithHttpInfo

      public ApiResponse<Void> containerStartWithHttpInfo(String name, String detachKeys) throws ApiException
      Start a container
      Parameters:
      name - the name or ID of the container (required)
      detachKeys - Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _. (optional, default to ctrl-p,ctrl-q)
      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
      204 no error -
      304 Container already started -
      404 No such container -
      500 Internal server error -

    • containerStartAsync

      public okhttp3.Call containerStartAsync(String name, String detachKeys, ApiCallback<Void> _callback) throws ApiException
      Start a container (asynchronously)
      Parameters:
      name - the name or ID of the container (required)
      detachKeys - Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _. (optional, default to ctrl-p,ctrl-q)
      _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
      204 no error -
      304 Container already started -
      404 No such container -
      500 Internal server error -

    • containerStatsCall

      public okhttp3.Call containerStatsCall(String name, Boolean stream, Boolean oneShot, ApiCallback _callback) throws ApiException
      Build call for containerStats
      Parameters:
      name - the name or ID of the container (required)
      stream - Stream the output (optional, default to true)
      oneShot - Provide a one-shot response in which preCPU stats are blank, resulting in a single cycle return. (optional, default to false)
      _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 container -
      500 Internal server error -

    • containerStats

      public Object containerStats(String name, Boolean stream, Boolean oneShot) throws ApiException
      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)
      stream - Stream the output (optional, default to true)
      oneShot - Provide a one-shot response in which preCPU stats are blank, resulting in a single cycle return. (optional, default to false)
      Returns:
      Object
      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 container -
      500 Internal server error -

    • containerStatsWithHttpInfo

      public ApiResponse<Object> containerStatsWithHttpInfo(String name, Boolean stream, Boolean oneShot) throws ApiException
      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)
      stream - Stream the output (optional, default to true)
      oneShot - Provide a one-shot response in which preCPU stats are blank, resulting in a single cycle return. (optional, default to false)
      Returns:
      ApiResponse<Object>
      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 container -
      500 Internal server error -

    • containerStatsAsync

      public okhttp3.Call containerStatsAsync(String name, Boolean stream, Boolean oneShot, ApiCallback<Object> _callback) throws ApiException
      Get stats for a container (asynchronously) This returns a live stream of a container’s resource usage statistics.
      Parameters:
      name - the name or ID of the container (required)
      stream - Stream the output (optional, default to true)
      oneShot - Provide a one-shot response in which preCPU stats are blank, resulting in a single cycle return. (optional, default to false)
      _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 container -
      500 Internal server error -

    • containerStopCall

      public okhttp3.Call containerStopCall(String name, Integer t, ApiCallback _callback) throws ApiException
      Build call for containerStop
      Parameters:
      name - the name or ID of the container (required)
      t - number of seconds to wait before killing container (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
      204 no error -
      304 Container already stopped -
      404 No such container -
      500 Internal server error -

    • containerStop

      public void containerStop(String name, Integer t) throws ApiException
      Stop a container Stop a container
      Parameters:
      name - the name or ID of the container (required)
      t - number of seconds to wait before killing container (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
      204 no error -
      304 Container already stopped -
      404 No such container -
      500 Internal server error -

    • containerStopWithHttpInfo

      public ApiResponse<Void> containerStopWithHttpInfo(String name, Integer t) throws ApiException
      Stop a container Stop a container
      Parameters:
      name - the name or ID of the container (required)
      t - number of seconds to wait before killing container (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
      204 no error -
      304 Container already stopped -
      404 No such container -
      500 Internal server error -

    • containerStopAsync

      public okhttp3.Call containerStopAsync(String name, Integer t, ApiCallback<Void> _callback) throws ApiException
      Stop a container (asynchronously) Stop a container
      Parameters:
      name - the name or ID of the container (required)
      t - number of seconds to wait before killing container (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
      204 no error -
      304 Container already stopped -
      404 No such container -
      500 Internal server error -

    • containerTopCall

      public okhttp3.Call containerTopCall(String name, String psArgs, ApiCallback _callback) throws ApiException
      Build call for containerTop
      Parameters:
      name - the name or ID of the container (required)
      psArgs - arguments to pass to ps such as aux. (optional, default to -ef)
      _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 List processes in container -
      404 No such container -
      500 Internal server error -

    • containerTop

      public ContainerTopOKBody containerTop(String name, String psArgs) throws ApiException
      List processes running inside a container
      Parameters:
      name - the name or ID of the container (required)
      psArgs - arguments to pass to ps such as aux. (optional, default to -ef)
      Returns:
      ContainerTopOKBody
      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 List processes in container -
      404 No such container -
      500 Internal server error -

    • containerTopWithHttpInfo

      public ApiResponse<ContainerTopOKBody> containerTopWithHttpInfo(String name, String psArgs) throws ApiException
      List processes running inside a container
      Parameters:
      name - the name or ID of the container (required)
      psArgs - arguments to pass to ps such as aux. (optional, default to -ef)
      Returns:
      ApiResponse<ContainerTopOKBody>
      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 List processes in container -
      404 No such container -
      500 Internal server error -

    • containerTopAsync

      public okhttp3.Call containerTopAsync(String name, String psArgs, ApiCallback<ContainerTopOKBody> _callback) throws ApiException
      List processes running inside a container (asynchronously)
      Parameters:
      name - the name or ID of the container (required)
      psArgs - arguments to pass to ps such as aux. (optional, default to -ef)
      _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 List processes in container -
      404 No such container -
      500 Internal server error -

    • containerUnpauseCall

      public okhttp3.Call containerUnpauseCall(String name, ApiCallback _callback) throws ApiException
      Build call for containerUnpause
      Parameters:
      name - the name or ID of the container (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
      204 no error -
      404 No such container -
      500 Internal server error -

    • containerUnpause

      public void containerUnpause(String name) throws ApiException
      Unpause container Resume a paused container
      Parameters:
      name - the name or ID of the container (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
      204 no error -
      404 No such container -
      500 Internal server error -

    • containerUnpauseWithHttpInfo

      public ApiResponse<Void> containerUnpauseWithHttpInfo(String name) throws ApiException
      Unpause container Resume a paused container
      Parameters:
      name - the name or ID of the container (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
      204 no error -
      404 No such container -
      500 Internal server error -

    • containerUnpauseAsync

      public okhttp3.Call containerUnpauseAsync(String name, ApiCallback<Void> _callback) throws ApiException
      Unpause container (asynchronously) Resume a paused container
      Parameters:
      name - the name or ID of the container (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
      204 no error -
      404 No such container -
      500 Internal server error -

    • containerUpdateCall

      public okhttp3.Call containerUpdateCall(String name, UpdateConfig resources, ApiCallback _callback) throws ApiException
      Build call for containerUpdate
      Parameters:
      name - Full or partial ID or full name of the container to rename (required)
      resources - attributes for updating the container (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 container -
      500 Internal server error -

    • containerUpdate

      public void containerUpdate(String name, UpdateConfig resources) throws ApiException
      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)
      resources - attributes for updating the container (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 container -
      500 Internal server error -

    • containerUpdateWithHttpInfo

      public ApiResponse<Void> containerUpdateWithHttpInfo(String name, UpdateConfig resources) throws ApiException
      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)
      resources - attributes for updating the container (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 container -
      500 Internal server error -

    • containerUpdateAsync

      public okhttp3.Call containerUpdateAsync(String name, UpdateConfig resources, ApiCallback<Void> _callback) throws ApiException
      Update configuration of an existing container (asynchronously) 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)
      resources - attributes for updating the container (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 container -
      500 Internal server error -

    • containerWaitCall

      public okhttp3.Call containerWaitCall(String name, String condition, String interval, ApiCallback _callback) throws ApiException
      Build call for containerWait
      Parameters:
      name - the name or ID of the container (required)
      condition - wait until container is to a given condition. default is stopped. valid conditions are: - configured - created - exited - paused - running - stopped (optional)
      interval - Time Interval to wait before polling for completion. (optional, default to 250ms)
      _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 Wait container -
      404 No such container -
      500 Internal server error -

    • containerWait

      public ContainerWait200Response containerWait(String name, String condition, String interval) throws ApiException
      Wait on a container Block until a container stops or given condition is met.
      Parameters:
      name - the name or ID of the container (required)
      condition - wait until container is to a given condition. default is stopped. valid conditions are: - configured - created - exited - paused - running - stopped (optional)
      interval - Time Interval to wait before polling for completion. (optional, default to 250ms)
      Returns:
      ContainerWait200Response
      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 Wait container -
      404 No such container -
      500 Internal server error -

    • containerWaitWithHttpInfo

      public ApiResponse<ContainerWait200Response> containerWaitWithHttpInfo(String name, String condition, String interval) throws ApiException
      Wait on a container Block until a container stops or given condition is met.
      Parameters:
      name - the name or ID of the container (required)
      condition - wait until container is to a given condition. default is stopped. valid conditions are: - configured - created - exited - paused - running - stopped (optional)
      interval - Time Interval to wait before polling for completion. (optional, default to 250ms)
      Returns:
      ApiResponse<ContainerWait200Response>
      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 Wait container -
      404 No such container -
      500 Internal server error -

    • containerWaitAsync

      public okhttp3.Call containerWaitAsync(String name, String condition, String interval, ApiCallback<ContainerWait200Response> _callback) throws ApiException
      Wait on a container (asynchronously) Block until a container stops or given condition is met.
      Parameters:
      name - the name or ID of the container (required)
      condition - wait until container is to a given condition. default is stopped. valid conditions are: - configured - created - exited - paused - running - stopped (optional)
      interval - Time Interval to wait before polling for completion. (optional, default to 250ms)
      _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 Wait container -
      404 No such container -
      500 Internal server error -

    • imageCommitCall

      public okhttp3.Call imageCommitCall(String container, String repo, String tag, String comment, String author, Boolean pause, String changes, Boolean squash, ApiCallback _callback) throws ApiException
      Build call for imageCommit
      Parameters:
      container - the name or ID of a container (optional)
      repo - the repository name for the created image (optional)
      tag - tag name for the created image (optional)
      comment - commit message (optional)
      author - author of the image (optional)
      pause - pause the container before committing it (optional)
      changes - instructions to apply while committing in Dockerfile format (optional)
      squash - squash newly built layers into a single new layer (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 image -
      500 Internal server error -

    • imageCommit

      public void imageCommit(String container, String repo, String tag, String comment, String author, Boolean pause, String changes, Boolean squash) throws ApiException
      New Image Create a new image from a container
      Parameters:
      container - the name or ID of a container (optional)
      repo - the repository name for the created image (optional)
      tag - tag name for the created image (optional)
      comment - commit message (optional)
      author - author of the image (optional)
      pause - pause the container before committing it (optional)
      changes - instructions to apply while committing in Dockerfile format (optional)
      squash - squash newly built layers into a single new layer (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 image -
      500 Internal server error -

    • imageCommitWithHttpInfo

      public ApiResponse<Void> imageCommitWithHttpInfo(String container, String repo, String tag, String comment, String author, Boolean pause, String changes, Boolean squash) throws ApiException
      New Image Create a new image from a container
      Parameters:
      container - the name or ID of a container (optional)
      repo - the repository name for the created image (optional)
      tag - tag name for the created image (optional)
      comment - commit message (optional)
      author - author of the image (optional)
      pause - pause the container before committing it (optional)
      changes - instructions to apply while committing in Dockerfile format (optional)
      squash - squash newly built layers into a single new layer (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 image -
      500 Internal server error -

    • imageCommitAsync

      public okhttp3.Call imageCommitAsync(String container, String repo, String tag, String comment, String author, Boolean pause, String changes, Boolean squash, ApiCallback<Void> _callback) throws ApiException
      New Image (asynchronously) Create a new image from a container
      Parameters:
      container - the name or ID of a container (optional)
      repo - the repository name for the created image (optional)
      tag - tag name for the created image (optional)
      comment - commit message (optional)
      author - author of the image (optional)
      pause - pause the container before committing it (optional)
      changes - instructions to apply while committing in Dockerfile format (optional)
      squash - squash newly built layers into a single new layer (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 image -
      500 Internal server error -

    • putContainerArchiveCall

      public okhttp3.Call putContainerArchiveCall(String name, String path, String noOverwriteDirNonDir, String copyUIDGID, String request, ApiCallback _callback) throws ApiException
      Build call for putContainerArchive
      Parameters:
      name - container name or id (required)
      path - Path to a directory in the container to extract (required)
      noOverwriteDirNonDir - if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa (1 or true) (optional)
      copyUIDGID - copy UID/GID maps to the dest file or di (1 or true) (optional)
      request - tarfile of files to copy into the container (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 -
      400 Bad parameter in request -
      403 the container rootfs is read-only -
      404 No such container -
      500 Internal server error -

    • putContainerArchive

      public void putContainerArchive(String name, String path, String noOverwriteDirNonDir, String copyUIDGID, String request) throws ApiException
      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)
      noOverwriteDirNonDir - if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa (1 or true) (optional)
      copyUIDGID - copy UID/GID maps to the dest file or di (1 or true) (optional)
      request - tarfile of files to copy into the container (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 -
      400 Bad parameter in request -
      403 the container rootfs is read-only -
      404 No such container -
      500 Internal server error -

    • putContainerArchiveWithHttpInfo

      public ApiResponse<Void> putContainerArchiveWithHttpInfo(String name, String path, String noOverwriteDirNonDir, String copyUIDGID, String request) throws ApiException
      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)
      noOverwriteDirNonDir - if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa (1 or true) (optional)
      copyUIDGID - copy UID/GID maps to the dest file or di (1 or true) (optional)
      request - tarfile of files to copy into the container (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 -
      400 Bad parameter in request -
      403 the container rootfs is read-only -
      404 No such container -
      500 Internal server error -

    • putContainerArchiveAsync

      public okhttp3.Call putContainerArchiveAsync(String name, String path, String noOverwriteDirNonDir, String copyUIDGID, String request, ApiCallback<Void> _callback) throws ApiException
      Put files into a container (asynchronously) 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)
      noOverwriteDirNonDir - if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa (1 or true) (optional)
      copyUIDGID - copy UID/GID maps to the dest file or di (1 or true) (optional)
      request - tarfile of files to copy into the container (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 -
      400 Bad parameter in request -
      403 the container rootfs is read-only -
      404 No such container -
      500 Internal server error -