Package org.springframework.boot.actuate.health

Interface HealthIndicator

All Superinterfaces:
HealthContributor
All Known Implementing Classes:
AbstractHealthIndicator, AvailabilityStateHealthIndicator, CassandraDriverHealthIndicator, CouchbaseHealthIndicator, DataSourceHealthIndicator, DiskSpaceHealthIndicator, ElasticsearchRestClientHealthIndicator, HazelcastHealthIndicator, JmsHealthIndicator, LdapHealthIndicator, LivenessStateHealthIndicator, MailHealthIndicator, MongoHealthIndicator, Neo4jHealthIndicator, PingHealthIndicator, RabbitHealthIndicator, ReadinessStateHealthIndicator, RedisHealthIndicator, 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 interface HealthIndicator extends HealthContributor
Strategy interface used to contribute Health to the results returned from the HealthEndpoint.
Since:
1.0.0
Author:
Dave Syer, Phillip Webb

  • Method Summary

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

  • Method Details

    • getHealth

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

    • health

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