Package dev.getelements.elements.sdk.service.health

Interface HealthStatusService

All Known Implementing Classes:
DefaultHealthStatusService
public interface HealthStatusService
Generates a HealthStatus

  • Method Summary

    Modifier and Type
    Method
    Description
    HealthStatus
    checkHealthStatus()
    Performs some health checks on the server and then returns the status.

  • Method Details

    • checkHealthStatus

      HealthStatus checkHealthStatus()
      Performs some health checks on the server and then returns the status. If any health check fails this will throw an exception. If the system is healthy, this will return the HealthStatus.
      Returns:
      the HealthStatus