Package com.algorand.algosdk.v2.client.algod

Class HealthCheck

java.lang.Object

com.algorand.algosdk.v2.client.common.Query

com.algorand.algosdk.v2.client.algod.HealthCheck

public class HealthCheck
extends Query

Returns OK if healthy. /health

Field Summary

Fields inherited from class com.algorand.algosdk.v2.client.common.Query

qd

Constructor Summary

Constructors

Constructor	Description
HealthCheck(Client client)

Method Summary

Modifier and Type	Method	Description
Response<String>	execute()	Execute the query.
Response<String>	execute(String[] headers, String[] values)	Execute the query with custom headers, there must be an equal number of keys and values or else an error will be generated.
protected QueryData	getRequestString()

Methods inherited from class com.algorand.algosdk.v2.client.common.Query

addPathSegment, addQuery, addToBody, addToBody, baseExecute, baseExecute, getRequestMethod, getRequestUrl, getRequestUrl, resetPathSegment

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheck

public HealthCheck(Client client)

Method Detail

execute

public Response<String> execute()
                         throws Exception

Execute the query.

Specified by:

execute in class Query

Returns:

the query response object.

Throws:

Exception

execute

public Response<String> execute(String[] headers,
                                String[] values)
                         throws Exception

Execute the query with custom headers, there must be an equal number of keys and values or else an error will be generated.

Specified by:

execute in class Query

Parameters:

headers - an array of header keys

values - an array of header values

Returns:

the query response object.

Throws:

Exception

getRequestString

protected QueryData getRequestString()

Specified by:

getRequestString in class Query