Class HealthChecks


  • public class HealthChecks
    extends Object

    NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

    • Constructor Detail

      • HealthChecks

        public HealthChecks​(io.vertx.ext.healthchecks.HealthChecks delegate)
      • HealthChecks

        public HealthChecks​(Object delegate)
    • Method Detail

      • getDelegate

        public io.vertx.ext.healthchecks.HealthChecks getDelegate()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • create

        public static HealthChecks create​(Vertx vertx)
        Parameters:
        vertx - the instance of Vert.x, must not be null
        Returns:
        the created instance
      • register

        public HealthChecks register​(String name,
                                     io.smallrye.mutiny.Uni<io.vertx.ext.healthchecks.Status> procedure)
        Parameters:
        name - the name of the procedure, must not be null or empty
        procedure - the procedure, must not be null
        Returns:
      • register

        public HealthChecks register​(String name,
                                     long timeout,
                                     io.smallrye.mutiny.Uni<io.vertx.ext.healthchecks.Status> procedure)
        Parameters:
        name - the name of the procedure, must not be null or empty
        timeout - the procedure timeout in milliseconds
        procedure - the procedure, must not be null
        Returns:
      • invoke

        public HealthChecks invoke​(Consumer<io.vertx.core.json.JsonObject> resultHandler)
        Parameters:
        resultHandler - the result handler, must not be null. The handler received the computed .
        Returns:
      • invoke

        @CheckReturnValue
        public io.smallrye.mutiny.Uni<io.vertx.core.json.JsonObject> invoke​(String name)
        Invokes the registered procedure with the given name and sub-procedures. It computes the overall outcome.

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Parameters:
        name -
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.
      • invokeAndAwait

        public io.vertx.core.json.JsonObject invokeAndAwait​(String name)
        Blocking variant of invoke(String).

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Parameters:
        name -
        Returns:
        the JsonObject instance produced by the operation.
      • invokeAndForget

        public HealthChecks invokeAndForget​(String name)
        Variant of invoke(String) that ignores the result of the operation.

        This method subscribes on the result of invoke(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from invoke(String) but you don't need to compose it with other operations.

        Parameters:
        name -
        Returns:
        the instance of HealthChecks to chain method calls.
      • checkStatus

        @CheckReturnValue
        public io.smallrye.mutiny.Uni<io.vertx.ext.healthchecks.CheckResult> checkStatus()
        Invokes the registered procedures.

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.
      • checkStatusAndAwait

        public io.vertx.ext.healthchecks.CheckResult checkStatusAndAwait()
        Blocking variant of checkStatus().

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Returns:
        the CheckResult instance produced by the operation.
      • checkStatusAndForget

        public void checkStatusAndForget()
        Variant of checkStatus() that ignores the result of the operation.

        This method subscribes on the result of checkStatus(), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from checkStatus() but you don't need to compose it with other operations.

      • checkStatus

        @CheckReturnValue
        public io.smallrye.mutiny.Uni<io.vertx.ext.healthchecks.CheckResult> checkStatus​(String name)
        Invokes the registered procedure with the given name and sub-procedures.

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Parameters:
        name -
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.
      • checkStatusAndAwait

        public io.vertx.ext.healthchecks.CheckResult checkStatusAndAwait​(String name)
        Blocking variant of checkStatus(String).

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Parameters:
        name -
        Returns:
        the CheckResult instance produced by the operation.
      • checkStatusAndForget

        public void checkStatusAndForget​(String name)
        Variant of checkStatus(String) that ignores the result of the operation.

        This method subscribes on the result of checkStatus(String), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from checkStatus(String) but you don't need to compose it with other operations.

        Parameters:
        name -
      • newInstance

        public static HealthChecks newInstance​(io.vertx.ext.healthchecks.HealthChecks arg)