org.springframework.boot.actuate.endpoint

Interface ExposableEndpoint<O extends Operation>

Type Parameters:

O - the type of the endpoint's operations

All Known Subinterfaces:

DiscoveredEndpoint<O>, ExposableControllerEndpoint, ExposableJmxEndpoint, ExposableServletEndpoint, ExposableWebEndpoint

All Known Implementing Classes:

AbstractDiscoveredEndpoint, AbstractExposableEndpoint

public interface ExposableEndpoint<O extends Operation>

Information describing an endpoint that can be exposed in some technology specific way.

Since:

2.0.0

Author:

Andy Wilkinson, Phillip Webb

Method Summary

Modifier and Type	Method and Description
default EndpointId	getEndpointId() Return the endpoint ID.
String	getId() Deprecated. since 2.0.6 in favor of getEndpointId()
Collection<O>	getOperations() Returns the operations of the endpoint.
boolean	isEnableByDefault() Returns if the endpoint is enabled by default.

Method Detail

getId

@Deprecated
String getId()

Deprecated. since 2.0.6 in favor of getEndpointId()

Returns the id of the endpoint.

Returns:

the id

getEndpointId

default EndpointId getEndpointId()

Return the endpoint ID.

Returns:

the endpoint ID

Since:

2.0.6

isEnableByDefault

boolean isEnableByDefault()

Returns if the endpoint is enabled by default.

Returns:

if the endpoint is enabled by default

getOperations

Collection<O> getOperations()

Returns the operations of the endpoint.

Returns:

the operations