Package org.springframework.web.reactive.function.client

Enum Class ClientObservationDocumentation

java.lang.Object

java.lang.Enum<ClientObservationDocumentation>

org.springframework.web.reactive.function.client.ClientObservationDocumentation

All Implemented Interfaces:

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

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

Documented KeyValues for the WebClient observations.

This class is used by automated tools to document KeyValues attached to the HTTP client observations.

Since:

6.0

Author:

Brian Clozel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ClientObservationDocumentation.HighCardinalityKeyNames
static enum	ClientObservationDocumentation.LowCardinalityKeyNames

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HTTP_REQUEST	Observation created for an HTTP client exchange.

Field Summary

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

EMPTY, EMPTY_EVENT_NAMES

Method Summary

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

HTTP_REQUEST

public static final ClientObservationDocumentation HTTP_REQUEST

Observation created for an HTTP client exchange.

Method Details

values

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