/*
* Copyright 2012-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.actuate.health;
Strategy interface used to contribute Health
to the results returned from the HealthEndpoint
. Author: Dave Syer, Phillip Webb Since: 1.0.0
/**
* Strategy interface used to contribute {@link Health} to the results returned from the
* {@link HealthEndpoint}.
*
* @author Dave Syer
* @author Phillip Webb
* @since 1.0.0
*/
@FunctionalInterface
public interface HealthIndicator extends HealthContributor {
Return an indication of health.
Params: - includeDetails – if details should be included or removed
Returns: the health Since: 2.2.0
/**
* Return an indication of health.
* @param includeDetails if details should be included or removed
* @return the health
* @since 2.2.0
*/
default Health getHealth(boolean includeDetails) {
Health health = health();
return includeDetails ? health : health.withoutDetails();
}
Return an indication of health.
Returns: the health
/**
* Return an indication of health.
* @return the health
*/
Health health();
}