Index (spring-boot-health 4.0.0 API)

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractHealthIndicator - Class in org.springframework.boot.health.contributor: Base HealthIndicator implementations that encapsulates creation of Health instance and error handling.
AbstractHealthIndicator() - Constructor for class org.springframework.boot.health.contributor.AbstractHealthIndicator: Create a new AbstractHealthIndicator instance with a default healthCheckFailedMessage.
AbstractHealthIndicator(String) - Constructor for class org.springframework.boot.health.contributor.AbstractHealthIndicator: Create a new AbstractHealthIndicator instance with a specific message to log when the health check fails.
AbstractHealthIndicator(Function) - Constructor for class org.springframework.boot.health.contributor.AbstractHealthIndicator: Create a new AbstractHealthIndicator instance with a specific message to log when the health check fails.
AbstractReactiveHealthIndicator - Class in org.springframework.boot.health.contributor: Base ReactiveHealthIndicator implementations that encapsulates creation of Health instance and error handling.
AbstractReactiveHealthIndicator() - Constructor for class org.springframework.boot.health.contributor.AbstractReactiveHealthIndicator: Create a new AbstractReactiveHealthIndicator instance with a default healthCheckFailedMessage.
AbstractReactiveHealthIndicator(String) - Constructor for class org.springframework.boot.health.contributor.AbstractReactiveHealthIndicator: Create a new AbstractReactiveHealthIndicator instance with a specific message to log when the health check fails.
AbstractReactiveHealthIndicator(Function) - Constructor for class org.springframework.boot.health.contributor.AbstractReactiveHealthIndicator: Create a new AbstractReactiveHealthIndicator instance with a specific message to log when the health check fails.
adapt(HealthContributor) - Static method in interface org.springframework.boot.health.contributor.ReactiveHealthContributor: Adapts the given HealthContributor into a ReactiveHealthContributor by scheduling blocking calls to Schedulers.boundedElastic().
adapt(HealthContributors) - Static method in interface org.springframework.boot.health.contributor.ReactiveHealthContributors: Adapts the given HealthContributors into a ReactiveHealthContributors by scheduling blocking calls to Schedulers.boundedElastic().
add(S, Status) - Method in interface org.springframework.boot.health.application.AvailabilityStateHealthIndicator.StatusMappings: Add a new status mapping .
addDefaultStatus(Status) - Method in interface org.springframework.boot.health.application.AvailabilityStateHealthIndicator.StatusMappings: Add the status that should be used if no explicit mapping is defined.
AdditionalHealthEndpointPath - Class in org.springframework.boot.health.actuate.endpoint: Value object that represents an additional path for a HealthEndpointGroup.
aggregateDescriptors(ApiVersion, Map, StatusAggregator, boolean, Set) - Method in class org.springframework.boot.health.actuate.endpoint.HealthEndpoint
aggregateDescriptors(ApiVersion, Map, StatusAggregator, boolean, Set) - Method in class org.springframework.boot.health.actuate.endpoint.HealthEndpointWebExtension
aggregateDescriptors(ApiVersion, Map, StatusAggregator, boolean, Set) - Method in class org.springframework.boot.health.actuate.endpoint.ReactiveHealthEndpointWebExtension
asHealthContributor() - Method in interface org.springframework.boot.health.contributor.CompositeReactiveHealthContributor
asHealthContributor() - Method in interface org.springframework.boot.health.contributor.ReactiveHealthContributor: Return this reactive contributor as a standard blocking HealthContributor.
asHealthContributor() - Method in interface org.springframework.boot.health.contributor.ReactiveHealthIndicator
asHealthContributors() - Method in interface org.springframework.boot.health.contributor.ReactiveHealthContributors: Return these reactive contributors as standard blocking HealthContributors.
AvailabilityHealthContributorAutoConfiguration - Class in org.springframework.boot.health.autoconfigure.application: Auto-configuration for AvailabilityStateHealthIndicator.
AvailabilityHealthContributorAutoConfiguration() - Constructor for class org.springframework.boot.health.autoconfigure.application.AvailabilityHealthContributorAutoConfiguration
AvailabilityProbesAutoConfiguration - Class in org.springframework.boot.health.autoconfigure.actuate.endpoint: Auto-configuration for availability probes.
AvailabilityProbesAutoConfiguration() - Constructor for class org.springframework.boot.health.autoconfigure.actuate.endpoint.AvailabilityProbesAutoConfiguration
AvailabilityStateHealthIndicator - Class in org.springframework.boot.health.application: A HealthIndicator that checks a specific AvailabilityState of the application.
AvailabilityStateHealthIndicator(ApplicationAvailability, Class, Consumer) - Constructor for class org.springframework.boot.health.application.AvailabilityStateHealthIndicator: Create a new AvailabilityStateHealthIndicator instance.
AvailabilityStateHealthIndicator.StatusMappings<S> - Interface in org.springframework.boot.health.application: Callback used to add status mappings.

B

