Package com.chrt.api.resources.root

Class RawRootClient

java.lang.Object

com.chrt.api.resources.root.RawRootClient

public class RawRootClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawRootClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ChrtApiHttpResponse<java.lang.Object>	failure()	Test endpoint that intentionally fails for error handling validation and monitoring purposes.
ChrtApiHttpResponse<java.lang.Object>	failure(RequestOptions requestOptions)	Test endpoint that intentionally fails for error handling validation and monitoring purposes.
ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.Object>>	health()	Returns a health status message used for monitoring system availability and uptime.
ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.Object>>	health(RequestOptions requestOptions)	Returns a health status message used for monitoring system availability and uptime.
ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.String>>	pingAuthd()	Test endpoint for authenticated requests that requires valid authentication tokens.
ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.String>>	pingAuthd(RequestOptions requestOptions)	Test endpoint for authenticated requests that requires valid authentication tokens.
ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.Object>>	pingOptionallyAuthd()	Test endpoint for optionally authenticated requests that works with or without authentication.
ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.Object>>	pingOptionallyAuthd(RequestOptions requestOptions)	Test endpoint for optionally authenticated requests that works with or without authentication.
ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.Object>>	pingUnauthd()	Returns a greeting message to verify the API is accessible.
ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.Object>>	pingUnauthd(RequestOptions requestOptions)	Returns a greeting message to verify the API is accessible.

Methods inherited from class java.lang.Object

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

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

RawRootClient

public RawRootClient(ClientOptions clientOptions)

Method Detail

pingAuthd

public ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.String>> pingAuthd()

Test endpoint for authenticated requests that requires valid authentication tokens. | () -> (dict[str, str])

pingAuthd

public ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.String>> pingAuthd(RequestOptions requestOptions)

Test endpoint for authenticated requests that requires valid authentication tokens. | () -> (dict[str, str])

pingOptionallyAuthd

public ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.Object>> pingOptionallyAuthd()

Test endpoint for optionally authenticated requests that works with or without authentication. | () -> (dict)

pingOptionallyAuthd

public ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.Object>> pingOptionallyAuthd(RequestOptions requestOptions)

Test endpoint for optionally authenticated requests that works with or without authentication. | () -> (dict)

pingUnauthd

public ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.Object>> pingUnauthd()

Returns a greeting message to verify the API is accessible. | () -> (dict)

pingUnauthd

public ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.Object>> pingUnauthd(RequestOptions requestOptions)

Returns a greeting message to verify the API is accessible. | () -> (dict)

health

public ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.Object>> health()

Returns a health status message used for monitoring system availability and uptime. | () -> (dict)

health

public ChrtApiHttpResponse<java.util.Map<java.lang.String,java.lang.Object>> health(RequestOptions requestOptions)

Returns a health status message used for monitoring system availability and uptime. | () -> (dict)

failure

public ChrtApiHttpResponse<java.lang.Object> failure()

Test endpoint that intentionally fails for error handling validation and monitoring purposes. | () -> (None)

failure

public ChrtApiHttpResponse<java.lang.Object> failure(RequestOptions requestOptions)

Test endpoint that intentionally fails for error handling validation and monitoring purposes. | () -> (None)