org.springframework.boot.actuate.health

接口 HealthEndpointGroups

public interface HealthEndpointGroups

A collection of groups for use with a health endpoint.

从以下版本开始:

2.2.0

方法概要

限定符和类型	方法和说明
default HealthEndpointGroup	get(AdditionalHealthEndpointPath path) Return the group with the specified additional path or null if no group with that path is found.
HealthEndpointGroup	get(java.lang.String name) Return the group with the specified name or null if the name is not known.
default java.util.Set<HealthEndpointGroup>	getAllWithAdditionalPath(WebServerNamespace namespace) Return all the groups with an additional path on the specified WebServerNamespace.
java.util.Set<java.lang.String>	getNames() Return the names of any additional groups.
HealthEndpointGroup	getPrimary() Return the primary group used by the endpoint.
static HealthEndpointGroups	of(HealthEndpointGroup primary, java.util.Map<java.lang.String,HealthEndpointGroup> additional) Factory method to create a HealthEndpointGroups instance.

方法详细资料

getPrimary

HealthEndpointGroup getPrimary()

Return the primary group used by the endpoint.

返回:

the primary group (never null)

getNames

java.util.Set<java.lang.String> getNames()

Return the names of any additional groups.

返回:

the additional group names

get

HealthEndpointGroup get(java.lang.String name)

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

参数:

name - the name of the group

返回:

the HealthEndpointGroup or null

get

default HealthEndpointGroup get(AdditionalHealthEndpointPath path)

Return the group with the specified additional path or null if no group with that path is found.

参数:

path - the additional path

返回:

the matching HealthEndpointGroup or null

从以下版本开始:

2.6.0

getAllWithAdditionalPath

default java.util.Set<HealthEndpointGroup> getAllWithAdditionalPath(WebServerNamespace namespace)

Return all the groups with an additional path on the specified WebServerNamespace.

参数:

namespace - the WebServerNamespace

返回:

the matching groups

从以下版本开始:

2.6.0

of

static HealthEndpointGroups of(HealthEndpointGroup primary,
                               java.util.Map<java.lang.String,HealthEndpointGroup> additional)

Factory method to create a HealthEndpointGroups instance.

参数:

primary - the primary group

additional - the additional groups

返回:

a new HealthEndpointGroups instance