Package org.springframework.graphql.observation

Enum Class GraphQlObservationDocumentation

java.lang.Object

java.lang.Enum<GraphQlObservationDocumentation>

org.springframework.graphql.observation.GraphQlObservationDocumentation

All Implemented Interfaces:

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

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

Documented KeyValues for GraphQL server observations.

This class is used by automated tools to document KeyValues attached to the GraphQL execution request and data fetcher observations.

Since:

1.1.0

Author:

Brian Clozel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GraphQlObservationDocumentation.DataFetcherHighCardinalityKeyNames
static enum	GraphQlObservationDocumentation.DataFetcherLowCardinalityKeyNames
static enum	GraphQlObservationDocumentation.ExecutionRequestHighCardinalityKeyNames
static enum	GraphQlObservationDocumentation.ExecutionRequestLowCardinalityKeyNames

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DATA_FETCHER	Observation created for non-trivial data fetching operations.
EXECUTION_REQUEST	Observation created for GraphQL execution requests.

Field Summary

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

EMPTY, EMPTY_EVENT_NAMES

Method Summary

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

EXECUTION_REQUEST

public static final GraphQlObservationDocumentation EXECUTION_REQUEST

Observation created for GraphQL execution requests.

DATA_FETCHER

public static final GraphQlObservationDocumentation DATA_FETCHER

Observation created for non-trivial data fetching operations.

Method Details

values

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