Class SystemCompatApi
java.lang.Object
io.github.alersrt.pod4j.openapi.api.SystemCompatApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintvoidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex) systemAuth(AuthConfig authConfig) Check auth configurationokhttp3.CallsystemAuthAsync(AuthConfig authConfig, ApiCallback<AuthReport> _callback) Check auth configuration (asynchronously)okhttp3.CallsystemAuthCall(AuthConfig authConfig, ApiCallback _callback) Build call for systemAuthsystemAuthWithHttpInfo(AuthConfig authConfig) Check auth configurationShow disk usage Return information about disk usage for containers, images, and volumesokhttp3.CallsystemDataUsageAsync(ApiCallback<SystemDfReport> _callback) Show disk usage (asynchronously) Return information about disk usage for containers, images, and volumesokhttp3.CallsystemDataUsageCall(ApiCallback _callback) Build call for systemDataUsageShow disk usage Return information about disk usage for containers, images, and volumesvoidsystemEvents(String since, String until, String filters) Get events Returns events filtered on query parametersokhttp3.CallsystemEventsAsync(String since, String until, String filters, ApiCallback<Void> _callback) Get events (asynchronously) Returns events filtered on query parametersokhttp3.CallsystemEventsCall(String since, String until, String filters, ApiCallback _callback) Build call for systemEventssystemEventsWithHttpInfo(String since, String until, String filters) Get events Returns events filtered on query parametersvoidGet info Returns information on the system and libpod configurationokhttp3.CallsystemInfoAsync(ApiCallback<Void> _callback) Get info (asynchronously) Returns information on the system and libpod configurationokhttp3.CallsystemInfoCall(ApiCallback _callback) Build call for systemInfoGet info Returns information on the system and libpod configurationPing service Return protocol information in response headers.okhttp3.CallsystemPingAsync(ApiCallback<String> _callback) Ping service (asynchronously) Return protocol information in response headers.okhttp3.CallsystemPingCall(ApiCallback _callback) Build call for systemPingPing service Return protocol information in response headers.Component Version informationokhttp3.CallsystemVersionAsync(ApiCallback<SystemComponentVersion> _callback) Component Version information (asynchronously)okhttp3.CallsystemVersionCall(ApiCallback _callback) Build call for systemVersionComponent Version information
-
Constructor Details
-
SystemCompatApi
public SystemCompatApi() -
SystemCompatApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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 -
-