Package io.lakefs.clients.api

Class HealthCheckApi

java.lang.Object

io.lakefs.clients.api.HealthCheckApi

public class HealthCheckApi
extends Object

Constructor Summary

Constructors

Constructor	Description
HealthCheckApi()
HealthCheckApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
void	healthCheck()	check that the API server is up and running
okhttp3.Call	healthCheckAsync(ApiCallback<Void> _callback)	(asynchronously) check that the API server is up and running
okhttp3.Call	healthCheckCall(ApiCallback _callback)	Build call for healthCheck
ApiResponse<Void>	healthCheckWithHttpInfo()	check that the API server is up and running
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheckApi

public HealthCheckApi()

HealthCheckApi

public HealthCheckApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

healthCheckCall

public okhttp3.Call healthCheckCall(ApiCallback _callback)
                             throws ApiException

Build call for healthCheck

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
204	NoContent	-

healthCheck

public void healthCheck()
                 throws ApiException

check that the API server is up and running

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
204	NoContent	-

healthCheckWithHttpInfo

public ApiResponse<Void> healthCheckWithHttpInfo()
                                          throws ApiException

check that the API server is up and running

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
204	NoContent	-

healthCheckAsync

public okhttp3.Call healthCheckAsync(ApiCallback<Void> _callback)
                              throws ApiException

(asynchronously) check that the API server is up and running

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
204	NoContent	-