Package org.gcube.common.health.api

Interface HealthCheck

public interface HealthCheck

Method Summary

Modifier and Type	Method	Description
HealthCheckResponse	check()
default String	getDescription()	Returns what the check verifies, in one sentence for a reader of the health, e.g.
String	getName()

Method Details

getName

String getName()

getDescription

default String getDescription()

Returns what the check verifies, in one sentence for a reader of the health, e.g. "The database of the service answers". The health is public: the sentence names what the service needs (a database, a cache), not the product that provides it.

Returns:

the description, or null when the check gives none

check

HealthCheckResponse check()