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

Class EntityRowKey

java.lang.Object

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

Direct Known Subclasses:

EntityRowKeyPrefix

public class EntityRowKey
extends java.lang.Object

Represents a rowkey for the entity table.

Constructor Summary

Constructors

Constructor	Description
EntityRowKey(java.lang.String clusterId, java.lang.String userId, java.lang.String flowName, java.lang.Long flowRunId, java.lang.String appId, java.lang.String entityType, java.lang.Long entityIdPrefix, java.lang.String entityId)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAppId()
java.lang.String	getClusterId()
java.lang.String	getEntityId()
java.lang.Long	getEntityIdPrefix()
java.lang.String	getEntityType()
java.lang.String	getFlowName()
java.lang.Long	getFlowRunId()
byte[]	getRowKey()	Constructs a row key for the entity table as follows: userName!clusterId!flowName!flowRunId!AppId!entityType!entityId.
java.lang.String	getRowKeyAsString()	Constructs a row key for the entity table as follows:
java.lang.String	getUserId()
static EntityRowKey	parseRowKey(byte[] rowKey)	Given the raw row key as bytes, returns the row key as an object.
static EntityRowKey	parseRowKeyFromString(java.lang.String encodedRowKey)	Given the encoded 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

EntityRowKey

public EntityRowKey(java.lang.String clusterId,
                    java.lang.String userId,
                    java.lang.String flowName,
                    java.lang.Long flowRunId,
                    java.lang.String appId,
                    java.lang.String entityType,
                    java.lang.Long entityIdPrefix,
                    java.lang.String entityId)

Method Detail

getClusterId

public java.lang.String getClusterId()

getUserId

public java.lang.String getUserId()

getFlowName

public java.lang.String getFlowName()

getFlowRunId

public java.lang.Long getFlowRunId()

getAppId

public java.lang.String getAppId()

getEntityType

public java.lang.String getEntityType()

getEntityId

public java.lang.String getEntityId()

getEntityIdPrefix

public java.lang.Long getEntityIdPrefix()

getRowKey

public byte[] getRowKey()

Constructs a row key for the entity table as follows: userName!clusterId!flowName!flowRunId!AppId!entityType!entityId. Typically used while querying a specific entity.

Returns:

byte array with the row key.

parseRowKey

public static EntityRowKey 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:

An EntityRowKey object.

getRowKeyAsString

public java.lang.String getRowKeyAsString()

Constructs a row key for the entity table as follows:

userName!clusterId!flowName!flowRunId!AppId! entityType!entityIdPrefix!entityId.

Returns:

String representation of row key.

parseRowKeyFromString

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

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

Parameters:

encodedRowKey - String representation of row key.

Returns:

A EntityRowKey object.