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

Class ApplicationRowKeyPrefix

java.lang.Object

org.apache.hadoop.yarn.server.timelineservice.storage.application.ApplicationRowKey

org.apache.hadoop.yarn.server.timelineservice.storage.application.ApplicationRowKeyPrefix

All Implemented Interfaces:

RowKeyPrefix<ApplicationRowKey>

public class ApplicationRowKeyPrefix
extends ApplicationRowKey
implements RowKeyPrefix<ApplicationRowKey>

Represents a partial rowkey (without flowName or without flowName and flowRunId) for the application table.

Constructor Summary

Constructors

Constructor	Description
ApplicationRowKeyPrefix(String clusterId, String userId, String flowName)	Creates a prefix which generates the following rowKeyPrefixes for the application table: clusterId!userName!flowName!.
ApplicationRowKeyPrefix(String clusterId, String userId, String flowName, Long flowRunId)	Creates a prefix which generates the following rowKeyPrefixes for the application table: clusterId!userName!flowName!flowRunId!.

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.application.ApplicationRowKey

getAppId, getClusterId, 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

ApplicationRowKeyPrefix

public ApplicationRowKeyPrefix(String clusterId,
 String userId,
 String flowName)

Creates a prefix which generates the following rowKeyPrefixes for the application table: clusterId!userName!flowName!.

Parameters:

clusterId - the cluster on which applications ran

userId - the user that ran applications

flowName - the name of the flow that was run by the user on the cluster

ApplicationRowKeyPrefix

public ApplicationRowKeyPrefix(String clusterId,
 String userId,
 String flowName,
 Long flowRunId)

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

Parameters:

clusterId - identifying the cluster

userId - identifying the user

flowName - identifying the flow

flowRunId - identifying the instance of this flow

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

Returns:

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