org.springframework.boot.actuate.health

Interface HealthEndpointGroups

public interface HealthEndpointGroups

A collection of groups for use with a health endpoint.

Since:

2.2.0

Author:

Phillip Webb

Method Summary

Modifier and Type	Method and Description
HealthEndpointGroup	get(String name) Return the group with the specified name or null if the name is not known.
Set<String>	getNames() Return the names of any additional groups.
HealthEndpointGroup	getPrimary() Return the primary group used by the endpoint.
static HealthEndpointGroups	of(HealthEndpointGroup primary, Map<String,HealthEndpointGroup> additional) Factory method to create a HealthEndpointGroups instance.

Method Detail

getPrimary

HealthEndpointGroup getPrimary()

Return the primary group used by the endpoint.

Returns:

the primary group (never null)

getNames

Set<String> getNames()

Return the names of any additional groups.

Returns:

the additional group names

get

HealthEndpointGroup get(String name)

Return the group with the specified name or null if the name is not known.

Parameters:

name - the name of the group

Returns:

the HealthEndpointGroup or null

of

static HealthEndpointGroups of(HealthEndpointGroup primary,
                               Map<String,HealthEndpointGroup> additional)

Factory method to create a HealthEndpointGroups instance.

Parameters:

primary - the primary group

additional - the additional groups

Returns:

a new HealthEndpointGroups instance