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

Enum EndpointExposure

java.lang.Object

java.lang.Enum<EndpointExposure>

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

All Implemented Interfaces:

Serializable, Comparable<EndpointExposure>

public enum EndpointExposure
extends Enum<EndpointExposure>

Technologies that can be used to expose an endpoint.

Since:

2.6.0

Author:

Phillip Webb

Enum Constant Summary

Enum Constants

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

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JMX

public static final EndpointExposure JMX

Exposed over a JMX endpoint.

WEB

public static final EndpointExposure WEB

Exposed over a web endpoint.

CLOUD_FOUNDRY

public static final EndpointExposure CLOUD_FOUNDRY

Exposed on Cloud Foundry over `/cloudfoundryapplication`.

Since:

2.6.4

Method Detail

values

public static EndpointExposure[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EndpointExposure c : EndpointExposure.values())
    System.out.println(c);

Returns:

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

valueOf

public static EndpointExposure valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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