build() - Method in class org.springframework.boot.health.contributor.Health.Builder: Create a new Health instance with the previously specified code and details.
Builder() - Constructor for class org.springframework.boot.health.contributor.Health.Builder: Create new Builder instance.
Builder(Status) - Constructor for class org.springframework.boot.health.contributor.Health.Builder: Create new Builder instance, setting status to given status.
Builder(Status, Map) - Constructor for class org.springframework.boot.health.contributor.Health.Builder: Create new Builder instance, setting status to given status and details to given details.

C

CompositeHealthContributor - Interface in org.springframework.boot.health.contributor: A HealthContributor that is composed of other HealthContributor instances.
CompositeHealthContributorConfiguration<I,B> - Class in org.springframework.boot.health.autoconfigure.contributor: Base class for health contributor configurations that can combine source beans into a composite.
CompositeHealthContributorConfiguration(Function) - Constructor for class org.springframework.boot.health.autoconfigure.contributor.CompositeHealthContributorConfiguration: Creates a CompositeHealthContributorConfiguration that will use the given indicatorFactory to create HealthIndicator instances.
CompositeHealthDescriptor - Class in org.springframework.boot.health.actuate.endpoint: Description of health that is composed of other health descriptors.
CompositeReactiveHealthContributor - Interface in org.springframework.boot.health.contributor: A ReactiveHealthContributor that is composed of other ReactiveHealthContributor instances.
CompositeReactiveHealthContributorConfiguration<I,B> - Class in org.springframework.boot.health.autoconfigure.contributor: Base class for health contributor configurations that can combine source beans into a composite.
CompositeReactiveHealthContributorConfiguration(Function) - Constructor for class org.springframework.boot.health.autoconfigure.contributor.CompositeReactiveHealthContributorConfiguration: Creates a CompositeReactiveHealthContributorConfiguration that will use the given indicatorFactory to create ReactiveHealthIndicator instances.
ConditionalOnEnabledHealthIndicator - Annotation Interface in org.springframework.boot.health.autoconfigure.contributor: @Conditional that checks whether a default health indicator is enabled.
contributor() - Method in record class org.springframework.boot.health.contributor.HealthContributors.Entry: Returns the value of the contributor record component.
contributor() - Method in record class org.springframework.boot.health.contributor.ReactiveHealthContributors.Entry: Returns the value of the contributor record component.
createComposite(Map) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeHealthContributorConfiguration
createComposite(Map) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeReactiveHealthContributorConfiguration
createContributor(Map) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeHealthContributorConfiguration
createContributor(Map) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeReactiveHealthContributorConfiguration
createContributor(ConfigurableListableBeanFactory, Class) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeHealthContributorConfiguration: Creates a composite contributor from the beans of the given beanType retrieved from the given beanFactory.
createContributor(ConfigurableListableBeanFactory, Class) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeReactiveHealthContributorConfiguration: Creates a composite contributor from the beans of the given beanType retrieved from the given beanFactory.
createIndicator(B) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeHealthContributorConfiguration
createIndicator(B) - Method in class org.springframework.boot.health.autoconfigure.contributor.CompositeReactiveHealthContributorConfiguration

D

DEFAULT - Static variable in interface org.springframework.boot.health.actuate.endpoint.HttpCodeStatusMapper: An HttpCodeStatusMapper instance using default mappings.
DefaultHealthContributorRegistry - Class in org.springframework.boot.health.registry: Default HealthContributorRegistry implementation.
DefaultHealthContributorRegistry() - Constructor for class org.springframework.boot.health.registry.DefaultHealthContributorRegistry: Create a new empty DefaultHealthContributorRegistry instance.
DefaultHealthContributorRegistry(Collection, Consumer) - Constructor for class org.springframework.boot.health.registry.DefaultHealthContributorRegistry: Create a new DefaultHealthContributorRegistry instance.
DefaultReactiveHealthContributorRegistry - Class in org.springframework.boot.health.registry: Default ReactiveHealthContributorRegistry implementation.
DefaultReactiveHealthContributorRegistry() - Constructor for class org.springframework.boot.health.registry.DefaultReactiveHealthContributorRegistry: Create a new empty DefaultReactiveHealthContributorRegistry instance.
DefaultReactiveHealthContributorRegistry(Collection, Consumer) - Constructor for class org.springframework.boot.health.registry.DefaultReactiveHealthContributorRegistry: Create a new DefaultReactiveHealthContributorRegistry instance.
DiskSpaceHealthContributorAutoConfiguration - Class in org.springframework.boot.health.autoconfigure.application: Auto-configuration for DiskSpaceHealthIndicator.
DiskSpaceHealthContributorAutoConfiguration() - Constructor for class org.springframework.boot.health.autoconfigure.application.DiskSpaceHealthContributorAutoConfiguration
DiskSpaceHealthIndicator - Class in org.springframework.boot.health.application: A HealthIndicator that checks available disk space and reports a status of Status.DOWN when it drops below a configurable threshold.
DiskSpaceHealthIndicator(File, DataSize) - Constructor for class org.springframework.boot.health.application.DiskSpaceHealthIndicator: Create a new DiskSpaceHealthIndicator instance.
DiskSpaceHealthIndicatorProperties - Class in org.springframework.boot.health.autoconfigure.application: External configuration properties for DiskSpaceHealthIndicator.
DiskSpaceHealthIndicatorProperties() - Constructor for class org.springframework.boot.health.autoconfigure.application.DiskSpaceHealthIndicatorProperties
doHealthCheck(Health.Builder) - Method in class org.springframework.boot.health.application.AvailabilityStateHealthIndicator
doHealthCheck(Health.Builder) - Method in class org.springframework.boot.health.application.DiskSpaceHealthIndicator
doHealthCheck(Health.Builder) - Method in class org.springframework.boot.health.application.SslHealthIndicator
doHealthCheck(Health.Builder) - Method in class org.springframework.boot.health.contributor.AbstractHealthIndicator: Actual health check logic.
doHealthCheck(Health.Builder) - Method in class org.springframework.boot.health.contributor.AbstractReactiveHealthIndicator: Actual health check logic.
doHealthCheck(Health.Builder) - Method in class org.springframework.boot.health.contributor.PingHealthIndicator
down() - Method in class org.springframework.boot.health.contributor.Health.Builder: Set status to Status.DOWN.
down() - Static method in class org.springframework.boot.health.contributor.Health: Create a new Health.Builder instance with a Status.DOWN status.
down(Throwable) - Method in class org.springframework.boot.health.contributor.Health.Builder: Set status to Status.DOWN and add details for given Throwable.
down(Throwable) - Static method in class org.springframework.boot.health.contributor.Health: Create a new Health.Builder instance with an Status.DOWN status and the specified exception details.
DOWN - Static variable in class org.springframework.boot.health.contributor.Status: Status indicating that the component or subsystem has suffered an unexpected failure.

