Module org.elasticsearch.compute

Package org.elasticsearch.compute.operator.exchange

Enum Class BatchContext.BatchLifecycle

java.lang.Object

java.lang.Enum<BatchContext.BatchLifecycle>

org.elasticsearch.compute.operator.exchange.BatchContext.BatchLifecycle

All Implemented Interfaces:

Serializable, Comparable<BatchContext.BatchLifecycle>, Constable

Enclosing class:

BatchContext

public static enum BatchContext.BatchLifecycle
extends Enum<BatchContext.BatchLifecycle>

Batch lifecycle states.

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
ACTIVE	Processing a batch - receiving and processing pages
DRAINING	Last page received, waiting for pipeline to drain before flush
IDLE	Between batches, ready for next batch
NOT_STARTED	Initial state - never received any batch

Method Summary

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

NOT_STARTED

public static final BatchContext.BatchLifecycle NOT_STARTED

Initial state - never received any batch

ACTIVE

public static final BatchContext.BatchLifecycle ACTIVE

Processing a batch - receiving and processing pages

DRAINING

public static final BatchContext.BatchLifecycle DRAINING

Last page received, waiting for pipeline to drain before flush

IDLE

public static final BatchContext.BatchLifecycle IDLE

Between batches, ready for next batch

Method Details

values

public static BatchContext.BatchLifecycle[] 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 BatchContext.BatchLifecycle 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