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

Class SubApplicationRowKey

java.lang.Object

org.apache.hadoop.yarn.server.timelineservice.storage.subapplication.SubApplicationRowKey

Direct Known Subclasses:

SubApplicationRowKeyPrefix

public class SubApplicationRowKey
extends java.lang.Object

Represents a rowkey for the sub app table.

Constructor Summary

Constructors

Constructor	Description
SubApplicationRowKey(java.lang.String subAppUserId, java.lang.String clusterId, java.lang.String entityType, java.lang.Long entityIdPrefix, java.lang.String entityId, java.lang.String userId)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getClusterId()
java.lang.String	getEntityId()
java.lang.Long	getEntityIdPrefix()
java.lang.String	getEntityType()
byte[]	getRowKey()	Constructs a row key for the sub app table as follows: subAppUserId!clusterId!entityType !entityPrefix!entityId!userId.
java.lang.String	getRowKeyAsString()	Constructs a row key for the sub app table as follows:
java.lang.String	getSubAppUserId()
java.lang.String	getUserId()
static SubApplicationRowKey	parseRowKey(byte[] rowKey)	Given the raw row key as bytes, returns the row key as an object.
static SubApplicationRowKey	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

SubApplicationRowKey

public SubApplicationRowKey(java.lang.String subAppUserId,
                            java.lang.String clusterId,
                            java.lang.String entityType,
                            java.lang.Long entityIdPrefix,
                            java.lang.String entityId,
                            java.lang.String userId)

Method Detail

getClusterId

public java.lang.String getClusterId()

getSubAppUserId

public java.lang.String getSubAppUserId()

getEntityType

public java.lang.String getEntityType()

getEntityId

public java.lang.String getEntityId()

getEntityIdPrefix

public java.lang.Long getEntityIdPrefix()

getUserId

public java.lang.String getUserId()

getRowKey

public byte[] getRowKey()

Constructs a row key for the sub app table as follows: subAppUserId!clusterId!entityType !entityPrefix!entityId!userId. Typically used while querying a specific sub app. subAppUserId is usually the doAsUser. userId is the yarn user that the AM runs as.

Returns:

byte array with the row key.

parseRowKey

public static SubApplicationRowKey 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 SubApplicationRowKey object.

getRowKeyAsString

public java.lang.String getRowKeyAsString()

Constructs a row key for the sub app table as follows:

subAppUserId!clusterId! entityType!entityIdPrefix!entityId!userId. subAppUserId is usually the doAsUser. userId is the yarn user that that the AM runs as.

Returns:

String representation of row key.

parseRowKeyFromString

public static SubApplicationRowKey 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 SubApplicationRowKey object.