org.apache.hadoop.yarn.server.timelineservice.storage.apptoflow

Enum AppToFlowColumnPrefix

java.lang.Object

java.lang.Enum<AppToFlowColumnPrefix>

org.apache.hadoop.yarn.server.timelineservice.storage.apptoflow.AppToFlowColumnPrefix

All Implemented Interfaces:

Serializable, Comparable<AppToFlowColumnPrefix>, ColumnPrefix<AppToFlowTable>

public enum AppToFlowColumnPrefix
extends Enum<AppToFlowColumnPrefix>
implements ColumnPrefix<AppToFlowTable>

Identifies partially qualified columns for the app-to-flow table.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLOW_NAME The flow name.
FLOW_RUN_ID The flow run ID.
USER_ID The user.

Method Summary

Methods

Modifier and Type	Method and Description
static AppToFlowColumnPrefix	columnFor(AppToFlowColumnFamily columnFamily, String columnPrefix) Retrieve an AppToFlowColumnPrefix given a name, or null if there is no match.
static AppToFlowColumnPrefix	columnFor(String columnPrefix) Retrieve an AppToFlowColumnPrefix given a name, or null if there is no match.
byte[]	getColumnFamilyBytes() Returns column family name(as bytes) associated with this column prefix.
byte[]	getColumnPrefixBytes(byte[] qualifierPrefix)
byte[]	getColumnPrefixBytes(String qualifierPrefix)
ValueConverter	getValueConverter() Returns value converter implementation associated with this column prefix.
Object	readResult(org.apache.hadoop.hbase.client.Result result, String qualifier) Get the latest version of this specified column.
<K> Map<K,Object>	readResults(org.apache.hadoop.hbase.client.Result result, KeyConverter<K> keyConverter)
<K,V> NavigableMap<K,NavigableMap<Long,V>>	readResultsWithTimestamps(org.apache.hadoop.hbase.client.Result result, KeyConverter<K> keyConverter)
void	store(byte[] rowKey, TypedBufferedMutator<AppToFlowTable> tableMutator, byte[] qualifier, Long timestamp, Object inputValue, Attribute... attributes) Sends a Mutation to the table.
void	store(byte[] rowKey, TypedBufferedMutator<AppToFlowTable> tableMutator, String qualifier, Long timestamp, Object inputValue, Attribute... attributes) Sends a Mutation to the table.
static AppToFlowColumnPrefix	valueOf(String name) Returns the enum constant of this type with the specified name.
static AppToFlowColumnPrefix[]	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

FLOW_NAME

public static final AppToFlowColumnPrefix FLOW_NAME

The flow name.

FLOW_RUN_ID

public static final AppToFlowColumnPrefix FLOW_RUN_ID

The flow run ID.

USER_ID

public static final AppToFlowColumnPrefix USER_ID

The user.

Method Detail

values

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

Returns:

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

valueOf

public static AppToFlowColumnPrefix 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

getColumnPrefixBytes

public byte[] getColumnPrefixBytes(String qualifierPrefix)

Specified by:

getColumnPrefixBytes in interface ColumnPrefix<AppToFlowTable>

Parameters:

qualifierPrefix - Column qualifier or prefix of qualifier.

Returns:

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

getColumnPrefixBytes

public byte[] getColumnPrefixBytes(byte[] qualifierPrefix)

Specified by:

getColumnPrefixBytes in interface ColumnPrefix<AppToFlowTable>

Parameters:

qualifierPrefix - Column qualifier or prefix of qualifier.

Returns:

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

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<AppToFlowTable>

Returns:

a byte array encoding column family for this prefix.

store

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

Description copied from interface: ColumnPrefix

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 ColumnPrefix<AppToFlowTable>

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.

qualifier - column qualifier. Nothing gets written when null.

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 - attributes for the mutation that are used by the coprocessor to set/read the cell tags.

Throws:

IOException - if there is any exception encountered while doing store operation(sending mutation to the table).

store

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

Description copied from interface: ColumnPrefix

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 ColumnPrefix<AppToFlowTable>

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.

qualifier - column qualifier. Nothing gets written when null.

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 - attributes for the mutation that are used by the coprocessor to set/read the cell tags.

Throws:

IOException - if there is any exception encountered while doing store operation(sending mutation to the table).

getValueConverter

public ValueConverter getValueConverter()

Description copied from interface: ColumnPrefix

Returns value converter implementation associated with this column prefix.

Specified by:

getValueConverter in interface ColumnPrefix<AppToFlowTable>

Returns:

a ValueConverter implementation.

readResult

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

Description copied from interface: ColumnPrefix

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

Specified by:

readResult in interface ColumnPrefix<AppToFlowTable>

Parameters:

result - Cannot be null

qualifier - column qualifier. Nothing gets read when null.

Returns:

result object (can be cast to whatever object was written to) or null when specified column qualifier for this prefix doesn't exist in the result.

Throws:

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

readResults

public <K> Map<K,Object> readResults(org.apache.hadoop.hbase.client.Result result,
                            KeyConverter<K> keyConverter)
                          throws IOException

Specified by:

readResults in interface ColumnPrefix<AppToFlowTable>

Type Parameters:

K - identifies the type of key converter.

Parameters:

result - from which to read columns.

keyConverter - used to convert column bytes to the appropriate key type

Returns:

the latest values of columns in the column family with this prefix (or all of them if the prefix value is null).

Throws:

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

readResultsWithTimestamps

public <K,V> NavigableMap<K,NavigableMap<Long,V>> readResultsWithTimestamps(org.apache.hadoop.hbase.client.Result result,
                                                                   KeyConverter<K> keyConverter)
                                                               throws IOException

Specified by:

readResultsWithTimestamps in interface ColumnPrefix<AppToFlowTable>

Type Parameters:

K - identifies the type of key converter.

V - the type of the values. The values will be cast into that type.

Parameters:

result - from which to reads data with timestamps.

keyConverter - used to convert column bytes to the appropriate key type.

Returns:

the cell values at each respective time in for form {idA={timestamp1->value1}, idA={timestamp2->value2}, idB={timestamp3->value3}, idC={timestamp1->value4}}

Throws:

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

columnFor

public static final AppToFlowColumnPrefix columnFor(String columnPrefix)

Retrieve an AppToFlowColumnPrefix given a name, or null if there is no match. The following holds true: columnFor(x) == columnFor(y) if and only if x.equals(y) or (x == y == null)

Parameters:

columnPrefix - Name of the column to retrieve

Returns:

the corresponding AppToFlowColumnPrefix or null

columnFor

public static final AppToFlowColumnPrefix columnFor(AppToFlowColumnFamily columnFamily,
                              String columnPrefix)

Retrieve an AppToFlowColumnPrefix given a name, or null if there is no match. The following holds true: columnFor(a,x) == columnFor(b,y) if and only if (x == y == null) or a.equals(b) & x.equals(y)

Parameters:

columnFamily - The columnFamily for which to retrieve the column.

columnPrefix - Name of the column to retrieve

Returns:

the corresponding AppToFlowColumnPrefix or null if both arguments don't match.