E

Entry(String, HealthContributor) - Constructor for record class org.springframework.boot.health.contributor.HealthContributors.Entry: Creates an instance of a Entry record class.
Entry(String, ReactiveHealthContributor) - Constructor for record class org.springframework.boot.health.contributor.ReactiveHealthContributors.Entry: Creates an instance of a Entry record class.
equals(Object) - Method in class org.springframework.boot.health.actuate.endpoint.AdditionalHealthEndpointPath
equals(Object) - Method in class org.springframework.boot.health.contributor.Health
equals(Object) - Method in record class org.springframework.boot.health.contributor.HealthContributors.Entry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.boot.health.contributor.ReactiveHealthContributors.Entry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.springframework.boot.health.contributor.Status

F

from(String) - Static method in class org.springframework.boot.health.actuate.endpoint.AdditionalHealthEndpointPath: Creates an AdditionalHealthEndpointPath from the given input.
fromMap(Map) - Static method in interface org.springframework.boot.health.contributor.CompositeHealthContributor: Factory method that will create a CompositeHealthContributor from the specified map.
fromMap(Map) - Static method in interface org.springframework.boot.health.contributor.CompositeReactiveHealthContributor: Factory method that will create a CompositeReactiveHealthContributor from the specified map.
fromMap(Map, Function) - Static method in interface org.springframework.boot.health.contributor.CompositeHealthContributor: Factory method that will create a CompositeHealthContributor from the specified map.
fromMap(Map, Function) - Static method in interface org.springframework.boot.health.contributor.CompositeReactiveHealthContributor: Factory method that will create a CompositeReactiveHealthContributor from the specified map.

G

