org.springframework.boot.actuate.health

Interface HealthEndpointGroupConfigurer

public interface HealthEndpointGroupConfigurer

A configurer for customizing an HealthEndpointGroup being built.

Since:

2.3.0

Author:

Brian Clozel

Method Summary

Modifier and Type	Method and Description
HealthEndpointGroupConfigurer	exclude(String... indicators) Configure the indicator endpoint ids to exclude from this group.
HealthEndpointGroupConfigurer	httpCodeStatusMapper(HttpCodeStatusMapper httpCodeStatusMapper) Configure the HttpCodeStatusMapper to use for this group.
HealthEndpointGroupConfigurer	include(String... indicators) Configure the indicator endpoint ids to include in this group.
HealthEndpointGroupConfigurer	roles(String... roles) Configure roles used to determine whether or not a user is authorized to be shown details.
HealthEndpointGroupConfigurer	showComponents(HealthEndpointGroup.Show showComponents) Configure the visibility option for showing components of this group.
HealthEndpointGroupConfigurer	showDetails(HealthEndpointGroup.Show showDetails) Configure the visibility option for showing details of this group.
HealthEndpointGroupConfigurer	statusAggregator(StatusAggregator statusAggregator) Configure the StatusAggregator to use for this group.

Method Detail

include

HealthEndpointGroupConfigurer include(String... indicators)

Configure the indicator endpoint ids to include in this group.

Parameters:

indicators - the indicator endpoint ids

Returns:

the configurer instance

exclude

HealthEndpointGroupConfigurer exclude(String... indicators)

Configure the indicator endpoint ids to exclude from this group.

Parameters:

indicators - the indicator endpoint ids

Returns:

the configurer instance

statusAggregator

HealthEndpointGroupConfigurer statusAggregator(StatusAggregator statusAggregator)

Configure the StatusAggregator to use for this group.

If none set, this will default to the globally configured StatusAggregator.

Parameters:

statusAggregator - the status aggregator

Returns:

the configurer instance

httpCodeStatusMapper

HealthEndpointGroupConfigurer httpCodeStatusMapper(HttpCodeStatusMapper httpCodeStatusMapper)

Configure the HttpCodeStatusMapper to use for this group.

If none set, this will default to the globally configured HttpCodeStatusMapper.

Parameters:

httpCodeStatusMapper - the status code mapper

Returns:

the configurer instance

showComponents

HealthEndpointGroupConfigurer showComponents(HealthEndpointGroup.Show showComponents)

Configure the visibility option for showing components of this group.

Parameters:

showComponents - the components visibility

Returns:

the configurer instance

showDetails

HealthEndpointGroupConfigurer showDetails(HealthEndpointGroup.Show showDetails)

Configure the visibility option for showing details of this group.

Parameters:

showDetails - the details visibility

Returns:

the configurer instance

roles

HealthEndpointGroupConfigurer roles(String... roles)

Configure roles used to determine whether or not a user is authorized to be shown details.

Parameters:

roles - the roles

Returns:

the configurer instance