Package org.elasticsearch.xpack.esql.plan.physical

Enum Class MetricsInfoExec.Mode

java.lang.Object

java.lang.Enum<MetricsInfoExec.Mode>

org.elasticsearch.xpack.esql.plan.physical.MetricsInfoExec.Mode

All Implemented Interfaces:

Serializable, Comparable<MetricsInfoExec.Mode>, Constable

Enclosing class:

MetricsInfoExec

public static enum MetricsInfoExec.Mode
extends Enum<MetricsInfoExec.Mode>

Execution mode, mirroring the three-phase pattern used by aggregations.

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
FINAL	Coordinator phase: merge rows from all data nodes by metric signature.
INITIAL	Data-node phase: full shard extraction → per-node metric rows.
INTERMEDIATE	Node-level reduction: merges INITIAL results from multiple shards on the same data node.

Method Summary

Modifier and Type	Method	Description
boolean	isInputPartial()	True when this mode consumes the intermediate wire format (INTERMEDIATE, FINAL).
boolean	isOutputPartial()	True when this mode produces the intermediate wire format (INITIAL, INTERMEDIATE).
static MetricsInfoExec.Mode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MetricsInfoExec.Mode[]	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

INITIAL

public static final MetricsInfoExec.Mode INITIAL

Data-node phase: full shard extraction → per-node metric rows.

FINAL

public static final MetricsInfoExec.Mode FINAL

Coordinator phase: merge rows from all data nodes by metric signature.

INTERMEDIATE

public static final MetricsInfoExec.Mode INTERMEDIATE

Node-level reduction: merges INITIAL results from multiple shards on the same data node.

Method Details

values

public static MetricsInfoExec.Mode[] 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 MetricsInfoExec.Mode 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

isInputPartial

public boolean isInputPartial()

True when this mode consumes the intermediate wire format (INTERMEDIATE, FINAL).

isOutputPartial

public boolean isOutputPartial()

True when this mode produces the intermediate wire format (INITIAL, INTERMEDIATE).