程序包 org.springframework.boot.actuate.health

类 Health.Builder

java.lang.Object

org.springframework.boot.actuate.health.Health.Builder

封闭类:

Health

public static class Health.Builder
extends Object

Builder for creating immutable Health instances.

构造器概要

构造器

构造器	说明
Builder()	Create new Builder instance.
Builder(Status status)	Create new Builder instance, setting status to given status.
Builder(Status status, Map<String,?> details)	Create new Builder instance, setting status to given status and details to given details.

方法概要

修饰符和类型	方法	说明
Health	build()	Create a new Health instance with the previously specified code and details.
Health.Builder	down()	Set status to Status.DOWN.
Health.Builder	down(Throwable ex)	Set status to Status.DOWN and add details for given Throwable.
Health.Builder	outOfService()	Set status to Status.OUT_OF_SERVICE.
Health.Builder	status(String statusCode)	Set status to given statusCode.
Health.Builder	status(Status status)	Set status to given Status instance.
Health.Builder	unknown()	Set status to Status.UNKNOWN status.
Health.Builder	up()	Set status to Status.UP status.
Health.Builder	withDetail(String key, Object value)	Record detail using given key and value.
Health.Builder	withDetails(Map<String,?> details)	Record details from the given details map.
Health.Builder	withException(Throwable ex)	Record detail for given Exception.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Builder

public Builder()

Create new Builder instance.

Builder

public Builder(Status status)

Create new Builder instance, setting status to given status.

参数:

status - the Status to use

Builder

public Builder(Status status,
 Map<String,?> details)

Create new Builder instance, setting status to given status and details to given details.

参数:

status - the Status to use

details - the details Map to use

方法详细资料

withException

public Health.Builder withException(Throwable ex)

Record detail for given Exception.

参数:

ex - the exception

返回:

this Health.Builder instance

withDetail

public Health.Builder withDetail(String key,
 Object value)

Record detail using given key and value.

参数:

key - the detail key

value - the detail value

返回:

this Health.Builder instance

withDetails

public Health.Builder withDetails(Map<String,?> details)

Record details from the given details map. Keys from the given map replace any existing keys if there are duplicates.

参数:

details - map of details

返回:

this Health.Builder instance

从以下版本开始:

2.1.0

unknown

public Health.Builder unknown()

Set status to Status.UNKNOWN status.

返回:

this Health.Builder instance

up

public Health.Builder up()

Set status to Status.UP status.

返回:

this Health.Builder instance

down

public Health.Builder down(Throwable ex)

Set status to Status.DOWN and add details for given Throwable.

参数:

ex - the exception

返回:

this Health.Builder instance

down

public Health.Builder down()

Set status to Status.DOWN.

返回:

this Health.Builder instance

outOfService

public Health.Builder outOfService()

Set status to Status.OUT_OF_SERVICE.

返回:

this Health.Builder instance

status

public Health.Builder status(String statusCode)

Set status to given statusCode.

参数:

statusCode - the status code

返回:

this Health.Builder instance

status

public Health.Builder status(Status status)

Set status to given Status instance.

参数:

status - the status

返回:

this Health.Builder instance

build

public Health build()

Create a new Health instance with the previously specified code and details.

返回:

a new Health instance