Package org.springframework.integration.support.management.observation

Enum Class IntegrationObservation

java.lang.Object

java.lang.Enum<IntegrationObservation>

org.springframework.integration.support.management.observation.IntegrationObservation

All Implemented Interfaces:

io.micrometer.observation.docs.ObservationDocumentation, Serializable, Comparable<IntegrationObservation>, Constable

public enum IntegrationObservation
extends Enum<IntegrationObservation>
implements io.micrometer.observation.docs.ObservationDocumentation

The ObservationDocumentation implementation for Spring Integration infrastructure.

NOTE: This class is mostly intended for observation docs generation, so any string literals, even if they are the same, cannot be extracted into constants or super methods.

Since:

6.0

Author:

Artem Bilan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	IntegrationObservation.GatewayTags	Key names for message handler observations.
static enum	IntegrationObservation.HandlerTags	Key names for message handler observations.
static enum	IntegrationObservation.ProducerTags	Key names for message producer observations.

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GATEWAY	Observation for inbound message gateways.
HANDLER	Observation for message handlers.
PRODUCER	Observation for message producers, e.g.

Field Summary

Fields inherited from interface io.micrometer.observation.docs.ObservationDocumentation

EMPTY, EMPTY_EVENT_NAMES

Method Summary

Modifier and Type	Method	Description
static IntegrationObservation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IntegrationObservation[]	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

Methods inherited from interface io.micrometer.observation.docs.ObservationDocumentation

getContextualName, getDefaultConvention, getEvents, getHighCardinalityKeyNames, getLowCardinalityKeyNames, getName, getPrefix, observation, observation, observation, start, start, start

Enum Constant Details

HANDLER

public static final IntegrationObservation HANDLER

Observation for message handlers.

GATEWAY

public static final IntegrationObservation GATEWAY

Observation for inbound message gateways.

PRODUCER

public static final IntegrationObservation PRODUCER

Observation for message producers, e.g. channels.

Method Details

values

public static IntegrationObservation[] 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 IntegrationObservation 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