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

Class SystemApi

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

  • Constructor Details

    • SystemApi

      public SystemApi()

    • SystemApi

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

    • systemCheckLibpod

      public SystemApi.APIsystemCheckLibpodRequest systemCheckLibpod()
      Performs consistency checks on storage, optionally removing items which fail checks
      Returns:
      APIsystemCheckLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Check -
      400 Bad parameter in request -
      500 Internal server error -

    • systemDataUsageLibpod

      public SystemApi.APIsystemDataUsageLibpodRequest systemDataUsageLibpod()
      Show disk usage Return information about disk usage for containers, images, and volumes
      Returns:
      APIsystemDataUsageLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Disk usage -
      500 Internal server error -

    • systemEventsLibpod

      public SystemApi.APIsystemEventsLibpodRequest systemEventsLibpod()
      Get events Returns events filtered on query parameters
      Returns:
      APIsystemEventsLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 returns a string of json data describing an event -
      500 Internal server error -

    • systemInfoLibpod

      public SystemApi.APIsystemInfoLibpodRequest systemInfoLibpod()
      Get info Returns information on the system and libpod configuration
      Returns:
      APIsystemInfoLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Info -
      500 Internal server error -

    • systemPing

      public SystemApi.APIsystemPingRequest systemPing()
      Ping service Return protocol information in response headers. `HEAD /libpod/_ping` is also supported. `/_ping` is available for compatibility with other engines. The '_ping' endpoints are not versioned.
      Returns:
      APIsystemPingRequest
      Http Response Details
      Status Code Description Response Headers
      200 Success * Docker-Experimental - If the server is running with experimental mode enabled, always true
      * Cache-Control - always no-cache
      * Libpod-Buildah-Version - Default version of libpod image builder. Available if service is backed by Podman, therefore may be used to determine if talking to Podman engine or another engine
      * Libpod-API-Version - Max Podman API Version the server supports. Available if service is backed by Podman, therefore may be used to determine if talking to Podman engine or another engine
      * BuildKit-Version - Default version of docker image builder
      * Pragma - always no-cache
      * API-Version - Max compatibility API Version the server supports
      500 Internal server error -

    • systemPruneLibpod

      public SystemApi.APIsystemPruneLibpodRequest systemPruneLibpod()
      Prune unused data
      Returns:
      APIsystemPruneLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 System Prune results -
      400 Bad parameter in request -
      500 Internal server error -

    • systemVersionLibpod

      public SystemApi.APIsystemVersionLibpodRequest systemVersionLibpod()
      Component Version information
      Returns:
      APIsystemVersionLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Version -