Record Class HealthResponse

java.lang.Object
java.lang.Record
com.pain001.sdk.HealthResponse
Record Components:
status - the service status, healthy when it is up
version - the server's pain001 version
message - a human-readable status line

public record HealthResponse(String status, String version, String message) extends Record
GET /api/v1/health.
  • Constructor Details

    • HealthResponse

      public HealthResponse(String status, String version, String message)
      Creates an instance of a HealthResponse record class.
      Parameters:
      status - the value for the status record component
      version - the value for the version record component
      message - the value for the message record component
  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • status

      public String status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component
    • version

      public String version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component
    • message

      public String message()
      Returns the value of the message record component.
      Returns:
      the value of the message record component