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)

    • systemCheckLibpodCall

      public okhttp3.Call systemCheckLibpodCall(Boolean quick, Boolean repair, Boolean repairLossy, String unreferencedLayerMaxAge, ApiCallback _callback) throws ApiException
      Build call for systemCheckLibpod
      Parameters:
      quick - Skip time-consuming checks (optional)
      repair - Remove inconsistent images (optional)
      repairLossy - Remove inconsistent containers and images (optional)
      unreferencedLayerMaxAge - Maximum allowed age of unreferenced layers (optional, default to 24h0m0s)
      _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 Check -
      400 Bad parameter in request -
      500 Internal server error -

    • systemCheckLibpod

      public SystemCheckReport systemCheckLibpod(Boolean quick, Boolean repair, Boolean repairLossy, String unreferencedLayerMaxAge) throws ApiException
      Performs consistency checks on storage, optionally removing items which fail checks
      Parameters:
      quick - Skip time-consuming checks (optional)
      repair - Remove inconsistent images (optional)
      repairLossy - Remove inconsistent containers and images (optional)
      unreferencedLayerMaxAge - Maximum allowed age of unreferenced layers (optional, default to 24h0m0s)
      Returns:
      SystemCheckReport
      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 Check -
      400 Bad parameter in request -
      500 Internal server error -

    • systemCheckLibpodWithHttpInfo

      public ApiResponse<SystemCheckReport> systemCheckLibpodWithHttpInfo(Boolean quick, Boolean repair, Boolean repairLossy, String unreferencedLayerMaxAge) throws ApiException
      Performs consistency checks on storage, optionally removing items which fail checks
      Parameters:
      quick - Skip time-consuming checks (optional)
      repair - Remove inconsistent images (optional)
      repairLossy - Remove inconsistent containers and images (optional)
      unreferencedLayerMaxAge - Maximum allowed age of unreferenced layers (optional, default to 24h0m0s)
      Returns:
      ApiResponse<SystemCheckReport>
      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 Check -
      400 Bad parameter in request -
      500 Internal server error -

    • systemCheckLibpodAsync

      public okhttp3.Call systemCheckLibpodAsync(Boolean quick, Boolean repair, Boolean repairLossy, String unreferencedLayerMaxAge, ApiCallback<SystemCheckReport> _callback) throws ApiException
      Performs consistency checks on storage, optionally removing items which fail checks (asynchronously)
      Parameters:
      quick - Skip time-consuming checks (optional)
      repair - Remove inconsistent images (optional)
      repairLossy - Remove inconsistent containers and images (optional)
      unreferencedLayerMaxAge - Maximum allowed age of unreferenced layers (optional, default to 24h0m0s)
      _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 Check -
      400 Bad parameter in request -
      500 Internal server error -

    • systemDataUsageLibpodCall

      public okhttp3.Call systemDataUsageLibpodCall(ApiCallback _callback) throws ApiException
      Build call for systemDataUsageLibpod
      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 Disk usage -
      500 Internal server error -

    • systemDataUsageLibpod

      public SystemDfReport systemDataUsageLibpod() throws ApiException
      Show disk usage Return information about disk usage for containers, images, and volumes
      Returns:
      SystemDfReport
      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 Disk usage -
      500 Internal server error -

    • systemDataUsageLibpodWithHttpInfo

      public ApiResponse<SystemDfReport> systemDataUsageLibpodWithHttpInfo() throws ApiException
      Show disk usage Return information about disk usage for containers, images, and volumes
      Returns:
      ApiResponse<SystemDfReport>
      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 Disk usage -
      500 Internal server error -

    • systemDataUsageLibpodAsync

      public okhttp3.Call systemDataUsageLibpodAsync(ApiCallback<SystemDfReport> _callback) throws ApiException
      Show disk usage (asynchronously) Return information about disk usage for containers, images, and volumes
      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 Disk usage -
      500 Internal server error -

    • systemEventsLibpodCall

      public okhttp3.Call systemEventsLibpodCall(String since, String until, String filters, Boolean stream, ApiCallback _callback) throws ApiException
      Build call for systemEventsLibpod
      Parameters:
      since - start streaming events from this time (optional)
      until - stop streaming events later than this (optional)
      filters - JSON encoded map[string][]string of constraints (optional)
      stream - when false, do not follow events (optional, default to true)
      _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 returns a string of json data describing an event -
      500 Internal server error -

    • systemEventsLibpod

      public void systemEventsLibpod(String since, String until, String filters, Boolean stream) throws ApiException
      Get events Returns events filtered on query parameters
      Parameters:
      since - start streaming events from this time (optional)
      until - stop streaming events later than this (optional)
      filters - JSON encoded map[string][]string of constraints (optional)
      stream - when false, do not follow events (optional, default to true)
      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 returns a string of json data describing an event -
      500 Internal server error -

    • systemEventsLibpodWithHttpInfo

      public ApiResponse<Void> systemEventsLibpodWithHttpInfo(String since, String until, String filters, Boolean stream) throws ApiException
      Get events Returns events filtered on query parameters
      Parameters:
      since - start streaming events from this time (optional)
      until - stop streaming events later than this (optional)
      filters - JSON encoded map[string][]string of constraints (optional)
      stream - when false, do not follow events (optional, default to true)
      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 returns a string of json data describing an event -
      500 Internal server error -

    • systemEventsLibpodAsync

      public okhttp3.Call systemEventsLibpodAsync(String since, String until, String filters, Boolean stream, ApiCallback<Void> _callback) throws ApiException
      Get events (asynchronously) Returns events filtered on query parameters
      Parameters:
      since - start streaming events from this time (optional)
      until - stop streaming events later than this (optional)
      filters - JSON encoded map[string][]string of constraints (optional)
      stream - when false, do not follow events (optional, default to true)
      _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 returns a string of json data describing an event -
      500 Internal server error -

    • systemInfoLibpodCall

      public okhttp3.Call systemInfoLibpodCall(ApiCallback _callback) throws ApiException
      Build call for systemInfoLibpod
      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 Info -
      500 Internal server error -

    • systemInfoLibpod

      public LibpodInfo systemInfoLibpod() throws ApiException
      Get info Returns information on the system and libpod configuration
      Returns:
      LibpodInfo
      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 Info -
      500 Internal server error -

    • systemInfoLibpodWithHttpInfo

      public ApiResponse<LibpodInfo> systemInfoLibpodWithHttpInfo() throws ApiException
      Get info Returns information on the system and libpod configuration
      Returns:
      ApiResponse<LibpodInfo>
      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 Info -
      500 Internal server error -

    • systemInfoLibpodAsync

      public okhttp3.Call systemInfoLibpodAsync(ApiCallback<LibpodInfo> _callback) throws ApiException
      Get info (asynchronously) Returns information on the system and libpod configuration
      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 Info -
      500 Internal server error -

    • systemPingCall

      public okhttp3.Call systemPingCall(ApiCallback _callback) throws ApiException
      Build call for systemPing
      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 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 -

    • systemPing

      public String systemPing() throws ApiException
      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:
      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 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 -

    • systemPingWithHttpInfo

      public ApiResponse<String> systemPingWithHttpInfo() throws ApiException
      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:
      ApiResponse<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 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 -

    • systemPingAsync

      public okhttp3.Call systemPingAsync(ApiCallback<String> _callback) throws ApiException
      Ping service (asynchronously) 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.
      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 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 -

    • systemPruneLibpodCall

      public okhttp3.Call systemPruneLibpodCall(ApiCallback _callback) throws ApiException
      Build call for systemPruneLibpod
      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 System Prune results -
      400 Bad parameter in request -
      500 Internal server error -

    • systemPruneLibpod

      public SystemPruneReport systemPruneLibpod() throws ApiException
      Prune unused data
      Returns:
      SystemPruneReport
      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 System Prune results -
      400 Bad parameter in request -
      500 Internal server error -

    • systemPruneLibpodWithHttpInfo

      public ApiResponse<SystemPruneReport> systemPruneLibpodWithHttpInfo() throws ApiException
      Prune unused data
      Returns:
      ApiResponse<SystemPruneReport>
      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 System Prune results -
      400 Bad parameter in request -
      500 Internal server error -

    • systemPruneLibpodAsync

      public okhttp3.Call systemPruneLibpodAsync(ApiCallback<SystemPruneReport> _callback) throws ApiException
      Prune unused data (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 System Prune results -
      400 Bad parameter in request -
      500 Internal server error -

    • systemVersionLibpodCall

      public okhttp3.Call systemVersionLibpodCall(ApiCallback _callback) throws ApiException
      Build call for systemVersionLibpod
      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 Version -

    • systemVersionLibpod

      public SystemComponentVersion systemVersionLibpod() throws ApiException
      Component Version information
      Returns:
      SystemComponentVersion
      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 Version -

    • systemVersionLibpodWithHttpInfo

      public ApiResponse<SystemComponentVersion> systemVersionLibpodWithHttpInfo() throws ApiException
      Component Version information
      Returns:
      ApiResponse<SystemComponentVersion>
      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 Version -

    • systemVersionLibpodAsync

      public okhttp3.Call systemVersionLibpodAsync(ApiCallback<SystemComponentVersion> _callback) throws ApiException
      Component Version information (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 Version -