Interface IHealthCheck.Result
-
- Enclosing interface:
- IHealthCheck
public static interface IHealthCheck.ResultInterface for a health check result.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetMessage()static IHealthCheck.Resulthealthy()booleanisHealthy()static IHealthCheck.Resultunhealthy(String message)static IHealthCheck.Resultunhealthy(Throwable t)
-
-
-
Method Detail
-
isHealthy
boolean isHealthy()
- Returns:
trueif the health check was successful,falseotherwise.
-
getMessage
String getMessage()
- Returns:
- The message of the health check.
-
healthy
static IHealthCheck.Result healthy()
- Returns:
- A healthy health check result.
-
unhealthy
static IHealthCheck.Result unhealthy(String message)
- Parameters:
message- The message of the health check.- Returns:
- An unhealthy health check result.
-
unhealthy
static IHealthCheck.Result unhealthy(Throwable t)
- Parameters:
t- The exception that caused the health check to fail.- Returns:
- An unhealthy health check result.
-
-