Package io.smallrye.health.api

Interface AsyncHealthCheck

Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface @Experimental("Asynchronous Health Check procedures") public interface AsyncHealthCheck
The async health check procedure interface. Invoked by consumers to verify the healthiness of a computing node in an asynchronous manner. Unhealthy nodes are expected to be terminated.

  • Method Summary

    Modifier and Type
    Method
    Description
    io.smallrye.mutiny.Uni<org.eclipse.microprofile.health.HealthCheckResponse>
    call()
    Invokes the health check procedure provided by the implementation of this interface.

  • Method Details

    • call

      io.smallrye.mutiny.Uni<org.eclipse.microprofile.health.HealthCheckResponse> call()
      Invokes the health check procedure provided by the implementation of this interface. Unlike synchronous checks, this method is used for asynchronous checks. The returned Uni propagates the HealthCheckResponse as item. If the returned Uni produces a failure, the check is considered as failed. Returning null is invalid and considers the check failed. In addition, returning a Uni propagating a null value as the item is considered also as a failure.
      Returns:
      Uni object containing information about the health check result