Package org.springframework.boot.actuate.autoconfigure.endpoint.expose

Enum Class EndpointExposure

java.lang.Object

java.lang.Enum<EndpointExposure>

org.springframework.boot.actuate.autoconfigure.endpoint.expose.EndpointExposure

All Implemented Interfaces:

Serializable, Comparable<EndpointExposure>, Constable

public enum EndpointExposure
extends Enum<EndpointExposure>

Technologies that can be used to expose an endpoint.

Since:

2.6.0

Author:

Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOUD_FOUNDRY	Exposed on Cloud Foundry via `/cloudfoundryapplication`.
JMX	Exposed via JMX endpoint.
WEB	Exposed via a web endpoint.

Method Summary

Modifier and Type	Method	Description
String[]	getDefaultIncludes()	Return the default set of include patterns.
static EndpointExposure	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EndpointExposure[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

JMX

public static final EndpointExposure JMX

Exposed via JMX endpoint.

WEB

public static final EndpointExposure WEB

Exposed via a web endpoint.

CLOUD_FOUNDRY

public static final EndpointExposure CLOUD_FOUNDRY

Exposed on Cloud Foundry via `/cloudfoundryapplication`.

Since:

2.6.4

Method Details

values

public static EndpointExposure[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static EndpointExposure valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getDefaultIncludes

public String[] getDefaultIncludes()

Return the default set of include patterns.

Returns:

the default includes