org.springframework.boot.actuate.endpoint.annotation

Annotation Type Endpoint

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface Endpoint

Identifies a type as being an endpoint.

Since:

2.0.0

Author:

Andy Wilkinson

See Also:

AnnotationEndpointDiscoverer

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	id The id of the endpoint.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
DefaultEnablement	defaultEnablement Defines the DefaultEnablement of the endpoint.
EndpointExposure[]	exposure Defines the technologies over which the endpoint should be exposed.

Element Detail

id

public abstract String id

The id of the endpoint.

Returns:

the id

exposure

public abstract EndpointExposure[] exposure

Defines the technologies over which the endpoint should be exposed. By default, all technologies are supported.

Returns:

the supported endpoint exposure technologies

Default:

{}

defaultEnablement

public abstract DefaultEnablement defaultEnablement

Defines the DefaultEnablement of the endpoint. By default, the endpoint's enablement defaults to the "default" settings.

Returns:

the default enablement

Default:

org.springframework.boot.actuate.endpoint.DefaultEnablement.NEUTRAL