Package org.elasticsearch.xpack.esql.plan.logical

Enum Class SourceCommand

java.lang.Object

java.lang.Enum<SourceCommand>

org.elasticsearch.xpack.esql.plan.logical.SourceCommand

All Implemented Interfaces:

Serializable, Comparable<SourceCommand>, Constable

public enum SourceCommand
extends Enum<SourceCommand>

Contains all varieties of source commands (FROM, TS, PROMQL, ...) and their associated index mode.

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
FROM
PROMQL
TS

Method Summary

Modifier and Type	Method	Description
IndexMode	indexMode()
static boolean	isSourceCommand(String command)	Checks if the given command string corresponds to a valid SourceCommand.
static SourceCommand	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SourceCommand[]	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

FROM

public static final SourceCommand FROM

TS

public static final SourceCommand TS

PROMQL

public static final SourceCommand PROMQL

Method Details

values

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

isSourceCommand

public static boolean isSourceCommand(String command)

Checks if the given command string corresponds to a valid SourceCommand.

Parameters:

command - the command string to check

Returns:

true if the command is a valid SourceCommand, false otherwise

indexMode

public IndexMode indexMode()