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

Class EntityRowKeyPrefix

java.lang.Object

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

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

All Implemented Interfaces:

RowKeyPrefix<EntityRowKey>

public class EntityRowKeyPrefix
extends EntityRowKey
implements RowKeyPrefix<EntityRowKey>

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

Constructor Summary

Constructors

Constructor	Description
EntityRowKeyPrefix(String clusterId, String userId, String flowName, Long flowRunId, String appId)	Creates a prefix which generates the following rowKeyPrefixes for the entity table: userName!clusterId!flowName!flowRunId!AppId!entityType!entityId.
EntityRowKeyPrefix(String clusterId, String userId, String flowName, Long flowRunId, String appId, String entityType, Long entityIdPrefix, String entityId)	Creates a prefix which generates the following rowKeyPrefixes for the entity table: userName!clusterId!flowName!flowRunId!AppId!entityType!.

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.entity.EntityRowKey

getAppId, getClusterId, getEntityId, getEntityIdPrefix, getEntityType, getFlowName, getFlowRunId, getRowKey, getRowKeyAsString, getUserId, parseRowKey, parseRowKeyFromString

Methods inherited from class java.lang.Object

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

Constructor Details

EntityRowKeyPrefix

public EntityRowKeyPrefix(String clusterId,
 String userId,
 String flowName,
 Long flowRunId,
 String appId,
 String entityType,
 Long entityIdPrefix,
 String entityId)

Creates a prefix which generates the following rowKeyPrefixes for the entity table: userName!clusterId!flowName!flowRunId!AppId!entityType!.

Parameters:

clusterId - identifying the cluster

userId - identifying the user

flowName - identifying the flow

flowRunId - identifying the individual run of this flow

appId - identifying the application

entityType - which entity type

entityIdPrefix - for entityId

entityId - for an entity

EntityRowKeyPrefix

public EntityRowKeyPrefix(String clusterId,
 String userId,
 String flowName,
 Long flowRunId,
 String appId)

Creates a prefix which generates the following rowKeyPrefixes for the entity table: userName!clusterId!flowName!flowRunId!AppId!entityType!entityId.

Parameters:

clusterId - identifying the cluster

userId - identifying the user

flowName - identifying the flow

flowRunId - identifying the individual run of this flow

appId - identifying the application

Method Details

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

Returns:

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