Record Class HealthStatus

java.lang.Object
java.lang.Record
codes.grow.packages.betterstack.core.HealthStatus
Record Components:
healthy - whether the service is usable
status - ok, degraded, unhealthy, unreachable or a vendor word
details - extra vendor details

public record HealthStatus(boolean healthy, String status, Map<String,String> details) extends Record
Result of health() (SPEC section 2.4).
  • Constructor Details

    • HealthStatus

      public HealthStatus(boolean healthy, String status, Map<String,String> details)
      Creates a status; details are copied.
      Parameters:
      healthy - whether the service is usable
      status - status word
      details - extra details
  • Method Details

    • ok

      public static HealthStatus ok()
      A healthy ok status without details.
      Returns:
      the status
    • unreachable

      public static HealthStatus unreachable(String reason)
      The status for a service that could not be reached.
      Parameters:
      reason - redacted reason, stored in details under error
      Returns:
      an unhealthy unreachable status
    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.
    • healthy

      public boolean healthy()
      Returns the value of the healthy record component.
      Returns:
      the value of the healthy record component
    • status

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

      public Map<String,String> details()
      Returns the value of the details record component.
      Returns:
      the value of the details record component