Interface IHealthCheck.Result

Enclosing interface:
IHealthCheck
public static interface IHealthCheck.Result
Interface for a health check result.
Since:
8.2.0

  • Method Details

    • isHealthy

      boolean isHealthy()
      Returns:
      true if the health check was successful, false otherwise.

    • 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.