Interface ReactiveHealthIndicator

All Superinterfaces:
ReactiveHealthContributor
All Known Implementing Classes:
AbstractReactiveHealthIndicator, CassandraDriverReactiveHealthIndicator, ConnectionFactoryHealthIndicator, CouchbaseReactiveHealthIndicator, DataElasticsearchReactiveHealthIndicator, DataRedisReactiveHealthIndicator, MongoReactiveHealthIndicator, Neo4jReactiveHealthIndicator
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public non-sealed interface ReactiveHealthIndicator extends ReactiveHealthContributor
Directly contributes Health information for specific reactive component or subsystem.

This is non-blocking contract that is meant to be used in a reactive application. See HealthIndicator for the traditional contract.

Since:
4.0.0
Author:
Stephane Nicoll
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default HealthIndicator
    asHealthContributor()
    Return this reactive contributor as a standard blocking HealthContributor.
    reactor.core.publisher.Mono<Health>
    health()
    Provide the indicator of health.
    default reactor.core.publisher.Mono<Health>
    health(boolean includeDetails)
    Provide the indicator of health.

  • Method Details

    • asHealthContributor

      default HealthIndicator asHealthContributor()
      Description copied from interface: ReactiveHealthContributor
      Return this reactive contributor as a standard blocking HealthContributor.
      Specified by:
      asHealthContributor in interface ReactiveHealthContributor
      Returns:
      a blocking health contributor

    • health

      default reactor.core.publisher.Mono<Health> health(boolean includeDetails)
      Provide the indicator of health.
      Parameters:
      includeDetails - if details should be included or removed
      Returns:
      a Mono that provides the Health

    • health

      reactor.core.publisher.Mono<Health> health()
      Provide the indicator of health.
      Returns:
      a Mono that provides the Health