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

Enum EntityColumn

java.lang.Object

java.lang.Enum<EntityColumn>

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EntityColumn>, Column<EntityTable>

public enum EntityColumn
extends java.lang.Enum<EntityColumn>
implements Column<EntityTable>

Identifies fully qualified columns for the EntityTable.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREATED_TIME	When the entity was created.
FLOW_VERSION	The version of the flow that this entity belongs to.
ID	Identifier for the entity.
TYPE	The type of entity.

Method Summary

Modifier and Type	Method	Description
byte[]	getColumnFamilyBytes()	Returns column family name(as bytes) associated with this column.
byte[]	getColumnQualifierBytes()	Get byte representation for this column qualifier.
Attribute[]	getCombinedAttrsWithAggr(Attribute... attributes)	Return attributed combined with aggregations, if any.
ValueConverter	getValueConverter()	Returns value converter implementation associated with this column.
boolean	supplementCellTimestamp()	Return true if the cell timestamp needs to be supplemented.
static EntityColumn	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static EntityColumn[]	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

ID

public static final EntityColumn ID

Identifier for the entity.

TYPE

public static final EntityColumn TYPE

The type of entity.

CREATED_TIME

public static final EntityColumn CREATED_TIME

When the entity was created.

FLOW_VERSION

public static final EntityColumn FLOW_VERSION

The version of the flow that this entity belongs to.

Method Detail

values

public static EntityColumn[] 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 (EntityColumn c : EntityColumn.values())
    System.out.println(c);

Returns:

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

valueOf

public static EntityColumn valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getColumnQualifierBytes

public byte[] getColumnQualifierBytes()

Description copied from interface: Column

Get byte representation for this column qualifier.

Specified by:

getColumnQualifierBytes in interface Column<EntityTable>

Returns:

a byte array representing column qualifier.

getColumnFamilyBytes

public byte[] getColumnFamilyBytes()

Description copied from interface: Column

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

Specified by:

getColumnFamilyBytes in interface Column<EntityTable>

Returns:

a byte array encoding column family for this column qualifier.

getValueConverter

public ValueConverter getValueConverter()

Description copied from interface: Column

Returns value converter implementation associated with this column.

Specified by:

getValueConverter in interface Column<EntityTable>

Returns:

a ValueConverter implementation.

getCombinedAttrsWithAggr

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

Description copied from interface: Column

Return attributed combined with aggregations, if any.

Specified by:

getCombinedAttrsWithAggr in interface Column<EntityTable>

Returns:

an array of Attributes

supplementCellTimestamp

public boolean supplementCellTimestamp()

Description copied from interface: Column

Return true if the cell timestamp needs to be supplemented.

Specified by:

supplementCellTimestamp in interface Column<EntityTable>

Returns:

true if the cell timestamp needs to be supplemented