Package com.chrt.api.resources.root

Class RootClient

  • public class RootClient
extends java.lang.Object

    • Method Summary

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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • withRawResponse

        public RawRootClient withRawResponse()
        Get responses with HTTP metadata like headers

      • pingAuthd

        public 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 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 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 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 java.util.Map<java.lang.String,​java.lang.Object> pingUnauthd()
        Returns a greeting message to verify the API is accessible. | () -> (dict)

      • pingUnauthd

        public 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 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 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 java.lang.Object failure()
        Test endpoint that intentionally fails for error handling validation and monitoring purposes. | () -> (None)

      • failure

        public java.lang.Object failure​(RequestOptions requestOptions)
        Test endpoint that intentionally fails for error handling validation and monitoring purposes. | () -> (None)