Package org.apache.pinot.common.utils

Enum DataTable.MetadataKey

java.lang.Object

java.lang.Enum<DataTable.MetadataKey>

org.apache.pinot.common.utils.DataTable.MetadataKey

All Implemented Interfaces:

Serializable, Comparable<DataTable.MetadataKey>

Enclosing interface:

DataTable

public static enum DataTable.MetadataKey
extends Enum<DataTable.MetadataKey>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXPLAIN_PLAN_NUM_EMPTY_FILTER_SEGMENTS
EXPLAIN_PLAN_NUM_MATCH_ALL_FILTER_SEGMENTS
MIN_CONSUMING_FRESHNESS_TIME_MS
NUM_CONSUMING_SEGMENTS_MATCHED
NUM_CONSUMING_SEGMENTS_PROCESSED
NUM_CONSUMING_SEGMENTS_QUERIED
NUM_DOCS_SCANNED
NUM_ENTRIES_SCANNED_IN_FILTER
NUM_ENTRIES_SCANNED_POST_FILTER
NUM_GROUPS_LIMIT_REACHED
NUM_RESIZES
NUM_SEGMENTS_MATCHED
NUM_SEGMENTS_PROCESSED
NUM_SEGMENTS_PRUNED_BY_LIMIT
NUM_SEGMENTS_PRUNED_BY_SERVER
NUM_SEGMENTS_PRUNED_BY_VALUE
NUM_SEGMENTS_PRUNED_INVALID
NUM_SEGMENTS_QUERIED
REQUEST_ID
RESIZE_TIME_MS
RESPONSE_SER_CPU_TIME_NS
SYSTEM_ACTIVITIES_CPU_TIME_NS
TABLE
THREAD_CPU_TIME_NS
TIME_USED_MS
TOTAL_DOCS
TRACE_INFO
UNKNOWN

Method Summary

Modifier and Type	Method	Description
static DataTable.MetadataKey	getById(int id)	Returns the MetadataKey for the given id, or null if the id does not exist.
static DataTable.MetadataKey	getByName(String name)	Returns the MetadataKey for the given name, or null if the name does not exist.
int	getId()
String	getName()
DataTable.MetadataValueType	getValueType()
static DataTable.MetadataKey	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DataTable.MetadataKey[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final DataTable.MetadataKey UNKNOWN

TABLE

public static final DataTable.MetadataKey TABLE

NUM_DOCS_SCANNED

public static final DataTable.MetadataKey NUM_DOCS_SCANNED

NUM_ENTRIES_SCANNED_IN_FILTER

public static final DataTable.MetadataKey NUM_ENTRIES_SCANNED_IN_FILTER

NUM_ENTRIES_SCANNED_POST_FILTER

public static final DataTable.MetadataKey NUM_ENTRIES_SCANNED_POST_FILTER

NUM_SEGMENTS_QUERIED

public static final DataTable.MetadataKey NUM_SEGMENTS_QUERIED

NUM_SEGMENTS_PROCESSED

public static final DataTable.MetadataKey NUM_SEGMENTS_PROCESSED

NUM_SEGMENTS_MATCHED

public static final DataTable.MetadataKey NUM_SEGMENTS_MATCHED

NUM_CONSUMING_SEGMENTS_QUERIED

public static final DataTable.MetadataKey NUM_CONSUMING_SEGMENTS_QUERIED

NUM_CONSUMING_SEGMENTS_PROCESSED

public static final DataTable.MetadataKey NUM_CONSUMING_SEGMENTS_PROCESSED

NUM_CONSUMING_SEGMENTS_MATCHED

public static final DataTable.MetadataKey NUM_CONSUMING_SEGMENTS_MATCHED

MIN_CONSUMING_FRESHNESS_TIME_MS

public static final DataTable.MetadataKey MIN_CONSUMING_FRESHNESS_TIME_MS

TOTAL_DOCS

public static final DataTable.MetadataKey TOTAL_DOCS

NUM_GROUPS_LIMIT_REACHED

public static final DataTable.MetadataKey NUM_GROUPS_LIMIT_REACHED

TIME_USED_MS

public static final DataTable.MetadataKey TIME_USED_MS

TRACE_INFO

public static final DataTable.MetadataKey TRACE_INFO

REQUEST_ID

public static final DataTable.MetadataKey REQUEST_ID

NUM_RESIZES

public static final DataTable.MetadataKey NUM_RESIZES

RESIZE_TIME_MS

public static final DataTable.MetadataKey RESIZE_TIME_MS

THREAD_CPU_TIME_NS

public static final DataTable.MetadataKey THREAD_CPU_TIME_NS

SYSTEM_ACTIVITIES_CPU_TIME_NS

public static final DataTable.MetadataKey SYSTEM_ACTIVITIES_CPU_TIME_NS

RESPONSE_SER_CPU_TIME_NS

public static final DataTable.MetadataKey RESPONSE_SER_CPU_TIME_NS

NUM_SEGMENTS_PRUNED_BY_SERVER

public static final DataTable.MetadataKey NUM_SEGMENTS_PRUNED_BY_SERVER

NUM_SEGMENTS_PRUNED_INVALID

public static final DataTable.MetadataKey NUM_SEGMENTS_PRUNED_INVALID

NUM_SEGMENTS_PRUNED_BY_LIMIT

public static final DataTable.MetadataKey NUM_SEGMENTS_PRUNED_BY_LIMIT

NUM_SEGMENTS_PRUNED_BY_VALUE

public static final DataTable.MetadataKey NUM_SEGMENTS_PRUNED_BY_VALUE

EXPLAIN_PLAN_NUM_EMPTY_FILTER_SEGMENTS

public static final DataTable.MetadataKey EXPLAIN_PLAN_NUM_EMPTY_FILTER_SEGMENTS

EXPLAIN_PLAN_NUM_MATCH_ALL_FILTER_SEGMENTS

public static final DataTable.MetadataKey EXPLAIN_PLAN_NUM_MATCH_ALL_FILTER_SEGMENTS

Method Detail

values

public static DataTable.MetadataKey[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DataTable.MetadataKey c : DataTable.MetadataKey.values())
    System.out.println(c);

Returns:

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

valueOf

public static DataTable.MetadataKey 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

getById

@Nullable
public static DataTable.MetadataKey getById(int id)

Returns the MetadataKey for the given id, or null if the id does not exist.

getByName

@Nullable
public static DataTable.MetadataKey getByName(String name)

Returns the MetadataKey for the given name, or null if the name does not exist.

getId

public int getId()

getName

public String getName()

getValueType

public DataTable.MetadataValueType getValueType()