Package org.elasticsearch.xpack.esql.expression.function

Enum Class Param.Hint.Kind

java.lang.Object

java.lang.Enum<Param.Hint.Kind>

org.elasticsearch.xpack.esql.expression.function.Param.Hint.Kind

All Implemented Interfaces:

Serializable, Comparable<Param.Hint.Kind>, Constable

Enclosing class:

Param.Hint

public static enum Param.Hint.Kind
extends Enum<Param.Hint.Kind>

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
AGGREGATION	This must be an aggregation function.
CONSTANT	A constant value.
ENTITY	A constant that references some entity to load.
STANDARD	Depends on the function type and command.

Method Summary

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

STANDARD

public static final Param.Hint.Kind STANDARD

Depends on the function type and command.

┌───────┬──────────────────────────────────────┬──────────────────────────────────┐
│       │ Scalar                               │ Aggregation                      │
├───────┼──────────────────────────────────────┼──────────────────────────────────┤
│ EVAL  │ may only be a scalar                 │ invalid                          │
│ STATS │ must contain an aggregation function │ can only contain scalar function │
└───────┴──────────────────────────────────────┴──────────────────────────────────┘

ENTITY

public static final Param.Hint.Kind ENTITY

A constant that references some entity to load.

AGGREGATION

public static final Param.Hint.Kind AGGREGATION

This must be an aggregation function.

CONSTANT

public static final Param.Hint.Kind CONSTANT

A constant value.

Method Details

values

public static Param.Hint.Kind[] 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 Param.Hint.Kind 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