Package org.springframework.boot.availability

Enum Class LivenessState

java.lang.Object
java.lang.Enum<LivenessState>
org.springframework.boot.availability.LivenessState
All Implemented Interfaces:
Serializable, Comparable<LivenessState>, Constable, AvailabilityState
public enum LivenessState extends Enum<LivenessState> implements AvailabilityState
"Liveness" state of the application.

An application is considered live when it's running with a correct internal state. "Liveness" failure means that the internal state of the application is broken and we cannot recover from it. As a result, the platform should restart the application.

Since:
2.3.0

  • Enum Constant Details

    • CORRECT

      public static final LivenessState CORRECT
      The application is running and its internal state is correct.

    • BROKEN

      public static final LivenessState BROKEN
      The application is running but its internal state is broken.

  • Method Details

    • values

      public static LivenessState[] 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 LivenessState 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