Package io.streamthoughts.azkarra.http.health

Class Health.Builder

java.lang.Object

io.streamthoughts.azkarra.http.health.Health.Builder

Enclosing class:

Health

public static class Health.Builder
extends Object

Builder for creating new Health instances.

Constructor Summary

Constructors

Constructor	Description
Builder()	Creates a new Health.Builder instance.

Method Summary

Modifier and Type	Method	Description
Health	build()	Builds a new Health instance.
Health.Builder	down()	Sets the status for the Health indicator to be built to Status.DOWN.
Health.Builder	unknown()	Sets the status for the Health indicator to be built Status.UNKNOWN.
Health.Builder	up()	Sets the status for the Health indicator to be built to Status.UP.
Health.Builder	withDetails(String key, Object value)	Adds a details entry for the Health indicator.
Health.Builder	withException(Throwable exception)	Sets the exception for the Health indicator.
Health.Builder	withName(String name)	Sets the name of service or sub-system.
Health.Builder	withStatus(Status status)	Sets the Status for the Health indicator.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates a new Health.Builder instance.

Method Detail

down

public Health.Builder down()

Sets the status for the Health indicator to be built to Status.DOWN.

Returns:

this Health.Builder instance.

up

public Health.Builder up()

Sets the status for the Health indicator to be built to Status.UP.

Returns:

this Health.Builder instance.

unknown

public Health.Builder unknown()

Sets the status for the Health indicator to be built Status.UNKNOWN.

Returns:

this Health.Builder instance.

withName

public Health.Builder withName(String name)

Sets the name of service or sub-system.

Parameters:

name - the name.

Returns:

this Health.Builder instance.

withDetails

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

Adds a details entry for the Health indicator.

Parameters:

key - the detail key.

value - the detail value.

Returns:

this Health.Builder instance.

withException

public Health.Builder withException(Throwable exception)

Sets the exception for the Health indicator.

Parameters:

exception - the exception.

Returns:

this Health.Builder instance.

withStatus

public Health.Builder withStatus(Status status)

Sets the Status for the Health indicator.

Parameters:

status - the status.

Returns:

this Health.Builder instance.

build

public Health build()

Builds a new Health instance.

Returns:

the Health instance.