Interface HealthIndicator

All Superinterfaces:
HealthContributor
All Known Implementing Classes:
AbstractHealthIndicator, AvailabilityStateHealthIndicator, CassandraDriverHealthIndicator, CouchbaseHealthIndicator, DataRedisHealthIndicator, DataSourceHealthIndicator, DiskSpaceHealthIndicator, ElasticsearchRestClientHealthIndicator, HazelcastHealthIndicator, JmsHealthIndicator, LdapHealthIndicator, LivenessStateHealthIndicator, MailHealthIndicator, MongoHealthIndicator, Neo4jHealthIndicator, PingHealthIndicator, RabbitHealthIndicator, ReadinessStateHealthIndicator, SslHealthIndicator
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 HealthIndicator extends HealthContributor
Directly contributes Health information for specific component or subsystem.
Since:
4.0.0
Author:
Dave Syer, Phillip Webb

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable Health
    health()
    Return an indication of health.
    default @Nullable Health
    health(boolean includeDetails)
    Return an indication of health.

  • Method Details

    • health

      default @Nullable Health health(boolean includeDetails)
      Return an indication of health.
      Parameters:
      includeDetails - if details should be included or removed
      Returns:
      the health

    • health

      @Nullable Health health()
      Return an indication of health.
      Returns:
      the health