Package org.springframework.boot.actuate.health

Interface ReactiveHealthIndicator

All Superinterfaces:
ReactiveHealthContributor
All Known Implementing Classes:
AbstractReactiveHealthIndicator, CassandraDriverReactiveHealthIndicator, ConnectionFactoryHealthIndicator, CouchbaseReactiveHealthIndicator, ElasticsearchReactiveHealthIndicator, MongoReactiveHealthIndicator, Neo4jReactiveHealthIndicator, RedisReactiveHealthIndicator
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 interface ReactiveHealthIndicator extends ReactiveHealthContributor
Strategy interface used to contribute Health to the results returned from the reactive variant of the HealthEndpoint.

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

Since:
2.0.0
Author:
Stephane Nicoll
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default reactor.core.publisher.Mono<Health>
    getHealth(boolean includeDetails)
    Provide the indicator of health.
    reactor.core.publisher.Mono<Health>
    health()
    Provide the indicator of health.

  • Method Details

    • getHealth

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

    • health

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