generateContributorName(String) - Method in interface org.springframework.boot.health.autoconfigure.registry.HealthContributorNameGenerator: Generate the health contributor name for the given bean name.
get(String) - Method in interface org.springframework.boot.health.actuate.endpoint.HealthEndpointGroups: Return the group with the specified name or null if the name is not known.
get(AdditionalHealthEndpointPath) - Method in interface org.springframework.boot.health.actuate.endpoint.HealthEndpointGroups: Return the group with the specified additional path or null if no group with that path is found.
getAdditionalPath() - Method in interface org.springframework.boot.health.actuate.endpoint.HealthEndpointGroup: Return an additional path that can be used to map the health group to an alternative location.
getAdditionalPath() - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties.Group
getAggregateStatus(Set) - Method in class org.springframework.boot.health.actuate.endpoint.SimpleStatusAggregator
getAggregateStatus(Set) - Method in interface org.springframework.boot.health.actuate.endpoint.StatusAggregator: Return the aggregate status for the given set of statuses.
getAggregateStatus(Status...) - Method in interface org.springframework.boot.health.actuate.endpoint.StatusAggregator: Return the aggregate status for the given set of statuses.
getAllWithAdditionalPath(WebServerNamespace) - Method in interface org.springframework.boot.health.actuate.endpoint.HealthEndpointGroups: Return all the groups with an additional path on the specified WebServerNamespace.
getCertificateValidityWarningThreshold() - Method in class org.springframework.boot.health.autoconfigure.application.SslHealthIndicatorProperties
getCode() - Method in class org.springframework.boot.health.contributor.Status: Return the code for this status.
getComponents() - Method in class org.springframework.boot.health.actuate.endpoint.CompositeHealthDescriptor
getContributor(String) - Method in interface org.springframework.boot.health.contributor.HealthContributors: Return the contributor with the given name.
getContributor(String) - Method in interface org.springframework.boot.health.contributor.ReactiveHealthContributors: Return the contributor with the given name.
getContributor(String) - Method in class org.springframework.boot.health.registry.DefaultHealthContributorRegistry
getContributor(String) - Method in class org.springframework.boot.health.registry.DefaultReactiveHealthContributorRegistry
getDefault() - Static method in interface org.springframework.boot.health.actuate.endpoint.StatusAggregator: Return StatusAggregator instance using default ordering rules.
getDescription() - Method in class org.springframework.boot.health.contributor.Status: Return the description of this status.
getDetails() - Method in class org.springframework.boot.health.actuate.endpoint.CompositeHealthDescriptor
getDetails() - Method in class org.springframework.boot.health.actuate.endpoint.IndicatedHealthDescriptor
getDetails() - Method in class org.springframework.boot.health.contributor.Health: Return the details of the health.
getExclude() - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties.Group
getGroup() - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties
getGroups() - Method in class org.springframework.boot.health.actuate.endpoint.SystemHealthDescriptor
getHttpCodeStatusMapper() - Method in interface org.springframework.boot.health.actuate.endpoint.HealthEndpointGroup: Returns the HttpCodeStatusMapper that should be used for this group.
getHttpMapping() - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthProperties.Status
getInclude() - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties.Group
getLogging() - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties
getNames() - Method in interface org.springframework.boot.health.actuate.endpoint.HealthEndpointGroups: Return the names of any additional groups.
getNamespace() - Method in class org.springframework.boot.health.actuate.endpoint.AdditionalHealthEndpointPath: Returns the WebServerNamespace associated with this path.
getOrder() - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthProperties.Status
getPath() - Method in class org.springframework.boot.health.autoconfigure.application.DiskSpaceHealthIndicatorProperties
getPrimary() - Method in interface org.springframework.boot.health.actuate.endpoint.HealthEndpointGroups: Return the primary group used by the endpoint.
getRoles() - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthProperties
getShowComponents() - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthProperties
getShowDetails() - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties
getShowDetails() - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties.Group
getShowDetails() - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthProperties
getSlowIndicatorThreshold() - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties.Logging
getState(ApplicationAvailability) - Method in class org.springframework.boot.health.application.AvailabilityStateHealthIndicator: Return the current availability state.
getState(ApplicationAvailability) - Method in class org.springframework.boot.health.application.LivenessStateHealthIndicator
getState(ApplicationAvailability) - Method in class org.springframework.boot.health.application.ReadinessStateHealthIndicator
getStatus() - Method in class org.springframework.boot.health.actuate.endpoint.CompositeHealthDescriptor
getStatus() - Method in class org.springframework.boot.health.actuate.endpoint.HealthDescriptor: Return the status of the component.
getStatus() - Method in class org.springframework.boot.health.actuate.endpoint.IndicatedHealthDescriptor
getStatus() - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthProperties
getStatus() - Method in class org.springframework.boot.health.contributor.Health: Return the status of the health.
getStatusAggregator() - Method in interface org.springframework.boot.health.actuate.endpoint.HealthEndpointGroup: Returns the status aggregator that should be used for this group.
getStatusCode(Status) - Method in interface org.springframework.boot.health.actuate.endpoint.HttpCodeStatusMapper: Return the HTTP status code that corresponds to the given health status.
getStatusCode(Status) - Method in class org.springframework.boot.health.actuate.endpoint.SimpleHttpCodeStatusMapper
getThreshold() - Method in class org.springframework.boot.health.autoconfigure.application.DiskSpaceHealthIndicatorProperties
getValue() - Method in class org.springframework.boot.health.actuate.endpoint.AdditionalHealthEndpointPath: Returns the value corresponding to this path.
Group() - Constructor for class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties.Group

H

