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

Class ContainersCompatApi.APIcontainerListRequest

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

  • Method Details

    • all

      public ContainersCompatApi.APIcontainerListRequest all(Boolean all)
      Set all
      Parameters:
      all - Return all containers. By default, only running containers are shown (optional, default to false)
      Returns:
      APIcontainerListRequest

    • external

      public ContainersCompatApi.APIcontainerListRequest external(Boolean external)
      Set external
      Parameters:
      external - Return containers in storage not controlled by Podman (optional, default to false)
      Returns:
      APIcontainerListRequest

    • limit

      public ContainersCompatApi.APIcontainerListRequest limit(Integer limit)
      Set limit
      Parameters:
      limit - Return this number of most recently created containers, including non-running ones. (optional)
      Returns:
      APIcontainerListRequest

    • size

      public ContainersCompatApi.APIcontainerListRequest size(Boolean size)
      Set size
      Parameters:
      size - Return the size of container as fields SizeRw and SizeRootFs. (optional, default to false)
      Returns:
      APIcontainerListRequest

    • filters

      public ContainersCompatApi.APIcontainerListRequest filters(String filters)
      Set filters
      Parameters:
      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:
      APIcontainerListRequest

    • buildCall

      public okhttp3.Call buildCall(ApiCallback _callback) throws ApiException
      Build call for containerList
      Parameters:
      _callback - ApiCallback API callback
      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 -

    • execute

      public List<Container> execute() throws ApiException
      Execute containerList request
      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 -

    • executeWithHttpInfo

      public ApiResponse<List<Container>> executeWithHttpInfo() throws ApiException
      Execute containerList request with HTTP info returned
      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 -

    • executeAsync

      public okhttp3.Call executeAsync(ApiCallback<List<Container>> _callback) throws ApiException
      Execute containerList request (asynchronously)
      Parameters:
      _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 -