Package org.springframework.boot.availability

Enum Class ReadinessState

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

An application is considered ready when it's live and willing to accept traffic. "Readiness" failure means that the application is not able to accept traffic and that the infrastructure should stop routing requests to it.

Since:
2.3.0

  • Enum Constant Details

    • ACCEPTING_TRAFFIC

      public static final ReadinessState ACCEPTING_TRAFFIC
      The application is ready to receive traffic.

    • REFUSING_TRAFFIC

      public static final ReadinessState REFUSING_TRAFFIC
      The application is not willing to receive traffic.

  • Method Details

    • values

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