Package org.apache.hadoop.yarn.server.timelineservice.storage.entity

Enum Class EntityColumnPrefix

java.lang.Object

java.lang.Enum<EntityColumnPrefix>

org.apache.hadoop.yarn.server.timelineservice.storage.entity.EntityColumnPrefix

All Implemented Interfaces:

Serializable, Comparable<EntityColumnPrefix>, Constable, ColumnPrefix<EntityTable>

public enum EntityColumnPrefix
extends Enum<EntityColumnPrefix>
implements ColumnPrefix<EntityTable>

Identifies partially qualified columns for the entity table.

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
CONFIG	Config column stores configuration with config key as the column name.
EVENT	Lifecycle events for an entity.
INFO	To store TimelineEntity info values.
IS_RELATED_TO	To store TimelineEntity getIsRelatedToEntities values.
METRIC	Metrics are stored with the metric name as the column name.
RELATES_TO	To store TimelineEntity getRelatesToEntities values.

Method Summary

Modifier and Type	Method	Description
byte[]	getColumnFamilyBytes()	Returns column family name(as bytes) associated with this column prefix.
String	getColumnPrefix()
byte[]	getColumnPrefixBytes(byte[] qualifierPrefix)
byte[]	getColumnPrefixBytes(String qualifierPrefix)
byte[]	getColumnPrefixInBytes()	Get the column prefix in bytes.
Attribute[]	getCombinedAttrsWithAggr(Attribute... attributes)	Return attributed combined with aggregations, if any.
ValueConverter	getValueConverter()	Returns value converter implementation associated with this column prefix.
boolean	supplementCellTimeStamp()	Return true if the cell timestamp needs to be supplemented.
static EntityColumnPrefix	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EntityColumnPrefix[]	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

IS_RELATED_TO

public static final EntityColumnPrefix IS_RELATED_TO

To store TimelineEntity getIsRelatedToEntities values.

RELATES_TO

public static final EntityColumnPrefix RELATES_TO

To store TimelineEntity getRelatesToEntities values.

INFO

public static final EntityColumnPrefix INFO

To store TimelineEntity info values.

EVENT

public static final EntityColumnPrefix EVENT

Lifecycle events for an entity.

CONFIG

public static final EntityColumnPrefix CONFIG

Config column stores configuration with config key as the column name.

METRIC

public static final EntityColumnPrefix METRIC

Metrics are stored with the metric name as the column name.

Method Details

values

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

getColumnPrefix

public String getColumnPrefix()

Returns:

the column name value

getColumnPrefixBytes

public byte[] getColumnPrefixBytes(byte[] qualifierPrefix)

Specified by:

getColumnPrefixBytes in interface ColumnPrefix<EntityTable>

Parameters:

qualifierPrefix - Column qualifier or prefix of qualifier.

Returns:

a byte array encoding column prefix and qualifier/prefix passed.

getColumnPrefixBytes

public byte[] getColumnPrefixBytes(String qualifierPrefix)

Specified by:

getColumnPrefixBytes in interface ColumnPrefix<EntityTable>

Parameters:

qualifierPrefix - Column qualifier or prefix of qualifier.

Returns:

a byte array encoding column prefix and qualifier/prefix passed.

getColumnPrefixInBytes

public byte[] getColumnPrefixInBytes()

Description copied from interface: ColumnPrefix

Get the column prefix in bytes.

Specified by:

getColumnPrefixInBytes in interface ColumnPrefix<EntityTable>

Returns:

column prefix in bytes

getColumnFamilyBytes

public byte[] getColumnFamilyBytes()

Description copied from interface: ColumnPrefix

Returns column family name(as bytes) associated with this column prefix.

Specified by:

getColumnFamilyBytes in interface ColumnPrefix<EntityTable>

Returns:

a byte array encoding column family for this prefix.

getValueConverter

public ValueConverter getValueConverter()

Description copied from interface: ColumnPrefix

Returns value converter implementation associated with this column prefix.

Specified by:

getValueConverter in interface ColumnPrefix<EntityTable>

Returns:

a ValueConverter implementation.

getCombinedAttrsWithAggr

public Attribute[] getCombinedAttrsWithAggr(Attribute... attributes)

Description copied from interface: ColumnPrefix

Return attributed combined with aggregations, if any.

Specified by:

getCombinedAttrsWithAggr in interface ColumnPrefix<EntityTable>

Returns:

an array of Attributes

supplementCellTimeStamp

public boolean supplementCellTimeStamp()

Description copied from interface: ColumnPrefix

Return true if the cell timestamp needs to be supplemented.

Specified by:

supplementCellTimeStamp in interface ColumnPrefix<EntityTable>

Returns:

true if the cell timestamp needs to be supplemented