Package org.apache.pinot.common.datablock

Enum MetadataBlock.MetadataBlockType

java.lang.Object

java.lang.Enum<MetadataBlock.MetadataBlockType>

org.apache.pinot.common.datablock.MetadataBlock.MetadataBlockType

All Implemented Interfaces:

Serializable, Comparable<MetadataBlock.MetadataBlockType>, java.lang.constant.Constable

Enclosing class:

MetadataBlock

public static enum MetadataBlock.MetadataBlockType
extends Enum<MetadataBlock.MetadataBlockType>

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
EOS	Indicates that this block is the final block to be sent (End Of Stream) as part of an operator chain computation.
ERROR	An ERROR metadata block indicates that there was some error during computation.
NOOP	A NOOP metadata block can be sent at any point to and should be ignored by downstream - it is often used to indicate that the operator chain either has nothing to process or has processed data but is not yet ready to emit a result block.

Method Summary

Modifier and Type	Method	Description
static MetadataBlock.MetadataBlockType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MetadataBlock.MetadataBlockType[]	values()	Returns an array containing the constants of this enum type, 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 Detail

EOS

public static final MetadataBlock.MetadataBlockType EOS

Indicates that this block is the final block to be sent (End Of Stream) as part of an operator chain computation.

ERROR

public static final MetadataBlock.MetadataBlockType ERROR

An ERROR metadata block indicates that there was some error during computation. To retrieve the error that occurred, use BaseDataBlock.getExceptions()

NOOP

public static final MetadataBlock.MetadataBlockType NOOP

A NOOP metadata block can be sent at any point to and should be ignored by downstream - it is often used to indicate that the operator chain either has nothing to process or has processed data but is not yet ready to emit a result block.

Method Detail

values

public static MetadataBlock.MetadataBlockType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MetadataBlock.MetadataBlockType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null