hashCode() - Method in class org.springframework.boot.health.actuate.endpoint.AdditionalHealthEndpointPath
hashCode() - Method in class org.springframework.boot.health.contributor.Health
hashCode() - Method in record class org.springframework.boot.health.contributor.HealthContributors.Entry: Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.boot.health.contributor.ReactiveHealthContributors.Entry: Returns a hash code value for this object.
hashCode() - Method in class org.springframework.boot.health.contributor.Status
hasNamespace(WebServerNamespace) - Method in class org.springframework.boot.health.actuate.endpoint.AdditionalHealthEndpointPath: Returns true if this path has the given WebServerNamespace.
health() - Method in class org.springframework.boot.health.actuate.endpoint.HealthEndpoint
health() - Method in class org.springframework.boot.health.contributor.AbstractHealthIndicator
health() - Method in class org.springframework.boot.health.contributor.AbstractReactiveHealthIndicator
health() - Method in interface org.springframework.boot.health.contributor.HealthIndicator: Return an indication of health.
health() - Method in interface org.springframework.boot.health.contributor.ReactiveHealthIndicator: Provide the indicator of health.
health(boolean) - Method in interface org.springframework.boot.health.contributor.HealthIndicator: Return an indication of health.
health(boolean) - Method in interface org.springframework.boot.health.contributor.ReactiveHealthIndicator: Provide the indicator of health.
health(ApiVersion, WebServerNamespace, SecurityContext) - Method in class org.springframework.boot.health.actuate.endpoint.ReactiveHealthEndpointWebExtension
health(ApiVersion, WebServerNamespace, SecurityContext, boolean, String...) - Method in class org.springframework.boot.health.actuate.endpoint.HealthEndpointWebExtension
health(ApiVersion, WebServerNamespace, SecurityContext, boolean, String...) - Method in class org.springframework.boot.health.actuate.endpoint.ReactiveHealthEndpointWebExtension
health(ApiVersion, WebServerNamespace, SecurityContext, String...) - Method in class org.springframework.boot.health.actuate.endpoint.ReactiveHealthEndpointWebExtension
health(ApiVersion, WebServerNamespace, SecurityContext) - Method in class org.springframework.boot.health.actuate.endpoint.HealthEndpointWebExtension
health(ApiVersion, WebServerNamespace, SecurityContext, String...) - Method in class org.springframework.boot.health.actuate.endpoint.HealthEndpointWebExtension
Health - Class in org.springframework.boot.health.contributor: The health of a component or subsystem in including its Status as well as any additional contextual details.
Health.Builder - Class in org.springframework.boot.health.contributor: Builder for creating immutable Health instances.
HealthContributor - Interface in org.springframework.boot.health.contributor: Contributes health information, either directly (HealthIndicator) or via other contributors (CompositeHealthContributor).
HealthContributorAutoConfiguration - Class in org.springframework.boot.health.autoconfigure.contributor: Auto-configuration for default health contributors.
HealthContributorAutoConfiguration() - Constructor for class org.springframework.boot.health.autoconfigure.contributor.HealthContributorAutoConfiguration
HealthContributorNameGenerator - Interface in org.springframework.boot.health.autoconfigure.registry: Strategy used to create health contributor names from bean names.
HealthContributorNameValidator - Interface in org.springframework.boot.health.registry: Interface that can be used to validate names before they are added to a health contributor registry.
HealthContributorRegistry - Interface in org.springframework.boot.health.registry: A mutable registry of health contributors.
HealthContributorRegistryAutoConfiguration - Class in org.springframework.boot.health.autoconfigure.registry: Auto-configuration for HealthContributorRegistry and ReactiveHealthContributorRegistry.
HealthContributors - Interface in org.springframework.boot.health.contributor: A collection of named health contributors.
HealthContributors.Entry - Record Class in org.springframework.boot.health.contributor: A health contributor entry.
HealthDescriptor - Class in org.springframework.boot.health.actuate.endpoint: Description of health including a status.
HealthDescriptor() - Constructor for class org.springframework.boot.health.actuate.endpoint.HealthDescriptor
HealthEndpoint - Class in org.springframework.boot.health.actuate.endpoint: @Endpoint to expose application health information.
HealthEndpoint(HealthContributorRegistry, ReactiveHealthContributorRegistry, HealthEndpointGroups, Duration) - Constructor for class org.springframework.boot.health.actuate.endpoint.HealthEndpoint: Create a new HealthEndpoint instance.
HealthEndpointAutoConfiguration - Class in org.springframework.boot.health.autoconfigure.actuate.endpoint: Auto-configuration for HealthEndpoint.
HealthEndpointAutoConfiguration() - Constructor for class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointAutoConfiguration
HealthEndpointGroup - Interface in org.springframework.boot.health.actuate.endpoint: A logical grouping of health contributors that can be exposed by the HealthEndpoint.
HealthEndpointGroups - Interface in org.springframework.boot.health.actuate.endpoint: A collection of groups for use with a health endpoint.
HealthEndpointGroupsPostProcessor - Interface in org.springframework.boot.health.actuate.endpoint: Hook that allows for custom modification of HealthEndpointGroups — for example, automatically adding additional auto-configured groups.
HealthEndpointProperties - Class in org.springframework.boot.health.autoconfigure.actuate.endpoint: Configuration properties for HealthEndpoint.
HealthEndpointProperties() - Constructor for class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties
HealthEndpointProperties.Group - Class in org.springframework.boot.health.autoconfigure.actuate.endpoint: A health endpoint group.
HealthEndpointProperties.Logging - Class in org.springframework.boot.health.autoconfigure.actuate.endpoint: Health logging properties.
HealthEndpointWebExtension - Class in org.springframework.boot.health.actuate.endpoint: @EndpointWebExtension for the HealthEndpoint.
HealthEndpointWebExtension(HealthContributorRegistry, ReactiveHealthContributorRegistry, HealthEndpointGroups, Duration) - Constructor for class org.springframework.boot.health.actuate.endpoint.HealthEndpointWebExtension: Create a new HealthEndpointWebExtension instance.
healthForPath(String...) - Method in class org.springframework.boot.health.actuate.endpoint.HealthEndpoint
HealthIndicator - Interface in org.springframework.boot.health.contributor: Directly contributes Health information for specific component or subsystem.
HealthProperties - Class in org.springframework.boot.health.autoconfigure.actuate.endpoint: Properties used to configure the health endpoint and endpoint groups.
HealthProperties() - Constructor for class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthProperties
HealthProperties.Status - Class in org.springframework.boot.health.autoconfigure.actuate.endpoint: Status properties for the group.
HttpCodeStatusMapper - Interface in org.springframework.boot.health.actuate.endpoint: Strategy used to map a health status to an HTTP status code.

