java.lang.Object
- org.springframework.boot.actuate.health.Health

```
public final class Health
extends Object
```
Carries information about the health of a component or subsystem.
Health contains a Status to express the state of a component or subsystem and some additional details to carry some contextual information.
Health instances can be created by using Health.Builder's fluent API. Typical usage in a HealthIndicator would be:
```
 try {
        // do some test to determine state of component
        return new Health.Builder().up().withDetail("version", "1.1.2").build();
 }
 catch (Exception ex) {
        return new Health.Builder().down(ex).build();
 }
 
```
Since:
1.1.0

Nested Class Summary
Nested Classes
Modifier and Type Class Description
static class Health.Builder
Builder for creating immutable Health instances.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Health.Builder`	`down()`	Create a new `Health.Builder` instance with a `Status.DOWN` status.
`static Health.Builder`	`down(Exception ex)`	Create a new `Health.Builder` instance with an `Status.DOWN` status and the specified exception details.
`boolean`	`equals(Object obj)`
`Map<String,Object>`	`getDetails()`	Return the details of the health.
`Status`	`getStatus()`	Return the status of the health.
`int`	`hashCode()`
`static Health.Builder`	`outOfService()`	Create a new `Health.Builder` instance with an `Status.OUT_OF_SERVICE` status.
`static Health.Builder`	`status(String statusCode)`	Create a new `Health.Builder` instance with a specific status code.
`static Health.Builder`	`status(Status status)`	Create a new `Health.Builder` instance with a specific `Status`.
`String`	`toString()`
`static Health.Builder`	`unknown()`	Create a new `Health.Builder` instance with an `Status.UNKNOWN` status.
`static Health.Builder`	`up()`	Create a new `Health.Builder` instance with an `Status.UP` status.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getStatus
```
public Status getStatus()
```
    Return the status of the health.
    Returns:
    the status (never null)
  - getDetails
```
public Map<String,Object> getDetails()
```
    Return the details of the health.
    Returns:
    the details (or an empty map)
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    toString in class Object
  - unknown
```
public static Health.Builder unknown()
```
    Create a new Health.Builder instance with an Status.UNKNOWN status.
    Returns:
    a new Health.Builder instance
  - up
```
public static Health.Builder up()
```
    Create a new Health.Builder instance with an Status.UP status.
    Returns:
    a new Health.Builder instance
  - down
```
public static Health.Builder down(Exception ex)
```
    Create a new Health.Builder instance with an Status.DOWN status and the specified exception details.
    Parameters:
    ex - the exception
    Returns:
    a new Health.Builder instance
  - down
```
public static Health.Builder down()
```
    Create a new Health.Builder instance with a Status.DOWN status.
    Returns:
    a new Health.Builder instance
  - outOfService
```
public static Health.Builder outOfService()
```
    Create a new Health.Builder instance with an Status.OUT_OF_SERVICE status.
    Returns:
    a new Health.Builder instance
  - status
```
public static Health.Builder status(String statusCode)
```
    Create a new Health.Builder instance with a specific status code.
    Parameters:
    statusCode - the status code
    Returns:
    a new Health.Builder instance
  - status
```
public static Health.Builder status(Status status)
```
    Create a new Health.Builder instance with a specific Status.
    Parameters:
    status - the status
    Returns:
    a new Health.Builder instance

Class Health

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getStatus

getDetails

equals

hashCode

toString

unknown

up

down

down

outOfService

status

status