Class SystemCompatApi

java.lang.Object
io.github.alersrt.pod4j.openapi.api.SystemCompatApi

public class SystemCompatApi extends Object
  • Constructor Details

    • SystemCompatApi

      public SystemCompatApi()
    • SystemCompatApi

      public SystemCompatApi(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)
    • systemAuthCall

      public okhttp3.Call systemAuthCall(AuthConfig authConfig, ApiCallback _callback) throws ApiException
      Build call for systemAuth
      Parameters:
      authConfig - Authentication to check (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 Auth response -
      500 Internal server error -
    • systemAuth

      public AuthReport systemAuth(AuthConfig authConfig) throws ApiException
      Check auth configuration
      Parameters:
      authConfig - Authentication to check (optional)
      Returns:
      AuthReport
      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 Auth response -
      500 Internal server error -
    • systemAuthWithHttpInfo

      public ApiResponse<AuthReport> systemAuthWithHttpInfo(AuthConfig authConfig) throws ApiException
      Check auth configuration
      Parameters:
      authConfig - Authentication to check (optional)
      Returns:
      ApiResponse<AuthReport>
      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 Auth response -
      500 Internal server error -
    • systemAuthAsync

      public okhttp3.Call systemAuthAsync(AuthConfig authConfig, ApiCallback<AuthReport> _callback) throws ApiException
      Check auth configuration (asynchronously)
      Parameters:
      authConfig - Authentication to check (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 Auth response -
      500 Internal server error -
    • systemDataUsageCall

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

      public SystemDfReport systemDataUsage() 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 -
    • systemDataUsageWithHttpInfo

      public ApiResponse<SystemDfReport> systemDataUsageWithHttpInfo() 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 -
    • systemDataUsageAsync

      public okhttp3.Call systemDataUsageAsync(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 -
    • systemEventsCall

      public okhttp3.Call systemEventsCall(String since, String until, String filters, ApiCallback _callback) throws ApiException
      Build call for systemEvents
      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)
      _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 -
    • systemEvents

      public void systemEvents(String since, String until, String filters) 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)
      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 -
    • systemEventsWithHttpInfo

      public ApiResponse<Void> systemEventsWithHttpInfo(String since, String until, String filters) 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)
      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 -
    • systemEventsAsync

      public okhttp3.Call systemEventsAsync(String since, String until, String filters, 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)
      _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 -
    • systemInfoCall

      public okhttp3.Call systemInfoCall(ApiCallback _callback) throws ApiException
      Build call for systemInfo
      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 to be determined -
      500 Internal server error -
    • systemInfo

      public void systemInfo() throws ApiException
      Get info Returns information on the system and libpod configuration
      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 to be determined -
      500 Internal server error -
    • systemInfoWithHttpInfo

      public ApiResponse<Void> systemInfoWithHttpInfo() throws ApiException
      Get info Returns information on the system and libpod configuration
      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 to be determined -
      500 Internal server error -
    • systemInfoAsync

      public okhttp3.Call systemInfoAsync(ApiCallback<Void> _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 to be determined -
      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 -
    • systemVersionCall

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

      public SystemComponentVersion systemVersion() 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 -
    • systemVersionWithHttpInfo

      public ApiResponse<SystemComponentVersion> systemVersionWithHttpInfo() 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 -
    • systemVersionAsync

      public okhttp3.Call systemVersionAsync(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 -