I

ID - Static variable in class org.springframework.boot.health.actuate.endpoint.HealthEndpoint: Health endpoint id.
IndicatedHealthDescriptor - Class in org.springframework.boot.health.actuate.endpoint: Description of health obtained from a HealthIndicator or ReactiveHealthIndicator.
isMember(String) - Method in interface org.springframework.boot.health.actuate.endpoint.HealthEndpointGroup: Returns true if the given contributor is a member of this group.
iterator() - Method in interface org.springframework.boot.health.contributor.HealthContributors
iterator() - Method in interface org.springframework.boot.health.contributor.ReactiveHealthContributors

L

LivenessStateHealthIndicator - Class in org.springframework.boot.health.application: A HealthIndicator that checks the LivenessState of the application.
LivenessStateHealthIndicator(ApplicationAvailability) - Constructor for class org.springframework.boot.health.application.LivenessStateHealthIndicator
Logging() - Constructor for class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties.Logging

M

MANAGEMENT_PREFIX - Static variable in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties.Group

N

name() - Method in record class org.springframework.boot.health.contributor.HealthContributors.Entry: Returns the value of the name record component.
name() - Method in record class org.springframework.boot.health.contributor.ReactiveHealthContributors.Entry: Returns the value of the name record component.

O

of(WebServerNamespace, String) - Static method in class org.springframework.boot.health.actuate.endpoint.AdditionalHealthEndpointPath: Creates an AdditionalHealthEndpointPath from the given WebServerNamespace and value.
of(HealthEndpointGroup, Map) - Static method in interface org.springframework.boot.health.actuate.endpoint.HealthEndpointGroups: Factory method to create a HealthEndpointGroups instance.
of(HealthContributors...) - Static method in interface org.springframework.boot.health.contributor.HealthContributors: Factory method to create a new HealthContributors instance composed of the given contributors.
of(ReactiveHealthContributors...) - Static method in interface org.springframework.boot.health.contributor.ReactiveHealthContributors: Factory method to create a new ReactiveHealthContributors instance composed of the given contributors.
org.springframework.boot.health.actuate.endpoint - package org.springframework.boot.health.actuate.endpoint: Actuator endpoint for health.
org.springframework.boot.health.application - package org.springframework.boot.health.application: Health indicators providing information about an application.
org.springframework.boot.health.autoconfigure.actuate.endpoint - package org.springframework.boot.health.autoconfigure.actuate.endpoint: Auto-configuration for health actuator endpoints.
org.springframework.boot.health.autoconfigure.application - package org.springframework.boot.health.autoconfigure.application
org.springframework.boot.health.autoconfigure.contributor - package org.springframework.boot.health.autoconfigure.contributor: Auto-configuration for health contributors.
org.springframework.boot.health.autoconfigure.registry - package org.springframework.boot.health.autoconfigure.registry: Auto-configuration for health registries.
org.springframework.boot.health.contributor - package org.springframework.boot.health.contributor: Classes related to contributing health information about an application.
org.springframework.boot.health.registry - package org.springframework.boot.health.registry: Health registry support.
OUT_OF_SERVICE - Static variable in class org.springframework.boot.health.contributor.Status: Status indicating that the component or subsystem has been taken out of service and should not be used.
outOfService() - Method in class org.springframework.boot.health.contributor.Health.Builder: Set status to Status.OUT_OF_SERVICE.
outOfService() - Static method in class org.springframework.boot.health.contributor.Health: Create a new Health.Builder instance with an Status.OUT_OF_SERVICE status.

P

PingHealthIndicator - Class in org.springframework.boot.health.contributor: Auto-configured HealthIndicator that always returns Status.UP.
PingHealthIndicator() - Constructor for class org.springframework.boot.health.contributor.PingHealthIndicator
postProcessHealthEndpointGroups(HealthEndpointGroups) - Method in interface org.springframework.boot.health.actuate.endpoint.HealthEndpointGroupsPostProcessor: Post-process the given HealthEndpointGroups instance.

R

