Class HealthCheckResultBuilder

java.lang.Object

org.apache.camel.health.HealthCheckResultBuilder

All Implemented Interfaces:

Builder<HealthCheck.Result>

public final class HealthCheckResultBuilder
extends Object
implements Builder<HealthCheck.Result>

A builder helper to create a HealthCheck result.

Method Summary

Modifier and Type	Method	Description
HealthCheck.Result	build()
@Nullable Object	detail(String key)	Gets a detail value by key from the health check result.
HealthCheckResultBuilder	detail(String key, Object value)	Sets a detail key/value pair for the health check result.
HealthCheckResultBuilder	details(Map<String,Object> details)	Sets multiple detail key/value pairs for the health check result.
HealthCheckResultBuilder	down()	Marks the health check as DOWN.
@Nullable Throwable	error()	Gets the error associated with the health check result.
HealthCheckResultBuilder	error(@Nullable Throwable error)	Sets the error associated with the health check result.
@Nullable String	message()	Gets the message for the health check result.
HealthCheckResultBuilder	message(@Nullable String message)	Sets the message for the health check result.
static HealthCheckResultBuilder	on(HealthCheck check)	Creates a new builder for the given health check.
@Nullable HealthCheck.State	state()	Gets the state of the health check result.
HealthCheckResultBuilder	state(HealthCheck.State state)	Sets the state for the health check result.
String	toString()
HealthCheckResultBuilder	unknown()	Marks the health check as UNKNOWN.
HealthCheckResultBuilder	up()	Marks the health check as UP.

Methods inherited from class Object

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

Method Details

message

public @Nullable String message()

Gets the message for the health check result.

message

public HealthCheckResultBuilder message(@Nullable String message)

Sets the message for the health check result.

error

public @Nullable Throwable error()

Gets the error associated with the health check result.

error

public HealthCheckResultBuilder error(@Nullable Throwable error)

Sets the error associated with the health check result.

detail

public @Nullable Object detail(String key)

Gets a detail value by key from the health check result.

detail

public HealthCheckResultBuilder detail(String key,
 Object value)

Sets a detail key/value pair for the health check result.

details

public HealthCheckResultBuilder details(Map<String,Object> details)

Sets multiple detail key/value pairs for the health check result.

state

public @Nullable HealthCheck.State state()

Gets the state of the health check result.

state

public HealthCheckResultBuilder state(HealthCheck.State state)

Sets the state for the health check result.

up

public HealthCheckResultBuilder up()

Marks the health check as UP.

down

public HealthCheckResultBuilder down()

Marks the health check as DOWN.

unknown

public HealthCheckResultBuilder unknown()

Marks the health check as UNKNOWN.

build

public HealthCheck.Result build()

Specified by:

build in interface Builder<HealthCheck.Result>

on

public static HealthCheckResultBuilder on(HealthCheck check)

Creates a new builder for the given health check.

toString

public String toString()

Overrides:

toString in class Object