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

Class HealthCheckResponseBuilder.ErrorPart

java.lang.Object

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

Enclosing class:

HealthCheckResponseBuilder

public class HealthCheckResponseBuilder.ErrorPart
extends Object

Method Summary

Modifier and Type	Method	Description
HealthCheckResponseBuilder.BuildPart	error(String message)	Says why the check is degraded or down.

Methods inherited from class java.lang.Object

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

Method Details

error

public HealthCheckResponseBuilder.BuildPart error(String message)

Says why the check is degraded or down. The health is public: the message is a fixed, generic sentence, e.g. "The database does not answer", never the text of an exception, a host, a port or a configuration value; the details go to the log of the service.

Parameters:

message - the reason, for any reader of the health

Returns:

the part that builds the response