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

Class FlowActivityRowKey

java.lang.Object

org.apache.hadoop.yarn.server.timelineservice.storage.flow.FlowActivityRowKey

Direct Known Subclasses:

FlowActivityRowKeyPrefix

public class FlowActivityRowKey
extends java.lang.Object

Represents a rowkey for the flow activity table.

Constructor Summary

Constructors

Modifier	Constructor	Description
	FlowActivityRowKey(java.lang.String clusterId, java.lang.Long dayTs, java.lang.String userId, java.lang.String flowName)
protected	FlowActivityRowKey(java.lang.String clusterId, java.lang.Long timestamp, java.lang.String userId, java.lang.String flowName, boolean convertDayTsToTopOfDay)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getClusterId()
java.lang.Long	getDayTimestamp()
java.lang.String	getFlowName()
byte[]	getRowKey()	Constructs a row key for the flow activity table as follows: clusterId!dayTimestamp!user!flowName.
java.lang.String	getRowKeyAsString()	Constructs a row key for the flow activity table as follows: clusterId!dayTimestamp!user!flowName.
java.lang.String	getUserId()
static FlowActivityRowKey	parseRowKey(byte[] rowKey)	Given the raw row key as bytes, returns the row key as an object.
static FlowActivityRowKey	parseRowKeyFromString(java.lang.String encodedRowKey)	Given the raw row key as string, returns the row key as an object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlowActivityRowKey

public FlowActivityRowKey(java.lang.String clusterId,
                          java.lang.Long dayTs,
                          java.lang.String userId,
                          java.lang.String flowName)

Parameters:

clusterId - identifying the cluster

dayTs - to be converted to the top of the day timestamp

userId - identifying user

flowName - identifying the flow

FlowActivityRowKey

protected FlowActivityRowKey(java.lang.String clusterId,
                             java.lang.Long timestamp,
                             java.lang.String userId,
                             java.lang.String flowName,
                             boolean convertDayTsToTopOfDay)

Parameters:

clusterId - identifying the cluster

timestamp - when the flow activity happened. May be converted to the top of the day depending on the convertDayTsToTopOfDay argument.

userId - identifying user

flowName - identifying the flow

convertDayTsToTopOfDay - if true and timestamp isn't null, then timestamp will be converted to the top-of-the day timestamp

Method Detail

getClusterId

public java.lang.String getClusterId()

getDayTimestamp

public java.lang.Long getDayTimestamp()

getUserId

public java.lang.String getUserId()

getFlowName

public java.lang.String getFlowName()

getRowKey

public byte[] getRowKey()

Constructs a row key for the flow activity table as follows: clusterId!dayTimestamp!user!flowName.

Returns:

byte array for the row key

parseRowKey

public static FlowActivityRowKey parseRowKey(byte[] rowKey)

Given the raw row key as bytes, returns the row key as an object.

Parameters:

rowKey - Byte representation of row key.

Returns:

A FlowActivityRowKey object.

getRowKeyAsString

public java.lang.String getRowKeyAsString()

Constructs a row key for the flow activity table as follows: clusterId!dayTimestamp!user!flowName.

Returns:

String representation of row key

parseRowKeyFromString

public static FlowActivityRowKey parseRowKeyFromString(java.lang.String encodedRowKey)

Given the raw row key as string, returns the row key as an object.

Parameters:

encodedRowKey - String representation of row key.

Returns:

A FlowActivityRowKey object.