Package org.springframework.http.client.observation

Enum Class ClientHttpObservationDocumentation.HighCardinalityKeyNames

java.lang.Object

java.lang.Enum<ClientHttpObservationDocumentation.HighCardinalityKeyNames>

org.springframework.http.client.observation.ClientHttpObservationDocumentation.HighCardinalityKeyNames

All Implemented Interfaces:

io.micrometer.common.docs.KeyName, Serializable, Comparable<ClientHttpObservationDocumentation.HighCardinalityKeyNames>, Constable

Enclosing class:

ClientHttpObservationDocumentation

public static enum ClientHttpObservationDocumentation.HighCardinalityKeyNames
extends Enum<ClientHttpObservationDocumentation.HighCardinalityKeyNames>
implements io.micrometer.common.docs.KeyName

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
CLIENT_NAME	Deprecated, for removal: This API element is subject to removal in a future version. in favor of ClientHttpObservationDocumentation.LowCardinalityKeyNames.CLIENT_NAME; scheduled for removal in 6.2.
HTTP_URL	HTTP request URI.

Method Summary

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

asString, isRequired, withValue, withValue

Enum Constant Details

HTTP_URL

public static final ClientHttpObservationDocumentation.HighCardinalityKeyNames HTTP_URL

HTTP request URI.

CLIENT_NAME

@Deprecated(since="6.0.5",
            forRemoval=true)
public static final ClientHttpObservationDocumentation.HighCardinalityKeyNames CLIENT_NAME

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of ClientHttpObservationDocumentation.LowCardinalityKeyNames.CLIENT_NAME; scheduled for removal in 6.2. This will be available both as a low and high cardinality key value.

Client name derived from the request URI host.

Method Details

values

public static ClientHttpObservationDocumentation.HighCardinalityKeyNames[] 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 ClientHttpObservationDocumentation.HighCardinalityKeyNames 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