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

Class PodsApi

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

  • Constructor Details

    • PodsApi

      public PodsApi()

    • PodsApi

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

    • generateKubeLibpodCall

      public okhttp3.Call generateKubeLibpodCall(List<String> names, Boolean service, String type, Integer replicas, Boolean noTrunc, Boolean podmanOnly, ApiCallback _callback) throws ApiException
      Build call for generateKubeLibpod
      Parameters:
      names - Name or ID of the container or pod. (required)
      service - Generate YAML for a Kubernetes service object. (optional, default to false)
      type - Generate YAML for the given Kubernetes kind. (optional, default to pod)
      replicas - Set the replica number for Deployment kind. (optional, default to 0)
      noTrunc - don't truncate annotations to the Kubernetes maximum length of 63 characters (optional, default to false)
      podmanOnly - add podman-only reserved annotations in generated YAML file (cannot be used by Kubernetes) (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 Kubernetes YAML file describing pod -
      500 Internal server error -

    • generateKubeLibpod

      public File generateKubeLibpod(List<String> names, Boolean service, String type, Integer replicas, Boolean noTrunc, Boolean podmanOnly) throws ApiException
      Generate a Kubernetes YAML file. Generate Kubernetes YAML based on a pod or container.
      Parameters:
      names - Name or ID of the container or pod. (required)
      service - Generate YAML for a Kubernetes service object. (optional, default to false)
      type - Generate YAML for the given Kubernetes kind. (optional, default to pod)
      replicas - Set the replica number for Deployment kind. (optional, default to 0)
      noTrunc - don't truncate annotations to the Kubernetes maximum length of 63 characters (optional, default to false)
      podmanOnly - add podman-only reserved annotations in generated YAML file (cannot be used by Kubernetes) (optional, default to false)
      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 Kubernetes YAML file describing pod -
      500 Internal server error -

    • generateKubeLibpodWithHttpInfo

      public ApiResponse<File> generateKubeLibpodWithHttpInfo(@NotNull @NotNull List<String> names, Boolean service, String type, Integer replicas, Boolean noTrunc, Boolean podmanOnly) throws ApiException
      Generate a Kubernetes YAML file. Generate Kubernetes YAML based on a pod or container.
      Parameters:
      names - Name or ID of the container or pod. (required)
      service - Generate YAML for a Kubernetes service object. (optional, default to false)
      type - Generate YAML for the given Kubernetes kind. (optional, default to pod)
      replicas - Set the replica number for Deployment kind. (optional, default to 0)
      noTrunc - don't truncate annotations to the Kubernetes maximum length of 63 characters (optional, default to false)
      podmanOnly - add podman-only reserved annotations in generated YAML file (cannot be used by Kubernetes) (optional, default to false)
      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 Kubernetes YAML file describing pod -
      500 Internal server error -

    • generateKubeLibpodAsync

      public okhttp3.Call generateKubeLibpodAsync(List<String> names, Boolean service, String type, Integer replicas, Boolean noTrunc, Boolean podmanOnly, ApiCallback<File> _callback) throws ApiException
      Generate a Kubernetes YAML file. (asynchronously) Generate Kubernetes YAML based on a pod or container.
      Parameters:
      names - Name or ID of the container or pod. (required)
      service - Generate YAML for a Kubernetes service object. (optional, default to false)
      type - Generate YAML for the given Kubernetes kind. (optional, default to pod)
      replicas - Set the replica number for Deployment kind. (optional, default to 0)
      noTrunc - don't truncate annotations to the Kubernetes maximum length of 63 characters (optional, default to false)
      podmanOnly - add podman-only reserved annotations in generated YAML file (cannot be used by Kubernetes) (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 Kubernetes YAML file describing pod -
      500 Internal server error -

    • generateSystemdLibpodCall

      public okhttp3.Call generateSystemdLibpodCall(String name, Boolean useName, Boolean _new, Boolean noHeader, Integer startTimeout, Integer stopTimeout, String restartPolicy, String containerPrefix, String podPrefix, String separator, Integer restartSec, List<String> wants, List<String> after, List<String> requires, List<String> additionalEnvVariables, ApiCallback _callback) throws ApiException
      Build call for generateSystemdLibpod
      Parameters:
      name - Name or ID of the container or pod. (required)
      useName - Use container/pod names instead of IDs. (optional, default to false)
      _new - Create a new container instead of starting an existing one. (optional, default to false)
      noHeader - Do not generate the header including the Podman version and the timestamp. (optional, default to false)
      startTimeout - Start timeout in seconds. (optional, default to 0)
      stopTimeout - Stop timeout in seconds. (optional, default to 10)
      restartPolicy - Systemd restart-policy. (optional, default to on-failure)
      containerPrefix - Systemd unit name prefix for containers. (optional, default to container)
      podPrefix - Systemd unit name prefix for pods. (optional, default to pod)
      separator - Systemd unit name separator between name/id and prefix. (optional, default to -)
      restartSec - Configures the time to sleep before restarting a service. (optional, default to 0)
      wants - Systemd Wants list for the container or pods. (optional)
      after - Systemd After list for the container or pods. (optional)
      requires - Systemd Requires list for the container or pods. (optional)
      additionalEnvVariables - Set environment variables to the systemd unit files. (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 -
      500 Internal server error -

    • generateSystemdLibpod

      public Map<String,String> generateSystemdLibpod(String name, Boolean useName, Boolean _new, Boolean noHeader, Integer startTimeout, Integer stopTimeout, String restartPolicy, String containerPrefix, String podPrefix, String separator, Integer restartSec, List<String> wants, List<String> after, List<String> requires, List<String> additionalEnvVariables) throws ApiException
      Generate Systemd Units Generate Systemd Units based on a pod or container.
      Parameters:
      name - Name or ID of the container or pod. (required)
      useName - Use container/pod names instead of IDs. (optional, default to false)
      _new - Create a new container instead of starting an existing one. (optional, default to false)
      noHeader - Do not generate the header including the Podman version and the timestamp. (optional, default to false)
      startTimeout - Start timeout in seconds. (optional, default to 0)
      stopTimeout - Stop timeout in seconds. (optional, default to 10)
      restartPolicy - Systemd restart-policy. (optional, default to on-failure)
      containerPrefix - Systemd unit name prefix for containers. (optional, default to container)
      podPrefix - Systemd unit name prefix for pods. (optional, default to pod)
      separator - Systemd unit name separator between name/id and prefix. (optional, default to -)
      restartSec - Configures the time to sleep before restarting a service. (optional, default to 0)
      wants - Systemd Wants list for the container or pods. (optional)
      after - Systemd After list for the container or pods. (optional)
      requires - Systemd Requires list for the container or pods. (optional)
      additionalEnvVariables - Set environment variables to the systemd unit files. (optional)
      Returns:
      Map<String, String>
      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 -
      500 Internal server error -

    • generateSystemdLibpodWithHttpInfo

      public ApiResponse<Map<String,String>> generateSystemdLibpodWithHttpInfo(@NotNull @NotNull String name, Boolean useName, Boolean _new, Boolean noHeader, Integer startTimeout, Integer stopTimeout, String restartPolicy, String containerPrefix, String podPrefix, String separator, Integer restartSec, List<String> wants, List<String> after, List<String> requires, List<String> additionalEnvVariables) throws ApiException
      Generate Systemd Units Generate Systemd Units based on a pod or container.
      Parameters:
      name - Name or ID of the container or pod. (required)
      useName - Use container/pod names instead of IDs. (optional, default to false)
      _new - Create a new container instead of starting an existing one. (optional, default to false)
      noHeader - Do not generate the header including the Podman version and the timestamp. (optional, default to false)
      startTimeout - Start timeout in seconds. (optional, default to 0)
      stopTimeout - Stop timeout in seconds. (optional, default to 10)
      restartPolicy - Systemd restart-policy. (optional, default to on-failure)
      containerPrefix - Systemd unit name prefix for containers. (optional, default to container)
      podPrefix - Systemd unit name prefix for pods. (optional, default to pod)
      separator - Systemd unit name separator between name/id and prefix. (optional, default to -)
      restartSec - Configures the time to sleep before restarting a service. (optional, default to 0)
      wants - Systemd Wants list for the container or pods. (optional)
      after - Systemd After list for the container or pods. (optional)
      requires - Systemd Requires list for the container or pods. (optional)
      additionalEnvVariables - Set environment variables to the systemd unit files. (optional)
      Returns:
      ApiResponse<Map<String, String>>
      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 -
      500 Internal server error -

    • generateSystemdLibpodAsync

      public okhttp3.Call generateSystemdLibpodAsync(String name, Boolean useName, Boolean _new, Boolean noHeader, Integer startTimeout, Integer stopTimeout, String restartPolicy, String containerPrefix, String podPrefix, String separator, Integer restartSec, List<String> wants, List<String> after, List<String> requires, List<String> additionalEnvVariables, ApiCallback<Map<String,String>> _callback) throws ApiException
      Generate Systemd Units (asynchronously) Generate Systemd Units based on a pod or container.
      Parameters:
      name - Name or ID of the container or pod. (required)
      useName - Use container/pod names instead of IDs. (optional, default to false)
      _new - Create a new container instead of starting an existing one. (optional, default to false)
      noHeader - Do not generate the header including the Podman version and the timestamp. (optional, default to false)
      startTimeout - Start timeout in seconds. (optional, default to 0)
      stopTimeout - Stop timeout in seconds. (optional, default to 10)
      restartPolicy - Systemd restart-policy. (optional, default to on-failure)
      containerPrefix - Systemd unit name prefix for containers. (optional, default to container)
      podPrefix - Systemd unit name prefix for pods. (optional, default to pod)
      separator - Systemd unit name separator between name/id and prefix. (optional, default to -)
      restartSec - Configures the time to sleep before restarting a service. (optional, default to 0)
      wants - Systemd Wants list for the container or pods. (optional)
      after - Systemd After list for the container or pods. (optional)
      requires - Systemd Requires list for the container or pods. (optional)
      additionalEnvVariables - Set environment variables to the systemd unit files. (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 -
      500 Internal server error -

    • kubeApplyLibpodCall

      public okhttp3.Call kubeApplyLibpodCall(String caCertFile, String kubeConfig, String namespace, Boolean service, String _file, String request, ApiCallback _callback) throws ApiException
      Build call for kubeApplyLibpod
      Parameters:
      caCertFile - Path to the CA cert file for the Kubernetes cluster. (optional)
      kubeConfig - Path to the kubeconfig file for the Kubernetes cluster. (optional)
      namespace - The namespace to deploy the workload to on the Kubernetes cluster. (optional)
      service - Create a service object for the container being deployed. (optional)
      _file - Path to the Kubernetes yaml file to deploy. (optional)
      request - Kubernetes YAML file. (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 Kubernetes YAML file successfully deployed to cluster -
      500 Internal server error -

    • kubeApplyLibpod

      public File kubeApplyLibpod(String caCertFile, String kubeConfig, String namespace, Boolean service, String _file, String request) throws ApiException
      Apply a podman workload or Kubernetes YAML file. Deploy a podman container, pod, volume, or Kubernetes yaml to a Kubernetes cluster.
      Parameters:
      caCertFile - Path to the CA cert file for the Kubernetes cluster. (optional)
      kubeConfig - Path to the kubeconfig file for the Kubernetes cluster. (optional)
      namespace - The namespace to deploy the workload to on the Kubernetes cluster. (optional)
      service - Create a service object for the container being deployed. (optional)
      _file - Path to the Kubernetes yaml file to deploy. (optional)
      request - Kubernetes YAML file. (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 Kubernetes YAML file successfully deployed to cluster -
      500 Internal server error -

    • kubeApplyLibpodWithHttpInfo

      public ApiResponse<File> kubeApplyLibpodWithHttpInfo(String caCertFile, String kubeConfig, String namespace, Boolean service, String _file, String request) throws ApiException
      Apply a podman workload or Kubernetes YAML file. Deploy a podman container, pod, volume, or Kubernetes yaml to a Kubernetes cluster.
      Parameters:
      caCertFile - Path to the CA cert file for the Kubernetes cluster. (optional)
      kubeConfig - Path to the kubeconfig file for the Kubernetes cluster. (optional)
      namespace - The namespace to deploy the workload to on the Kubernetes cluster. (optional)
      service - Create a service object for the container being deployed. (optional)
      _file - Path to the Kubernetes yaml file to deploy. (optional)
      request - Kubernetes YAML file. (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 Kubernetes YAML file successfully deployed to cluster -
      500 Internal server error -

    • kubeApplyLibpodAsync

      public okhttp3.Call kubeApplyLibpodAsync(String caCertFile, String kubeConfig, String namespace, Boolean service, String _file, String request, ApiCallback<File> _callback) throws ApiException
      Apply a podman workload or Kubernetes YAML file. (asynchronously) Deploy a podman container, pod, volume, or Kubernetes yaml to a Kubernetes cluster.
      Parameters:
      caCertFile - Path to the CA cert file for the Kubernetes cluster. (optional)
      kubeConfig - Path to the kubeconfig file for the Kubernetes cluster. (optional)
      namespace - The namespace to deploy the workload to on the Kubernetes cluster. (optional)
      service - Create a service object for the container being deployed. (optional)
      _file - Path to the Kubernetes yaml file to deploy. (optional)
      request - Kubernetes YAML file. (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 Kubernetes YAML file successfully deployed to cluster -
      500 Internal server error -

    • playKubeDownLibpodCall

      public okhttp3.Call playKubeDownLibpodCall(String contentType, Boolean force, String request, ApiCallback _callback) throws ApiException
      Build call for playKubeDownLibpod
      Parameters:
      contentType - (optional, default to plain/text)
      force - Remove volumes. (optional, default to false)
      request - Kubernetes YAML file. (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 PlayKube response -
      500 Internal server error -

    • playKubeDownLibpod

      public PlayKubeReport playKubeDownLibpod(String contentType, Boolean force, String request) throws ApiException
      Remove resources created from kube play Tears down pods, secrets, and volumes defined in a YAML file
      Parameters:
      contentType - (optional, default to plain/text)
      force - Remove volumes. (optional, default to false)
      request - Kubernetes YAML file. (optional)
      Returns:
      PlayKubeReport
      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 PlayKube response -
      500 Internal server error -

    • playKubeDownLibpodWithHttpInfo

      public ApiResponse<PlayKubeReport> playKubeDownLibpodWithHttpInfo(String contentType, Boolean force, String request) throws ApiException
      Remove resources created from kube play Tears down pods, secrets, and volumes defined in a YAML file
      Parameters:
      contentType - (optional, default to plain/text)
      force - Remove volumes. (optional, default to false)
      request - Kubernetes YAML file. (optional)
      Returns:
      ApiResponse<PlayKubeReport>
      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 PlayKube response -
      500 Internal server error -

    • playKubeDownLibpodAsync

      public okhttp3.Call playKubeDownLibpodAsync(String contentType, Boolean force, String request, ApiCallback<PlayKubeReport> _callback) throws ApiException
      Remove resources created from kube play (asynchronously) Tears down pods, secrets, and volumes defined in a YAML file
      Parameters:
      contentType - (optional, default to plain/text)
      force - Remove volumes. (optional, default to false)
      request - Kubernetes YAML file. (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 PlayKube response -
      500 Internal server error -

    • playKubeLibpodCall

      public okhttp3.Call playKubeLibpodCall(String contentType, String annotations, String logDriver, List<String> logOptions, List<String> network, Boolean noHosts, Boolean noTrunc, List<String> publishPorts, Boolean publishAllPorts, Boolean replace, Boolean serviceContainer, Boolean start, List<String> staticIPs, List<String> staticMACs, Boolean tlsVerify, String userns, Boolean wait, Boolean build, String request, ApiCallback _callback) throws ApiException
      Build call for playKubeLibpod
      Parameters:
      contentType - (optional, default to plain/text)
      annotations - JSON encoded value of annotations (a map[string]string). (optional)
      logDriver - Logging driver for the containers in the pod. (optional)
      logOptions - logging driver options (optional)
      network - USe the network mode or specify an array of networks. (optional)
      noHosts - do not setup /etc/hosts file in container (optional, default to false)
      noTrunc - use annotations that are not truncated to the Kubernetes maximum length of 63 characters (optional, default to false)
      publishPorts - publish a container's port, or a range of ports, to the host (optional)
      publishAllPorts - Whether to publish all ports defined in the K8S YAML file (containerPort, hostPort), if false only hostPort will be published (optional)
      replace - replace existing pods and containers (optional, default to false)
      serviceContainer - Starts a service container before all pods. (optional, default to false)
      start - Start the pod after creating it. (optional, default to true)
      staticIPs - Static IPs used for the pods. (optional)
      staticMACs - Static MACs used for the pods. (optional)
      tlsVerify - Require HTTPS and verify signatures when contacting registries. (optional, default to true)
      userns - Set the user namespace mode for the pods. (optional)
      wait - Clean up all objects created when a SIGTERM is received or pods exit. (optional, default to false)
      build - Build the images with corresponding context. (optional)
      request - Kubernetes YAML file. (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 PlayKube response -
      500 Internal server error -

    • playKubeLibpod

      public PlayKubeReport playKubeLibpod(String contentType, String annotations, String logDriver, List<String> logOptions, List<String> network, Boolean noHosts, Boolean noTrunc, List<String> publishPorts, Boolean publishAllPorts, Boolean replace, Boolean serviceContainer, Boolean start, List<String> staticIPs, List<String> staticMACs, Boolean tlsVerify, String userns, Boolean wait, Boolean build, String request) throws ApiException
      Play a Kubernetes YAML file. Create and run pods based on a Kubernetes YAML file. ### Content-Type Then endpoint support two Content-Type - `plain/text` for yaml format - `application/x-tar` for sending context(s) required for building images #### Tar format The tar format must contain a `play.yaml` file at the root that will be used. If the file format requires context to build an image, it uses the image name and check for corresponding folder. For example, the client sends a tar file with the following structure: ``` └── content.tar ├── play.yaml └── foobar/ └── Containerfile ``` The `play.yaml` is the following, the `foobar` image means we are looking for a context with this name. ``` apiVersion: v1 kind: Pod metadata: name: demo-build-remote spec: containers: - name: container image: foobar ```
      Parameters:
      contentType - (optional, default to plain/text)
      annotations - JSON encoded value of annotations (a map[string]string). (optional)
      logDriver - Logging driver for the containers in the pod. (optional)
      logOptions - logging driver options (optional)
      network - USe the network mode or specify an array of networks. (optional)
      noHosts - do not setup /etc/hosts file in container (optional, default to false)
      noTrunc - use annotations that are not truncated to the Kubernetes maximum length of 63 characters (optional, default to false)
      publishPorts - publish a container's port, or a range of ports, to the host (optional)
      publishAllPorts - Whether to publish all ports defined in the K8S YAML file (containerPort, hostPort), if false only hostPort will be published (optional)
      replace - replace existing pods and containers (optional, default to false)
      serviceContainer - Starts a service container before all pods. (optional, default to false)
      start - Start the pod after creating it. (optional, default to true)
      staticIPs - Static IPs used for the pods. (optional)
      staticMACs - Static MACs used for the pods. (optional)
      tlsVerify - Require HTTPS and verify signatures when contacting registries. (optional, default to true)
      userns - Set the user namespace mode for the pods. (optional)
      wait - Clean up all objects created when a SIGTERM is received or pods exit. (optional, default to false)
      build - Build the images with corresponding context. (optional)
      request - Kubernetes YAML file. (optional)
      Returns:
      PlayKubeReport
      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 PlayKube response -
      500 Internal server error -

    • playKubeLibpodWithHttpInfo

      public ApiResponse<PlayKubeReport> playKubeLibpodWithHttpInfo(String contentType, String annotations, String logDriver, List<String> logOptions, List<String> network, Boolean noHosts, Boolean noTrunc, List<String> publishPorts, Boolean publishAllPorts, Boolean replace, Boolean serviceContainer, Boolean start, List<String> staticIPs, List<String> staticMACs, Boolean tlsVerify, String userns, Boolean wait, Boolean build, String request) throws ApiException
      Play a Kubernetes YAML file. Create and run pods based on a Kubernetes YAML file. ### Content-Type Then endpoint support two Content-Type - `plain/text` for yaml format - `application/x-tar` for sending context(s) required for building images #### Tar format The tar format must contain a `play.yaml` file at the root that will be used. If the file format requires context to build an image, it uses the image name and check for corresponding folder. For example, the client sends a tar file with the following structure: ``` └── content.tar ├── play.yaml └── foobar/ └── Containerfile ``` The `play.yaml` is the following, the `foobar` image means we are looking for a context with this name. ``` apiVersion: v1 kind: Pod metadata: name: demo-build-remote spec: containers: - name: container image: foobar ```
      Parameters:
      contentType - (optional, default to plain/text)
      annotations - JSON encoded value of annotations (a map[string]string). (optional)
      logDriver - Logging driver for the containers in the pod. (optional)
      logOptions - logging driver options (optional)
      network - USe the network mode or specify an array of networks. (optional)
      noHosts - do not setup /etc/hosts file in container (optional, default to false)
      noTrunc - use annotations that are not truncated to the Kubernetes maximum length of 63 characters (optional, default to false)
      publishPorts - publish a container's port, or a range of ports, to the host (optional)
      publishAllPorts - Whether to publish all ports defined in the K8S YAML file (containerPort, hostPort), if false only hostPort will be published (optional)
      replace - replace existing pods and containers (optional, default to false)
      serviceContainer - Starts a service container before all pods. (optional, default to false)
      start - Start the pod after creating it. (optional, default to true)
      staticIPs - Static IPs used for the pods. (optional)
      staticMACs - Static MACs used for the pods. (optional)
      tlsVerify - Require HTTPS and verify signatures when contacting registries. (optional, default to true)
      userns - Set the user namespace mode for the pods. (optional)
      wait - Clean up all objects created when a SIGTERM is received or pods exit. (optional, default to false)
      build - Build the images with corresponding context. (optional)
      request - Kubernetes YAML file. (optional)
      Returns:
      ApiResponse<PlayKubeReport>
      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 PlayKube response -
      500 Internal server error -

    • playKubeLibpodAsync

      public okhttp3.Call playKubeLibpodAsync(String contentType, String annotations, String logDriver, List<String> logOptions, List<String> network, Boolean noHosts, Boolean noTrunc, List<String> publishPorts, Boolean publishAllPorts, Boolean replace, Boolean serviceContainer, Boolean start, List<String> staticIPs, List<String> staticMACs, Boolean tlsVerify, String userns, Boolean wait, Boolean build, String request, ApiCallback<PlayKubeReport> _callback) throws ApiException
      Play a Kubernetes YAML file. (asynchronously) Create and run pods based on a Kubernetes YAML file. ### Content-Type Then endpoint support two Content-Type - `plain/text` for yaml format - `application/x-tar` for sending context(s) required for building images #### Tar format The tar format must contain a `play.yaml` file at the root that will be used. If the file format requires context to build an image, it uses the image name and check for corresponding folder. For example, the client sends a tar file with the following structure: ``` └── content.tar ├── play.yaml └── foobar/ └── Containerfile ``` The `play.yaml` is the following, the `foobar` image means we are looking for a context with this name. ``` apiVersion: v1 kind: Pod metadata: name: demo-build-remote spec: containers: - name: container image: foobar ```
      Parameters:
      contentType - (optional, default to plain/text)
      annotations - JSON encoded value of annotations (a map[string]string). (optional)
      logDriver - Logging driver for the containers in the pod. (optional)
      logOptions - logging driver options (optional)
      network - USe the network mode or specify an array of networks. (optional)
      noHosts - do not setup /etc/hosts file in container (optional, default to false)
      noTrunc - use annotations that are not truncated to the Kubernetes maximum length of 63 characters (optional, default to false)
      publishPorts - publish a container's port, or a range of ports, to the host (optional)
      publishAllPorts - Whether to publish all ports defined in the K8S YAML file (containerPort, hostPort), if false only hostPort will be published (optional)
      replace - replace existing pods and containers (optional, default to false)
      serviceContainer - Starts a service container before all pods. (optional, default to false)
      start - Start the pod after creating it. (optional, default to true)
      staticIPs - Static IPs used for the pods. (optional)
      staticMACs - Static MACs used for the pods. (optional)
      tlsVerify - Require HTTPS and verify signatures when contacting registries. (optional, default to true)
      userns - Set the user namespace mode for the pods. (optional)
      wait - Clean up all objects created when a SIGTERM is received or pods exit. (optional, default to false)
      build - Build the images with corresponding context. (optional)
      request - Kubernetes YAML file. (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 PlayKube response -
      500 Internal server error -

    • podCreateLibpodCall

      public okhttp3.Call podCreateLibpodCall(PodSpecGenerator create, ApiCallback _callback) throws ApiException
      Build call for podCreateLibpod
      Parameters:
      create - attributes for creating a pod (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 -
      400 Bad parameter in request -
      409 status conflict -
      500 Internal server error -

    • podCreateLibpod

      public IdResponse podCreateLibpod(PodSpecGenerator create) throws ApiException
      Create a pod
      Parameters:
      create - attributes for creating a pod (optional)
      Returns:
      IdResponse
      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 -
      400 Bad parameter in request -
      409 status conflict -
      500 Internal server error -

    • podCreateLibpodWithHttpInfo

      public ApiResponse<IdResponse> podCreateLibpodWithHttpInfo(PodSpecGenerator create) throws ApiException
      Create a pod
      Parameters:
      create - attributes for creating a pod (optional)
      Returns:
      ApiResponse<IdResponse>
      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 -
      400 Bad parameter in request -
      409 status conflict -
      500 Internal server error -

    • podCreateLibpodAsync

      public okhttp3.Call podCreateLibpodAsync(PodSpecGenerator create, ApiCallback<IdResponse> _callback) throws ApiException
      Create a pod (asynchronously)
      Parameters:
      create - attributes for creating a pod (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 -
      400 Bad parameter in request -
      409 status conflict -
      500 Internal server error -

    • podDeleteLibpodCall

      public okhttp3.Call podDeleteLibpodCall(String name, Boolean force, ApiCallback _callback) throws ApiException
      Build call for podDeleteLibpod
      Parameters:
      name - the name or ID of the pod (required)
      force - force removal of a running pod by first stopping all containers, then removing all containers in the pod (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 Rm pod -
      400 Bad parameter in request -
      404 No such pod -
      500 Internal server error -

    • podDeleteLibpod

      public PodRmReport podDeleteLibpod(String name, Boolean force) throws ApiException
      Remove pod
      Parameters:
      name - the name or ID of the pod (required)
      force - force removal of a running pod by first stopping all containers, then removing all containers in the pod (optional)
      Returns:
      PodRmReport
      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 Rm pod -
      400 Bad parameter in request -
      404 No such pod -
      500 Internal server error -

    • podDeleteLibpodWithHttpInfo

      public ApiResponse<PodRmReport> podDeleteLibpodWithHttpInfo(@NotNull @NotNull String name, Boolean force) throws ApiException
      Remove pod
      Parameters:
      name - the name or ID of the pod (required)
      force - force removal of a running pod by first stopping all containers, then removing all containers in the pod (optional)
      Returns:
      ApiResponse<PodRmReport>
      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 Rm pod -
      400 Bad parameter in request -
      404 No such pod -
      500 Internal server error -

    • podDeleteLibpodAsync

      public okhttp3.Call podDeleteLibpodAsync(String name, Boolean force, ApiCallback<PodRmReport> _callback) throws ApiException
      Remove pod (asynchronously)
      Parameters:
      name - the name or ID of the pod (required)
      force - force removal of a running pod by first stopping all containers, then removing all containers in the pod (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 Rm pod -
      400 Bad parameter in request -
      404 No such pod -
      500 Internal server error -

    • podExistsLibpodCall

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

    • podExistsLibpod

      public void podExistsLibpod(String name) throws ApiException
      Pod exists Check if a pod exists by name or ID
      Parameters:
      name - the name or ID of the pod (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 pod exists -
      404 No such pod -
      500 Internal server error -

    • podExistsLibpodWithHttpInfo

      public ApiResponse<Void> podExistsLibpodWithHttpInfo(@NotNull @NotNull String name) throws ApiException
      Pod exists Check if a pod exists by name or ID
      Parameters:
      name - the name or ID of the pod (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 pod exists -
      404 No such pod -
      500 Internal server error -

    • podExistsLibpodAsync

      public okhttp3.Call podExistsLibpodAsync(String name, ApiCallback<Void> _callback) throws ApiException
      Pod exists (asynchronously) Check if a pod exists by name or ID
      Parameters:
      name - the name or ID of the pod (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 pod exists -
      404 No such pod -
      500 Internal server error -

    • podInspectLibpodCall

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

    • podInspectLibpod

      public InspectPodData podInspectLibpod(String name) throws ApiException
      Inspect pod
      Parameters:
      name - the name or ID of the pod (required)
      Returns:
      InspectPodData
      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 pod -
      404 No such pod -
      500 Internal server error -

    • podInspectLibpodWithHttpInfo

      public ApiResponse<InspectPodData> podInspectLibpodWithHttpInfo(@NotNull @NotNull String name) throws ApiException
      Inspect pod
      Parameters:
      name - the name or ID of the pod (required)
      Returns:
      ApiResponse<InspectPodData>
      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 pod -
      404 No such pod -
      500 Internal server error -

    • podInspectLibpodAsync

      public okhttp3.Call podInspectLibpodAsync(String name, ApiCallback<InspectPodData> _callback) throws ApiException
      Inspect pod (asynchronously)
      Parameters:
      name - the name or ID of the pod (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 Inspect pod -
      404 No such pod -
      500 Internal server error -

    • podKillLibpodCall

      public okhttp3.Call podKillLibpodCall(String name, String signal, ApiCallback _callback) throws ApiException
      Build call for podKillLibpod
      Parameters:
      name - the name or ID of the pod (required)
      signal - signal to be sent to pod (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
      200 Kill Pod -
      400 Bad parameter in request -
      404 No such pod -
      409 Kill Pod -
      500 Internal server error -

    • podKillLibpod

      public PodKillReport podKillLibpod(String name, String signal) throws ApiException
      Kill a pod
      Parameters:
      name - the name or ID of the pod (required)
      signal - signal to be sent to pod (optional, default to SIGKILL)
      Returns:
      PodKillReport
      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 Kill Pod -
      400 Bad parameter in request -
      404 No such pod -
      409 Kill Pod -
      500 Internal server error -

    • podKillLibpodWithHttpInfo

      public ApiResponse<PodKillReport> podKillLibpodWithHttpInfo(@NotNull @NotNull String name, String signal) throws ApiException
      Kill a pod
      Parameters:
      name - the name or ID of the pod (required)
      signal - signal to be sent to pod (optional, default to SIGKILL)
      Returns:
      ApiResponse<PodKillReport>
      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 Kill Pod -
      400 Bad parameter in request -
      404 No such pod -
      409 Kill Pod -
      500 Internal server error -

    • podKillLibpodAsync

      public okhttp3.Call podKillLibpodAsync(String name, String signal, ApiCallback<PodKillReport> _callback) throws ApiException
      Kill a pod (asynchronously)
      Parameters:
      name - the name or ID of the pod (required)
      signal - signal to be sent to pod (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
      200 Kill Pod -
      400 Bad parameter in request -
      404 No such pod -
      409 Kill Pod -
      500 Internal server error -

    • podListLibpodCall

      public okhttp3.Call podListLibpodCall(String filters, ApiCallback _callback) throws ApiException
      Build call for podListLibpod
      Parameters:
      filters - JSON encoded value of the filters (a map[string][]string) to process on the pods list. Available filters: - `id=<pod-id>` Matches all of pod id. - `label=<key>` or `label=<key>:<value>` Matches pods based on the presence of a label alone or a label and a value. - `name=<pod-name>` Matches all of pod name. - `until=<timestamp>` List pods 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. - `status=<pod-status>` Pod's status: `stopped`, `running`, `paused`, `exited`, `dead`, `created`, `degraded`. - `network=<pod-network>` Name or full ID of network. - `ctr-names=<pod-ctr-names>` Container name within the pod. - `ctr-ids=<pod-ctr-ids>` Container ID within the pod. - `ctr-status=<pod-ctr-status>` Container status within the pod. - `ctr-number=<pod-ctr-number>` Number of containers in the pod. (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 pods -
      400 Bad parameter in request -
      500 Internal server error -

    • podListLibpod

      public List<ListPodsReport> podListLibpod(String filters) throws ApiException
      List pods
      Parameters:
      filters - JSON encoded value of the filters (a map[string][]string) to process on the pods list. Available filters: - `id=<pod-id>` Matches all of pod id. - `label=<key>` or `label=<key>:<value>` Matches pods based on the presence of a label alone or a label and a value. - `name=<pod-name>` Matches all of pod name. - `until=<timestamp>` List pods 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. - `status=<pod-status>` Pod's status: `stopped`, `running`, `paused`, `exited`, `dead`, `created`, `degraded`. - `network=<pod-network>` Name or full ID of network. - `ctr-names=<pod-ctr-names>` Container name within the pod. - `ctr-ids=<pod-ctr-ids>` Container ID within the pod. - `ctr-status=<pod-ctr-status>` Container status within the pod. - `ctr-number=<pod-ctr-number>` Number of containers in the pod. (optional)
      Returns:
      List<ListPodsReport>
      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 pods -
      400 Bad parameter in request -
      500 Internal server error -

    • podListLibpodWithHttpInfo

      public ApiResponse<List<ListPodsReport>> podListLibpodWithHttpInfo(String filters) throws ApiException
      List pods
      Parameters:
      filters - JSON encoded value of the filters (a map[string][]string) to process on the pods list. Available filters: - `id=<pod-id>` Matches all of pod id. - `label=<key>` or `label=<key>:<value>` Matches pods based on the presence of a label alone or a label and a value. - `name=<pod-name>` Matches all of pod name. - `until=<timestamp>` List pods 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. - `status=<pod-status>` Pod's status: `stopped`, `running`, `paused`, `exited`, `dead`, `created`, `degraded`. - `network=<pod-network>` Name or full ID of network. - `ctr-names=<pod-ctr-names>` Container name within the pod. - `ctr-ids=<pod-ctr-ids>` Container ID within the pod. - `ctr-status=<pod-ctr-status>` Container status within the pod. - `ctr-number=<pod-ctr-number>` Number of containers in the pod. (optional)
      Returns:
      ApiResponse<List<ListPodsReport>>
      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 pods -
      400 Bad parameter in request -
      500 Internal server error -

    • podListLibpodAsync

      public okhttp3.Call podListLibpodAsync(String filters, ApiCallback<List<ListPodsReport>> _callback) throws ApiException
      List pods (asynchronously)
      Parameters:
      filters - JSON encoded value of the filters (a map[string][]string) to process on the pods list. Available filters: - `id=<pod-id>` Matches all of pod id. - `label=<key>` or `label=<key>:<value>` Matches pods based on the presence of a label alone or a label and a value. - `name=<pod-name>` Matches all of pod name. - `until=<timestamp>` List pods 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. - `status=<pod-status>` Pod's status: `stopped`, `running`, `paused`, `exited`, `dead`, `created`, `degraded`. - `network=<pod-network>` Name or full ID of network. - `ctr-names=<pod-ctr-names>` Container name within the pod. - `ctr-ids=<pod-ctr-ids>` Container ID within the pod. - `ctr-status=<pod-ctr-status>` Container status within the pod. - `ctr-number=<pod-ctr-number>` Number of containers in the pod. (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 pods -
      400 Bad parameter in request -
      500 Internal server error -

    • podPauseLibpodCall

      public okhttp3.Call podPauseLibpodCall(String name, ApiCallback _callback) throws ApiException
      Build call for podPauseLibpod
      Parameters:
      name - the name or ID of the pod (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 Pause pod -
      404 No such pod -
      409 Pause pod -
      500 Internal server error -

    • podPauseLibpod

      public PodPauseReport podPauseLibpod(String name) throws ApiException
      Pause a pod Pause a pod
      Parameters:
      name - the name or ID of the pod (required)
      Returns:
      PodPauseReport
      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 Pause pod -
      404 No such pod -
      409 Pause pod -
      500 Internal server error -

    • podPauseLibpodWithHttpInfo

      public ApiResponse<PodPauseReport> podPauseLibpodWithHttpInfo(@NotNull @NotNull String name) throws ApiException
      Pause a pod Pause a pod
      Parameters:
      name - the name or ID of the pod (required)
      Returns:
      ApiResponse<PodPauseReport>
      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 Pause pod -
      404 No such pod -
      409 Pause pod -
      500 Internal server error -

    • podPauseLibpodAsync

      public okhttp3.Call podPauseLibpodAsync(String name, ApiCallback<PodPauseReport> _callback) throws ApiException
      Pause a pod (asynchronously) Pause a pod
      Parameters:
      name - the name or ID of the pod (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 Pause pod -
      404 No such pod -
      409 Pause pod -
      500 Internal server error -

    • podPruneLibpodCall

      public okhttp3.Call podPruneLibpodCall(ApiCallback _callback) throws ApiException
      Build call for podPruneLibpod
      Parameters:
      _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 pod -
      400 Bad parameter in request -
      409 pod already exists -
      500 Internal server error -

    • podPruneLibpod

      public PodPruneReport podPruneLibpod() throws ApiException
      Prune unused pods
      Returns:
      PodPruneReport
      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 pod -
      400 Bad parameter in request -
      409 pod already exists -
      500 Internal server error -

    • podPruneLibpodWithHttpInfo

      public ApiResponse<PodPruneReport> podPruneLibpodWithHttpInfo() throws ApiException
      Prune unused pods
      Returns:
      ApiResponse<PodPruneReport>
      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 pod -
      400 Bad parameter in request -
      409 pod already exists -
      500 Internal server error -

    • podPruneLibpodAsync

      public okhttp3.Call podPruneLibpodAsync(ApiCallback<PodPruneReport> _callback) throws ApiException
      Prune unused pods (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 Prune pod -
      400 Bad parameter in request -
      409 pod already exists -
      500 Internal server error -

    • podRestartLibpodCall

      public okhttp3.Call podRestartLibpodCall(String name, ApiCallback _callback) throws ApiException
      Build call for podRestartLibpod
      Parameters:
      name - the name or ID of the pod (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 Restart pod -
      404 No such pod -
      409 Restart pod -
      500 Internal server error -

    • podRestartLibpod

      public PodRestartReport podRestartLibpod(String name) throws ApiException
      Restart a pod
      Parameters:
      name - the name or ID of the pod (required)
      Returns:
      PodRestartReport
      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 Restart pod -
      404 No such pod -
      409 Restart pod -
      500 Internal server error -

    • podRestartLibpodWithHttpInfo

      public ApiResponse<PodRestartReport> podRestartLibpodWithHttpInfo(@NotNull @NotNull String name) throws ApiException
      Restart a pod
      Parameters:
      name - the name or ID of the pod (required)
      Returns:
      ApiResponse<PodRestartReport>
      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 Restart pod -
      404 No such pod -
      409 Restart pod -
      500 Internal server error -

    • podRestartLibpodAsync

      public okhttp3.Call podRestartLibpodAsync(String name, ApiCallback<PodRestartReport> _callback) throws ApiException
      Restart a pod (asynchronously)
      Parameters:
      name - the name or ID of the pod (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 Restart pod -
      404 No such pod -
      409 Restart pod -
      500 Internal server error -

    • podStartLibpodCall

      public okhttp3.Call podStartLibpodCall(String name, ApiCallback _callback) throws ApiException
      Build call for podStartLibpod
      Parameters:
      name - the name or ID of the pod (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 Start pod -
      304 Pod already started -
      404 No such pod -
      409 Start pod -
      500 Internal server error -

    • podStartLibpod

      public PodStartReport podStartLibpod(String name) throws ApiException
      Start a pod
      Parameters:
      name - the name or ID of the pod (required)
      Returns:
      PodStartReport
      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 Start pod -
      304 Pod already started -
      404 No such pod -
      409 Start pod -
      500 Internal server error -

    • podStartLibpodWithHttpInfo

      public ApiResponse<PodStartReport> podStartLibpodWithHttpInfo(@NotNull @NotNull String name) throws ApiException
      Start a pod
      Parameters:
      name - the name or ID of the pod (required)
      Returns:
      ApiResponse<PodStartReport>
      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 Start pod -
      304 Pod already started -
      404 No such pod -
      409 Start pod -
      500 Internal server error -

    • podStartLibpodAsync

      public okhttp3.Call podStartLibpodAsync(String name, ApiCallback<PodStartReport> _callback) throws ApiException
      Start a pod (asynchronously)
      Parameters:
      name - the name or ID of the pod (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 Start pod -
      304 Pod already started -
      404 No such pod -
      409 Start pod -
      500 Internal server error -

    • podStatsAllLibpodCall

      public okhttp3.Call podStatsAllLibpodCall(Boolean all, List<String> namesOrIDs, ApiCallback _callback) throws ApiException
      Build call for podStatsAllLibpod
      Parameters:
      all - Provide statistics for all running pods. (optional)
      namesOrIDs - Names or IDs of pods. (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 Pod Statistics -
      404 No such pod -
      500 Internal server error -

    • podStatsAllLibpod

      public List<PodStatsReport> podStatsAllLibpod(Boolean all, List<String> namesOrIDs) throws ApiException
      Statistics for one or more pods Display a live stream of resource usage statistics for the containers in one or more pods
      Parameters:
      all - Provide statistics for all running pods. (optional)
      namesOrIDs - Names or IDs of pods. (optional)
      Returns:
      List<PodStatsReport>
      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 Pod Statistics -
      404 No such pod -
      500 Internal server error -

    • podStatsAllLibpodWithHttpInfo

      public ApiResponse<List<PodStatsReport>> podStatsAllLibpodWithHttpInfo(Boolean all, List<String> namesOrIDs) throws ApiException
      Statistics for one or more pods Display a live stream of resource usage statistics for the containers in one or more pods
      Parameters:
      all - Provide statistics for all running pods. (optional)
      namesOrIDs - Names or IDs of pods. (optional)
      Returns:
      ApiResponse<List<PodStatsReport>>
      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 Pod Statistics -
      404 No such pod -
      500 Internal server error -

    • podStatsAllLibpodAsync

      public okhttp3.Call podStatsAllLibpodAsync(Boolean all, List<String> namesOrIDs, ApiCallback<List<PodStatsReport>> _callback) throws ApiException
      Statistics for one or more pods (asynchronously) Display a live stream of resource usage statistics for the containers in one or more pods
      Parameters:
      all - Provide statistics for all running pods. (optional)
      namesOrIDs - Names or IDs of pods. (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 Pod Statistics -
      404 No such pod -
      500 Internal server error -

    • podStopLibpodCall

      public okhttp3.Call podStopLibpodCall(String name, Integer t, ApiCallback _callback) throws ApiException
      Build call for podStopLibpod
      Parameters:
      name - the name or ID of the pod (required)
      t - timeout (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 Stop pod -
      304 Pod already stopped -
      400 Bad parameter in request -
      404 No such pod -
      409 Stop pod -
      500 Internal server error -

    • podStopLibpod

      public PodStopReport podStopLibpod(String name, Integer t) throws ApiException
      Stop a pod
      Parameters:
      name - the name or ID of the pod (required)
      t - timeout (optional)
      Returns:
      PodStopReport
      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 Stop pod -
      304 Pod already stopped -
      400 Bad parameter in request -
      404 No such pod -
      409 Stop pod -
      500 Internal server error -

    • podStopLibpodWithHttpInfo

      public ApiResponse<PodStopReport> podStopLibpodWithHttpInfo(@NotNull @NotNull String name, Integer t) throws ApiException
      Stop a pod
      Parameters:
      name - the name or ID of the pod (required)
      t - timeout (optional)
      Returns:
      ApiResponse<PodStopReport>
      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 Stop pod -
      304 Pod already stopped -
      400 Bad parameter in request -
      404 No such pod -
      409 Stop pod -
      500 Internal server error -

    • podStopLibpodAsync

      public okhttp3.Call podStopLibpodAsync(String name, Integer t, ApiCallback<PodStopReport> _callback) throws ApiException
      Stop a pod (asynchronously)
      Parameters:
      name - the name or ID of the pod (required)
      t - timeout (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 Stop pod -
      304 Pod already stopped -
      400 Bad parameter in request -
      404 No such pod -
      409 Stop pod -
      500 Internal server error -

    • podTopLibpodCall

      public okhttp3.Call podTopLibpodCall(String name, Boolean stream, Integer delay, String psArgs, ApiCallback _callback) throws ApiException
      Build call for podTopLibpod
      Parameters:
      name - Name of pod to query for processes (required)
      stream - when true, repeatedly stream the latest output (As of version 4.0) (optional)
      delay - if streaming, delay in seconds between updates. Must be >1. (As of version 4.0) (optional, default to 5)
      psArgs - arguments to pass to ps such as aux. (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 processes in pod -
      404 No such pod -
      500 Internal server error -

    • podTopLibpod

      public PodTopOKBody podTopLibpod(String name, Boolean stream, Integer delay, String psArgs) throws ApiException
      List processes List processes running inside a pod
      Parameters:
      name - Name of pod to query for processes (required)
      stream - when true, repeatedly stream the latest output (As of version 4.0) (optional)
      delay - if streaming, delay in seconds between updates. Must be >1. (As of version 4.0) (optional, default to 5)
      psArgs - arguments to pass to ps such as aux. (optional)
      Returns:
      PodTopOKBody
      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 pod -
      404 No such pod -
      500 Internal server error -

    • podTopLibpodWithHttpInfo

      public ApiResponse<PodTopOKBody> podTopLibpodWithHttpInfo(@NotNull @NotNull String name, Boolean stream, Integer delay, String psArgs) throws ApiException
      List processes List processes running inside a pod
      Parameters:
      name - Name of pod to query for processes (required)
      stream - when true, repeatedly stream the latest output (As of version 4.0) (optional)
      delay - if streaming, delay in seconds between updates. Must be >1. (As of version 4.0) (optional, default to 5)
      psArgs - arguments to pass to ps such as aux. (optional)
      Returns:
      ApiResponse<PodTopOKBody>
      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 pod -
      404 No such pod -
      500 Internal server error -

    • podTopLibpodAsync

      public okhttp3.Call podTopLibpodAsync(String name, Boolean stream, Integer delay, String psArgs, ApiCallback<PodTopOKBody> _callback) throws ApiException
      List processes (asynchronously) List processes running inside a pod
      Parameters:
      name - Name of pod to query for processes (required)
      stream - when true, repeatedly stream the latest output (As of version 4.0) (optional)
      delay - if streaming, delay in seconds between updates. Must be >1. (As of version 4.0) (optional, default to 5)
      psArgs - arguments to pass to ps such as aux. (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 processes in pod -
      404 No such pod -
      500 Internal server error -

    • podUnpauseLibpodCall

      public okhttp3.Call podUnpauseLibpodCall(String name, ApiCallback _callback) throws ApiException
      Build call for podUnpauseLibpod
      Parameters:
      name - the name or ID of the pod (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 Unpause pod -
      404 No such pod -
      409 Unpause pod -
      500 Internal server error -

    • podUnpauseLibpod

      public PodUnpauseReport podUnpauseLibpod(String name) throws ApiException
      Unpause a pod
      Parameters:
      name - the name or ID of the pod (required)
      Returns:
      PodUnpauseReport
      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 Unpause pod -
      404 No such pod -
      409 Unpause pod -
      500 Internal server error -

    • podUnpauseLibpodWithHttpInfo

      public ApiResponse<PodUnpauseReport> podUnpauseLibpodWithHttpInfo(@NotNull @NotNull String name) throws ApiException
      Unpause a pod
      Parameters:
      name - the name or ID of the pod (required)
      Returns:
      ApiResponse<PodUnpauseReport>
      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 Unpause pod -
      404 No such pod -
      409 Unpause pod -
      500 Internal server error -

    • podUnpauseLibpodAsync

      public okhttp3.Call podUnpauseLibpodAsync(String name, ApiCallback<PodUnpauseReport> _callback) throws ApiException
      Unpause a pod (asynchronously)
      Parameters:
      name - the name or ID of the pod (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 Unpause pod -
      404 No such pod -
      409 Unpause pod -
      500 Internal server error -