Package org.elasticsearch.xpack.esql.telemetry

Enum Class FeatureMetric

java.lang.Object

java.lang.Enum<FeatureMetric>

org.elasticsearch.xpack.esql.telemetry.FeatureMetric

All Implemented Interfaces:

Serializable, Comparable<FeatureMetric>, Constable

public enum FeatureMetric
extends Enum<FeatureMetric>

ESQL "features" returned by the usage API. This mostly tracks new commands. If you add something here you must add it to the tests in 60_usage.yml then run them with:

./gradlew -p x-pack/plugin/esql/qa/server/single-node/ yamlRestTest \
    -Dtests.method='*60*'

and

./gradlew -p x-pack/plugin/esql/qa/server/single-node/ yamlRestTest \
    -Dbuild.snapshot=false -Dtests.jvm.argline=-Dbuild.snapshot=false \
    -Dlicense.key="x-pack/license-tools/src/test/resources/public.key" \
    -Dtests.method='*60*'

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
CHANGE_POINT
COMPLETION
DISSECT
DROP
ENRICH
EVAL
EXPLAIN
EXTERNAL
FORK
FROM
FUSE
GROK
INLINE_STATS
INSIST
KEEP
LIMIT
LIMIT_BY
LOOKUP
LOOKUP_JOIN
LOOKUP_JOIN_ON_EXPRESSION
METRICS_INFO
MMR
MV_EXPAND
PROMQL
REGISTERED_DOMAIN
RENAME
RERANK
ROW
SAMPLE
SHOW
SORT
STATS
SUBQUERY
TS
TS_INFO
URI_PARTS
USER_AGENT
VIEW
WHERE

Method Summary

Modifier and Type	Method	Description
static void	set(LogicalPlan plan, BitSet bitset)
static boolean	set(LogicalPlan plan, BitSet bitset, FeatureMetric metric)
String	toString()
static FeatureMetric	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FeatureMetric[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISSECT

public static final FeatureMetric DISSECT

EVAL

public static final FeatureMetric EVAL

GROK

public static final FeatureMetric GROK

LIMIT

public static final FeatureMetric LIMIT

LIMIT_BY

public static final FeatureMetric LIMIT_BY

SORT

public static final FeatureMetric SORT

STATS

public static final FeatureMetric STATS

WHERE

public static final FeatureMetric WHERE

ENRICH

public static final FeatureMetric ENRICH

EXPLAIN

public static final FeatureMetric EXPLAIN

MV_EXPAND

public static final FeatureMetric MV_EXPAND

SHOW

public static final FeatureMetric SHOW

ROW

public static final FeatureMetric ROW

FROM

public static final FeatureMetric FROM

TS

public static final FeatureMetric TS

EXTERNAL

public static final FeatureMetric EXTERNAL

DROP

public static final FeatureMetric DROP

KEEP

public static final FeatureMetric KEEP

RENAME

public static final FeatureMetric RENAME

LOOKUP_JOIN

public static final FeatureMetric LOOKUP_JOIN

LOOKUP_JOIN_ON_EXPRESSION

public static final FeatureMetric LOOKUP_JOIN_ON_EXPRESSION

LOOKUP

public static final FeatureMetric LOOKUP

CHANGE_POINT

public static final FeatureMetric CHANGE_POINT

INLINE_STATS

public static final FeatureMetric INLINE_STATS

RERANK

public static final FeatureMetric RERANK

INSIST

public static final FeatureMetric INSIST

FORK

public static final FeatureMetric FORK

FUSE

public static final FeatureMetric FUSE

COMPLETION

public static final FeatureMetric COMPLETION

SAMPLE

public static final FeatureMetric SAMPLE

SUBQUERY

public static final FeatureMetric SUBQUERY

VIEW

public static final FeatureMetric VIEW

MMR

public static final FeatureMetric MMR

PROMQL

public static final FeatureMetric PROMQL

URI_PARTS

public static final FeatureMetric URI_PARTS

METRICS_INFO

public static final FeatureMetric METRICS_INFO

REGISTERED_DOMAIN

public static final FeatureMetric REGISTERED_DOMAIN

TS_INFO

public static final FeatureMetric TS_INFO

USER_AGENT

public static final FeatureMetric USER_AGENT

Method Details

values

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

toString

public String toString()

Overrides:

toString in class Enum<FeatureMetric>

set

public static void set(LogicalPlan plan,
 BitSet bitset)

set

public static boolean set(LogicalPlan plan,
 BitSet bitset,
 FeatureMetric metric)