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

Class SubApplicationRowKeyPrefix

java.lang.Object

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

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

All Implemented Interfaces:

RowKeyPrefix<SubApplicationRowKey>

public class SubApplicationRowKeyPrefix
extends SubApplicationRowKey
implements RowKeyPrefix<SubApplicationRowKey>

Represents a partial rowkey without the entityId or without entityType and entityId for the sub application table.

Constructor Summary

Constructors

Constructor	Description
SubApplicationRowKeyPrefix(java.lang.String subAppUserId, java.lang.String clusterId, java.lang.String entityType, java.lang.Long entityIdPrefix, java.lang.String entityId, java.lang.String userId)	Creates a prefix which generates the following rowKeyPrefixes for the sub application table: subAppUserId!clusterId!entityType!entityPrefix!userId.

Method Summary

Modifier and Type	Method	Description
byte[]	getRowKeyPrefix()	Create a row key prefix, meaning a partial rowkey that can be used in range scans.

Methods inherited from class org.apache.hadoop.yarn.server.timelineservice.storage.subapplication.SubApplicationRowKey

getClusterId, getEntityId, getEntityIdPrefix, getEntityType, getRowKey, getRowKeyAsString, getSubAppUserId, getUserId, parseRowKey, parseRowKeyFromString

Methods inherited from class java.lang.Object

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

Constructor Detail

SubApplicationRowKeyPrefix

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

Creates a prefix which generates the following rowKeyPrefixes for the sub application table: subAppUserId!clusterId!entityType!entityPrefix!userId.

Parameters:

subAppUserId - identifying the subApp User

clusterId - identifying the cluster

entityType - which entity type

entityIdPrefix - for entityId

entityId - for an entity

userId - for the user who runs the AM subAppUserId is usually the doAsUser. userId is the yarn user that the AM runs as.

Method Detail

getRowKeyPrefix

public byte[] getRowKeyPrefix()

Description copied from interface: RowKeyPrefix

Create a row key prefix, meaning a partial rowkey that can be used in range scans. Which fields are included in the prefix will depend on the constructor of the specific instance that was used. Output depends on which constructor was used.

Specified by:

getRowKeyPrefix in interface RowKeyPrefix<SubApplicationRowKey>

Returns:

a prefix of the following form fist!second!...!last!