ReactiveHealthContributor - Interface in org.springframework.boot.health.contributor: Contributes health information, either directly (ReactiveHealthIndicator) or via other contributors (CompositeReactiveHealthContributor).
ReactiveHealthContributorRegistry - Interface in org.springframework.boot.health.registry: A mutable registry of reactive health contributors.
ReactiveHealthContributors - Interface in org.springframework.boot.health.contributor: A collection of named reactive health contributors.
ReactiveHealthContributors.Entry - Record Class in org.springframework.boot.health.contributor: A reactive health contributor entry.
ReactiveHealthEndpointWebExtension - Class in org.springframework.boot.health.actuate.endpoint: Reactive @EndpointWebExtension for the HealthEndpoint.
ReactiveHealthEndpointWebExtension(ReactiveHealthContributorRegistry, HealthContributorRegistry, HealthEndpointGroups, Duration) - Constructor for class org.springframework.boot.health.actuate.endpoint.ReactiveHealthEndpointWebExtension: Create a new ReactiveHealthEndpointWebExtension instance.
ReactiveHealthIndicator - Interface in org.springframework.boot.health.contributor: Directly contributes Health information for specific reactive component or subsystem.
ReadinessStateHealthIndicator - Class in org.springframework.boot.health.application: A HealthIndicator that checks the ReadinessState of the application.
ReadinessStateHealthIndicator(ApplicationAvailability) - Constructor for class org.springframework.boot.health.application.ReadinessStateHealthIndicator
registerContributor(String, HealthContributor) - Method in class org.springframework.boot.health.registry.DefaultHealthContributorRegistry
registerContributor(String, HealthContributor) - Method in interface org.springframework.boot.health.registry.HealthContributorRegistry: Register a contributor with the given name.
registerContributor(String, ReactiveHealthContributor) - Method in class org.springframework.boot.health.registry.DefaultReactiveHealthContributorRegistry
registerContributor(String, ReactiveHealthContributor) - Method in interface org.springframework.boot.health.registry.ReactiveHealthContributorRegistry: Register a contributor with the given name.
registrar(Map) - Method in interface org.springframework.boot.health.autoconfigure.registry.HealthContributorNameGenerator: Return a registrar that can be used to register the given contributor beans with a generated name.

S

SERVER_PREFIX - Static variable in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties.Group
setAdditionalPath(String) - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties.Group
setCertificateValidityWarningThreshold(Duration) - Method in class org.springframework.boot.health.autoconfigure.application.SslHealthIndicatorProperties
setExclude(Set) - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties.Group
setInclude(Set) - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties.Group
setOrder(List) - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthProperties.Status
setPath(File) - Method in class org.springframework.boot.health.autoconfigure.application.DiskSpaceHealthIndicatorProperties
setRoles(Set) - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthProperties
setShowComponents(Show) - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthProperties
setShowDetails(Show) - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties.Group
setShowDetails(Show) - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties
setSlowIndicatorThreshold(Duration) - Method in class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthEndpointProperties.Logging
setThreshold(DataSize) - Method in class org.springframework.boot.health.autoconfigure.application.DiskSpaceHealthIndicatorProperties
showComponents(SecurityContext) - Method in interface org.springframework.boot.health.actuate.endpoint.HealthEndpointGroup: Returns if health components should be shown in the response.
showDetails(SecurityContext) - Method in interface org.springframework.boot.health.actuate.endpoint.HealthEndpointGroup: Returns if health details should be shown in the response.
SimpleHttpCodeStatusMapper - Class in org.springframework.boot.health.actuate.endpoint: Simple HttpCodeStatusMapper backed by map of status code to HTTP status code.
SimpleHttpCodeStatusMapper() - Constructor for class org.springframework.boot.health.actuate.endpoint.SimpleHttpCodeStatusMapper: Create a new SimpleHttpCodeStatusMapper instance using default mappings.
SimpleHttpCodeStatusMapper(Map) - Constructor for class org.springframework.boot.health.actuate.endpoint.SimpleHttpCodeStatusMapper: Create a new SimpleHttpCodeStatusMapper with the specified mappings.
SimpleStatusAggregator - Class in org.springframework.boot.health.actuate.endpoint: StatusAggregator backed by an ordered status list.
SimpleStatusAggregator() - Constructor for class org.springframework.boot.health.actuate.endpoint.SimpleStatusAggregator
SimpleStatusAggregator(String...) - Constructor for class org.springframework.boot.health.actuate.endpoint.SimpleStatusAggregator
SimpleStatusAggregator(List) - Constructor for class org.springframework.boot.health.actuate.endpoint.SimpleStatusAggregator
SimpleStatusAggregator(Status...) - Constructor for class org.springframework.boot.health.actuate.endpoint.SimpleStatusAggregator
SslHealthContributorAutoConfiguration - Class in org.springframework.boot.health.autoconfigure.application: Auto-configuration for SslHealthIndicator.
SslHealthContributorAutoConfiguration() - Constructor for class org.springframework.boot.health.autoconfigure.application.SslHealthContributorAutoConfiguration
SslHealthIndicator - Class in org.springframework.boot.health.application: HealthIndicator that checks the certificates the application uses and reports Status.OUT_OF_SERVICE when a certificate is invalid.
SslHealthIndicator(SslInfo, Duration) - Constructor for class org.springframework.boot.health.application.SslHealthIndicator
SslHealthIndicatorProperties - Class in org.springframework.boot.health.autoconfigure.application: External configuration properties for SslHealthIndicator.
SslHealthIndicatorProperties() - Constructor for class org.springframework.boot.health.autoconfigure.application.SslHealthIndicatorProperties
status(String) - Method in class org.springframework.boot.health.contributor.Health.Builder: Set status to given statusCode.
status(String) - Static method in class org.springframework.boot.health.contributor.Health: Create a new Health.Builder instance with a specific status code.
status(Status) - Method in class org.springframework.boot.health.contributor.Health.Builder: Set status to given Status instance.
status(Status) - Static method in class org.springframework.boot.health.contributor.Health: Create a new Health.Builder instance with a specific Status.
Status - Class in org.springframework.boot.health.contributor: Value object to express state of a component or subsystem.
Status() - Constructor for class org.springframework.boot.health.autoconfigure.actuate.endpoint.HealthProperties.Status
Status(String) - Constructor for class org.springframework.boot.health.contributor.Status: Create a new Status instance with the given code and an empty description.
Status(String, String) - Constructor for class org.springframework.boot.health.contributor.Status: Create a new Status instance with the given code and description.
StatusAggregator - Interface in org.springframework.boot.health.actuate.endpoint: Strategy used to aggregate Status instances.
stream() - Method in interface org.springframework.boot.health.contributor.HealthContributors: Return a stream of the contributor entries.
stream() - Method in interface org.springframework.boot.health.contributor.ReactiveHealthContributors: Return a stream of the contributor entries.
stream() - Method in class org.springframework.boot.health.registry.DefaultHealthContributorRegistry
stream() - Method in class org.springframework.boot.health.registry.DefaultReactiveHealthContributorRegistry
SystemHealthDescriptor - Class in org.springframework.boot.health.actuate.endpoint: Description of overall system health.

