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

Class SystemApi.APIsystemPingRequest

java.lang.Object

io.github.alersrt.pod4j.openapi.api.SystemApi.APIsystemPingRequest

Enclosing class:

SystemApi

public class SystemApi.APIsystemPingRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for systemPing
String	execute()	Execute systemPing request
okhttp3.Call	executeAsync(ApiCallback<String> _callback)	Execute systemPing request (asynchronously)
ApiResponse<String>	executeWithHttpInfo()	Execute systemPing request with HTTP info returned

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for systemPing

Parameters:

_callback - ApiCallback API callback

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	-

execute

public String execute()
               throws ApiException

Execute systemPing request

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	-

executeWithHttpInfo

public ApiResponse<String> executeWithHttpInfo()
                                        throws ApiException

Execute systemPing request with HTTP info returned

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	-

executeAsync

public okhttp3.Call executeAsync(ApiCallback<String> _callback)
                          throws ApiException

Execute systemPing request (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	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	-