Enum Class HealthStatus

java.lang.Object
java.lang.Enum<HealthStatus>
com.kingsrook.qqq.middleware.health.model.metadata.HealthStatus
All Implemented Interfaces:
Serializable, Comparable<HealthStatus>, Constable
@Deprecated(since="4.1", forRemoval=true) public enum HealthStatus extends Enum<HealthStatus>
Deprecated, for removal: This API element is subject to removal in a future version.
Enum representing the health status of a component or the overall system. Status meanings: - UP: Component is functioning normally - DOWN: Component is not functioning (critical failure) - DEGRADED: Component is functioning but with reduced capability - UNKNOWN: Component status could not be determined

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DEGRADED
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    DOWN
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    UNKNOWN
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    UP
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static HealthStatus
    aggregate(HealthStatus... statuses)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Determine the overall status from multiple component statuses.
    static HealthStatus
    fromCore(HealthStatus status)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Convert a core status for legacy callers.
    HealthStatus
    toCore()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Convert without changing the legacy enum's public constants.
    static HealthStatus
    valueOf(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the enum constant of this class with the specified name.
    static HealthStatus[]
    values()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • UP

      public static final HealthStatus UP
      Deprecated, for removal: This API element is subject to removal in a future version.

    • DOWN

      public static final HealthStatus DOWN
      Deprecated, for removal: This API element is subject to removal in a future version.

    • DEGRADED

      public static final HealthStatus DEGRADED
      Deprecated, for removal: This API element is subject to removal in a future version.

    • UNKNOWN

      public static final HealthStatus UNKNOWN
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • values

      public static HealthStatus[] values()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static HealthStatus valueOf(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • aggregate

      public static HealthStatus aggregate(HealthStatus... statuses)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Determine the overall status from multiple component statuses. Rules: - If any component is DOWN, overall is DOWN - If all components are UP, overall is UP - If any component is DEGRADED (and none are DOWN), overall is DEGRADED - If any component is UNKNOWN (and none are DOWN/DEGRADED), overall is UNKNOWN

    • toCore

      public HealthStatus toCore()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Convert without changing the legacy enum's public constants.

    • fromCore

      public static HealthStatus fromCore(HealthStatus status)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Convert a core status for legacy callers.