Class SystemCompatApi
java.lang.Object
io.github.alersrt.pod4j.openapi.api.SystemCompatApi
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclassclassclassclassclassclass -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintvoidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex) Check auth configurationShow disk usage Return information about disk usage for containers, images, and volumesGet events Returns events filtered on query parametersGet info Returns information on the system and libpod configurationPing service Return protocol information in response headers.Component Version information
-
Constructor Details
-
SystemCompatApi
public SystemCompatApi() -
SystemCompatApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
systemAuth
Check auth configuration- Returns:
- APIsystemAuthRequest
- Http Response Details
Status Code Description Response Headers 200 Auth response - 500 Internal server error -
-
systemDataUsage
Show disk usage Return information about disk usage for containers, images, and volumes- Returns:
- APIsystemDataUsageRequest
- Http Response Details
Status Code Description Response Headers 200 Disk usage - 500 Internal server error -
-
systemEvents
Get events Returns events filtered on query parameters- Returns:
- APIsystemEventsRequest
- Http Response Details
Status Code Description Response Headers 200 returns a string of json data describing an event - 500 Internal server error -
-
systemInfo
Get info Returns information on the system and libpod configuration- Returns:
- APIsystemInfoRequest
- Http Response Details
Status Code Description Response Headers 200 to be determined - 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:
- 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 -
-
systemVersion
Component Version information- Returns:
- APIsystemVersionRequest
- Http Response Details
Status Code Description Response Headers 200 Version -
-