T

toString() - Method in class org.springframework.boot.health.actuate.endpoint.AdditionalHealthEndpointPath
toString() - Method in class org.springframework.boot.health.contributor.Health
toString() - Method in record class org.springframework.boot.health.contributor.HealthContributors.Entry: Returns a string representation of this record class.
toString() - Method in record class org.springframework.boot.health.contributor.ReactiveHealthContributors.Entry: Returns a string representation of this record class.
toString() - Method in class org.springframework.boot.health.contributor.Status

U

unchanged() - Static method in interface org.springframework.boot.health.autoconfigure.registry.HealthContributorNameGenerator: Return a HealthContributorNameGenerator that uses the unchanged bean name as the health contributor name.
unknown() - Method in class org.springframework.boot.health.contributor.Health.Builder: Set status to Status.UNKNOWN status.
unknown() - Static method in class org.springframework.boot.health.contributor.Health: Create a new Health.Builder instance with an Status.UNKNOWN status.
UNKNOWN - Static variable in class org.springframework.boot.health.contributor.Status: Status indicating that the component or subsystem is in an unknown state.
unregisterContributor(String) - Method in class org.springframework.boot.health.registry.DefaultHealthContributorRegistry
unregisterContributor(String) - Method in class org.springframework.boot.health.registry.DefaultReactiveHealthContributorRegistry
unregisterContributor(String) - Method in interface org.springframework.boot.health.registry.HealthContributorRegistry: Unregister a previously registered contributor.
unregisterContributor(String) - Method in interface org.springframework.boot.health.registry.ReactiveHealthContributorRegistry: Unregister a previously registered contributor.
up() - Method in class org.springframework.boot.health.contributor.Health.Builder: Set status to Status.UP status.
up() - Static method in class org.springframework.boot.health.contributor.Health: Create a new Health.Builder instance with an Status.UP status.
UP - Static variable in class org.springframework.boot.health.contributor.Status: Status indicating that the component or subsystem is functioning as expected.

V

validate(String) - Method in interface org.springframework.boot.health.registry.HealthContributorNameValidator: Validate the contributor name.
value() - Element in annotation interface org.springframework.boot.health.autoconfigure.contributor.ConditionalOnEnabledHealthIndicator: The name of the health indicator.

W

withDetail(String, Object) - Method in class org.springframework.boot.health.contributor.Health.Builder: Record detail using given key and value.
withDetails(Map) - Method in class org.springframework.boot.health.contributor.Health.Builder: Record details from the given details map.
withException(Throwable) - Method in class org.springframework.boot.health.contributor.Health.Builder: Record detail for given Exception.
withoutStandardSuffixes() - Static method in interface org.springframework.boot.health.autoconfigure.registry.HealthContributorNameGenerator: Return a HealthContributorNameGenerator that removes standard suffixes.
withoutSuffixes(String...) - Static method in interface org.springframework.boot.health.autoconfigure.registry.HealthContributorNameGenerator: Return a HealthContributorNameGenerator that removes the given suffixes.

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values