Class Status
- java.lang.Object
- org.springframework.boot.actuate.health.Status
public final class Status extends Object
Value object to express state of a component or subsystem.Status provides convenient constants for commonly used states like
UP
,DOWN
orOUT_OF_SERVICE
.Custom states can also be created and used throughout the Spring Boot Health subsystem.
- Since:
- 1.1.0
Field Summary
Fields Modifier and Type Field Description static Status
DOWN
Status
indicating that the component or subsystem has suffered an unexpected failure.static Status
OUT_OF_SERVICE
Status
indicating that the component or subsystem has been taken out of service and should not be used.static Status
UNKNOWN
Status
indicating that the component or subsystem is in an unknown state.static Status
UP
Status
indicating that the component or subsystem is functioning as expected.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
String
getCode()
Return the code for this status.String
getDescription()
Return the description of this status.int
hashCode()
String
toString()
Field Detail
UNKNOWN
public static final Status UNKNOWN
Status
indicating that the component or subsystem is in an unknown state.
UP
public static final Status UP
Status
indicating that the component or subsystem is functioning as expected.
DOWN
public static final Status DOWN
Status
indicating that the component or subsystem has suffered an unexpected failure.
OUT_OF_SERVICE
public static final Status OUT_OF_SERVICE
Status
indicating that the component or subsystem has been taken out of service and should not be used.
Method Detail
getDescription
public String getDescription()
Return the description of this status.- Returns:
- the description