Package org.apache.hadoop.yarn.api.records

Class ApplicationId

java.lang.Object

org.apache.hadoop.yarn.api.records.ApplicationId

All Implemented Interfaces:

java.lang.Comparable<ApplicationId>

@Public
@Stable
public abstract class ApplicationId
extends java.lang.Object
implements java.lang.Comparable<ApplicationId>

ApplicationId represents the globally unique identifier for an application.

The globally unique nature of the identifier is achieved by using the cluster timestamp i.e. start-time of the ResourceManager along with a monotonically increasing counter for the application.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	appIdStrPrefix

Constructor Summary

Constructors

Constructor	Description
ApplicationId()

Method Summary

Modifier and Type	Method	Description
protected abstract void	build()
int	compareTo(ApplicationId other)
boolean	equals(java.lang.Object obj)
static ApplicationId	fromString(java.lang.String appIdStr)
abstract long	getClusterTimestamp()	Get the start time of the ResourceManager which is used to generate globally unique ApplicationId.
abstract int	getId()	Get the short integer identifier of the ApplicationId which is unique for all applications started by a particular instance of the ResourceManager.
int	hashCode()
static ApplicationId	newInstance(long clusterTimestamp, int id)
protected abstract void	setClusterTimestamp(long clusterTimestamp)
protected abstract void	setId(int id)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

appIdStrPrefix

@Private
@Unstable
public static final java.lang.String appIdStrPrefix

See Also:

Constant Field Values

Constructor Detail

ApplicationId

public ApplicationId()

Method Detail

newInstance

@Public
@Unstable
public static ApplicationId newInstance(long clusterTimestamp,
                                        int id)

getId

@Public
@Stable
public abstract int getId()

Get the short integer identifier of the ApplicationId which is unique for all applications started by a particular instance of the ResourceManager.

Returns:

short integer identifier of the ApplicationId

setId

@Private
@Unstable
protected abstract void setId(int id)

getClusterTimestamp

@Public
@Stable
public abstract long getClusterTimestamp()

Get the start time of the ResourceManager which is used to generate globally unique ApplicationId.

Returns:

start time of the ResourceManager

setClusterTimestamp

@Private
@Unstable
protected abstract void setClusterTimestamp(long clusterTimestamp)

build

protected abstract void build()

compareTo

public int compareTo(ApplicationId other)

Specified by:

compareTo in interface java.lang.Comparable<ApplicationId>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

fromString

@Public
@Stable
public static ApplicationId fromString(java.lang.String appIdStr)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object