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();
 }
 
```
从以下版本开始:
1.1.0

嵌套类概要
嵌套类
修饰符和类型类说明
static class Health.Builder
Builder for creating immutable Health instances.

方法概要

所有方法静态方法实例方法具体方法
修饰符和类型	方法	说明
`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.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 方法详细资料
  - getStatus
```
public Status getStatus()
```
    Return the status of the health.
    返回:
    the status (never null)
  - getDetails
```
public Map<String,Object> getDetails()
```
    Return the details of the health.
    返回:
    the details (or an empty map)
  - equals
```
public boolean equals(Object obj)
```
    覆盖:
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    hashCode 在类中 Object
  - toString
```
public String toString()
```
    覆盖:
    toString 在类中 Object
  - unknown
```
public static Health.Builder unknown()
```
    Create a new Health.Builder instance with an Status.UNKNOWN status.
    返回:
    a new Health.Builder instance
  - up
```
public static Health.Builder up()
```
    Create a new Health.Builder instance with an Status.UP status.
    返回:
    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.
    参数:
    ex - the exception
    返回:
    a new Health.Builder instance
  - down
```
public static Health.Builder down()
```
    Create a new Health.Builder instance with a Status.DOWN status.
    返回:
    a new Health.Builder instance
  - outOfService
```
public static Health.Builder outOfService()
```
    Create a new Health.Builder instance with an Status.OUT_OF_SERVICE status.
    返回:
    a new Health.Builder instance
  - status
```
public static Health.Builder status(String statusCode)
```
    Create a new Health.Builder instance with a specific status code.
    参数:
    statusCode - the status code
    返回:
    a new Health.Builder instance
  - status
```
public static Health.Builder status(Status status)
```
    Create a new Health.Builder instance with a specific Status.
    参数:
    status - the status
    返回:
    a new Health.Builder instance

类 Health

嵌套类概要

方法概要

从类继承的方法 java.lang.Object

方法详细资料

getStatus

getDetails

equals

hashCode

toString

unknown

up

down

down

outOfService

status

status