Class Health.Builder

java.lang.Object

org.springframework.boot.health.contributor.Health.Builder

Enclosing class:

Health

public static class Health.Builder
extends Object

Builder for creating immutable Health instances.

Since:

4.0.0

Author:

Christian Dupuis, Phillip Webb, Michael Pratt

Constructor Summary

Constructors

Constructor	Description
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.

Method Summary

Modifier and Type	Method	Description
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 exception)	Record detail for given Exception.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Create new Builder instance.

Builder

public Builder(Status status)

Create new Builder instance, setting status to given status.

Parameters:

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.

Parameters:

status - the Status to use

details - the details Map to use

Method Details

withException

public Health.Builder withException(Throwable exception)

Record detail for given Exception.

Parameters:

exception - the exception

Returns:

this Health.Builder instance

withDetail

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

Record detail using given key and value.

Parameters:

key - the detail key

value - the detail value

Returns:

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.

Parameters:

details - map of details

Returns:

this Health.Builder instance

unknown

public Health.Builder unknown()

Set status to Status.UNKNOWN status.

Returns:

this Health.Builder instance

up

public Health.Builder up()

Set status to Status.UP status.

Returns:

this Health.Builder instance

down

public Health.Builder down(Throwable ex)

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

Parameters:

ex - the exception

Returns:

this Health.Builder instance

down

public Health.Builder down()

Set status to Status.DOWN.

Returns:

this Health.Builder instance

outOfService

public Health.Builder outOfService()

Set status to Status.OUT_OF_SERVICE.

Returns:

this Health.Builder instance

status

public Health.Builder status(String statusCode)

Set status to given statusCode.

Parameters:

statusCode - the status code

Returns:

this Health.Builder instance

status

public Health.Builder status(Status status)

Set status to given Status instance.

Parameters:

status - the status

Returns:

this Health.Builder instance

build

public Health build()

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

Returns:

a new Health instance