org.springframework.boot.actuate.health

类 Health

java.lang.Object

org.springframework.boot.actuate.health.HealthComponent

org.springframework.boot.actuate.health.Health

public final class Health
extends HealthComponent

Carries information about the health of a component or subsystem. Extends HealthComponent so that additional contextual details about the system can be returned along with the Status.

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 Health.up().withDetail("version", "1.1.2").build();
 }
 catch (Exception ex) {
        return Health.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(java.lang.Exception ex) Create a new Health.Builder instance with an Status.DOWN status and the specified exception details.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.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(Status status) Create a new Health.Builder instance with a specific Status.
static Health.Builder	status(java.lang.String statusCode) Create a new Health.Builder instance with a specific status code.
java.lang.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.

指定者:

getStatus 在类中 HealthComponent

返回:

the status (never null)

getDetails

public java.util.Map<java.lang.String,java.lang.Object> getDetails()

Return the details of the health.

返回:

the details (or an empty map)

equals

public boolean equals(java.lang.Object obj)

覆盖:

equals 在类中 java.lang.Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 java.lang.Object

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.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(java.lang.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(java.lang.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