Package org.gcube.common.health.api.response

Class HealthCheckResponseBuilder

java.lang.Object

org.gcube.common.health.api.response.HealthCheckResponseBuilder

public class HealthCheckResponseBuilder
extends Object

Builds a HealthCheckResponse. The builder keeps the values it is given and creates a new response at each build(): a response already built does not change when the builder is used again.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	HealthCheckResponseBuilder.BuildPart
class	HealthCheckResponseBuilder.ErrorPart
class	HealthCheckResponseBuilder.SuccessPart

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HealthCheckResponseBuilder(String name)

Method Summary

Modifier and Type	Method	Description
HealthCheckResponseBuilder.ErrorPart	degraded()	The check is ready but degraded, e.g. a cache not reachable while the service still works: error says why.
HealthCheckResponseBuilder.ErrorPart	down()
HealthCheckResponseBuilder.SuccessPart	up()

Methods inherited from class java.lang.Object

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

Constructor Details

HealthCheckResponseBuilder

protected HealthCheckResponseBuilder(String name)

Method Details

up

public HealthCheckResponseBuilder.SuccessPart up()

down

public HealthCheckResponseBuilder.ErrorPart down()

degraded

public HealthCheckResponseBuilder.ErrorPart degraded()

The check is ready but degraded, e.g. a cache not reachable while the service still works: error says why.

Returns:

the part giving the reason