spring-boot/org.springframework.boot.availability/ReadinessState

ReadinessState

"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.

Author

Brian Clozel

Since

2.3.0

Entries

ACCEPTING_TRAFFIC

The application is ready to receive traffic.

REFUSING_TRAFFIC

The application is not willing to receive traffic.

Functions

valueOf

open fun valueOf(name: String): ReadinessState

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

open fun values(): Array<ReadinessState>

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.