Package com.github.cafapi.common.api

Class HealthResult

java.lang.Object

com.github.cafapi.common.api.HealthResult

public final class HealthResult
extends Object

A result returned from a class that implements HealthReporter, indicating its health status and if necessary, a message detailing further information.

Field Summary

Fields

Modifier and Type	Field	Description
static final HealthResult	RESULT_HEALTHY

Constructor Summary

Constructors

Constructor	Description
HealthResult(HealthStatus healthStatus)
HealthResult(HealthStatus healthStatus, String healthMessage)

Method Summary

Modifier and Type	Method	Description
String	getMessage()
HealthStatus	getStatus()

Methods inherited from class java.lang.Object

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

Field Details

RESULT_HEALTHY

public static final HealthResult RESULT_HEALTHY

Constructor Details

HealthResult

public HealthResult(HealthStatus healthStatus,
 String healthMessage)

HealthResult

public HealthResult(HealthStatus healthStatus)

Method Details

getStatus

public HealthStatus getStatus()

getMessage

public String getMessage()