Package org.elasticsearch.xpack.esql.action

Enum Class EsqlExecutionInfo.IncludeExecutionMetadata

java.lang.Object

java.lang.Enum<EsqlExecutionInfo.IncludeExecutionMetadata>

org.elasticsearch.xpack.esql.action.EsqlExecutionInfo.IncludeExecutionMetadata

All Implemented Interfaces:

Serializable, Comparable<EsqlExecutionInfo.IncludeExecutionMetadata>, Constable

Enclosing class:

EsqlExecutionInfo

public static enum EsqlExecutionInfo.IncludeExecutionMetadata
extends Enum<EsqlExecutionInfo.IncludeExecutionMetadata>

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
ALWAYS
CCS_ONLY
NEVER

Method Summary

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

Enum Constant Details

ALWAYS

public static final EsqlExecutionInfo.IncludeExecutionMetadata ALWAYS

CCS_ONLY

public static final EsqlExecutionInfo.IncludeExecutionMetadata CCS_ONLY

NEVER

public static final EsqlExecutionInfo.IncludeExecutionMetadata NEVER

Method Details

values

public static EsqlExecutionInfo.IncludeExecutionMetadata[] 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 EsqlExecutionInfo.IncludeExecutionMetadata 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