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:

Serializable, Comparable<EntityColumn>, Column<EntityTable>

public enum EntityColumn
extends Enum<EntityColumn>
implements Column<EntityTable>

Identifies fully qualified columns for the EntityTable.

Enum Constant Summary

Enum Constants

Enum Constant and 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

Methods

Modifier and Type	Method and Description
byte[]	getColumnFamilyBytes() Returns column family name(as bytes) associated with this column.
byte[]	getColumnQualifierBytes() Get byte representation for this column qualifier.
ValueConverter	getValueConverter() Returns value converter implementation associated with this column.
Object	readResult(org.apache.hadoop.hbase.client.Result result) Get the latest version of this specified column.
void	store(byte[] rowKey, TypedBufferedMutator<EntityTable> tableMutator, Long timestamp, Object inputValue, Attribute... attributes) Sends a Mutation to the table.
static EntityColumn	valueOf(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(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

store

public void store(byte[] rowKey,
         TypedBufferedMutator<EntityTable> tableMutator,
         Long timestamp,
         Object inputValue,
         Attribute... attributes)
           throws IOException

Description copied from interface: Column

Sends a Mutation to the table. The mutations will be buffered and sent over the wire as part of a batch.

Specified by:

store in interface Column<EntityTable>

Parameters:

rowKey - identifying the row to write. Nothing gets written when null.

tableMutator - used to modify the underlying HBase table. Caller is responsible to pass a mutator for the table that actually has this column.

timestamp - version timestamp. When null the server timestamp will be used.

inputValue - the value to write to the rowKey and column qualifier. Nothing gets written when null.

attributes - Map of attributes for this mutation. used in the coprocessor to set/read the cell tags. Can be null.

Throws:

IOException - if there is any exception encountered during store.

readResult

public Object readResult(org.apache.hadoop.hbase.client.Result result)
                  throws IOException

Description copied from interface: Column

Get the latest version of this specified column. Note: this call clones the value content of the hosting Cell.

Specified by:

readResult in interface Column<EntityTable>

Parameters:

result - Cannot be null

Returns:

result object (can be cast to whatever object was written to), or null when result doesn't contain this column.

Throws:

IOException - if there is any exception encountered while reading result.

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.