Package alpine.server.health

Enum Class HealthCheckType

java.lang.Object
java.lang.Enum<HealthCheckType>
alpine.server.health.HealthCheckType
All Implemented Interfaces:
Serializable, Comparable<HealthCheckType>, Constable
public enum HealthCheckType extends Enum<HealthCheckType>
Defines types of health checks supported by MicroProfile Health.
Since:
2.3.0
See Also:

  • 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
    ALL
    Probes that either do not specify their type, or apply to all types.
    LIVENESS
    Liveness probes may be used by service orchestrators to evaluate whether a service instance needs to be restarted.
    READINESS
    Readiness probes may be used by service orchestrators to evaluate whether a service instance is ready to accept traffic.
    STARTUP
    Startup probes may be used by service orchestrators to evaluate whether a service instance has started.

  • Method Summary

    Modifier and Type
    Method
    Description
    static HealthCheckType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static HealthCheckType[]
    values()
    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

    • LIVENESS

      public static final HealthCheckType LIVENESS
      Liveness probes may be used by service orchestrators to evaluate whether a service instance needs to be restarted.

    • READINESS

      public static final HealthCheckType READINESS
      Readiness probes may be used by service orchestrators to evaluate whether a service instance is ready to accept traffic.

    • STARTUP

      public static final HealthCheckType STARTUP
      Startup probes may be used by service orchestrators to evaluate whether a service instance has started.

    • ALL

      public static final HealthCheckType ALL
      Probes that either do not specify their type, or apply to all types.

  • Method Details

    • values

      public static HealthCheckType[] values()
      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 HealthCheckType valueOf(String name)
      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