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

Class HealthCheckResponseBuilder.BuildPart

java.lang.Object

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

Direct Known Subclasses:

HealthCheckResponseBuilder.SuccessPart

Enclosing class:

HealthCheckResponseBuilder

public class HealthCheckResponseBuilder.BuildPart
extends Object

Method Summary

Modifier and Type	Method	Description
HealthCheckResponse	build()	Creates the response with the values given so far: each call returns a new response.
HealthCheckResponseBuilder.BuildPart	withData(String key, Object value)	Adds an entry to the structured data of the check.

Methods inherited from class java.lang.Object

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

Method Details

withData

public HealthCheckResponseBuilder.BuildPart withData(String key,
 Object value)

Adds an entry to the structured data of the check.

Parameters:

key - the name of the entry

value - its value: a string, a number, a boolean or a list of them

Returns:

this part, to add more data or to build the response

build

public HealthCheckResponse build()

Creates the response with the values given so far: each call returns a new response.

Returns:

the response

Throws:

IllegalStateException - if the response is not valid