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

Class AppCollectorData

java.lang.Object

org.apache.hadoop.yarn.server.api.records.AppCollectorData

Direct Known Subclasses:

AppCollectorDataPBImpl

@Private
@Unstable
public abstract class AppCollectorData
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static final long	DEFAULT_TIMESTAMP_VALUE

Constructor Summary

Constructors

Constructor	Description
AppCollectorData()

Method Summary

Modifier and Type	Method	Description
abstract org.apache.hadoop.yarn.api.records.ApplicationId	getApplicationId()
abstract String	getCollectorAddr()
abstract org.apache.hadoop.yarn.api.records.Token	getCollectorToken()	Get delegation token for app collector which AM will use to publish entities.
abstract long	getRMIdentifier()
abstract long	getVersion()
static boolean	happensBefore(AppCollectorData dataA, AppCollectorData dataB)	Returns if a collector data item happens before another one.
boolean	isStamped()	Returns if the collector data has been stamped by the RM with a RM cluster timestamp and a version number.
static AppCollectorData	newInstance(org.apache.hadoop.yarn.api.records.ApplicationId id, String collectorAddr)
static AppCollectorData	newInstance(org.apache.hadoop.yarn.api.records.ApplicationId id, String collectorAddr, long rmIdentifier, long version)
static AppCollectorData	newInstance(org.apache.hadoop.yarn.api.records.ApplicationId id, String collectorAddr, long rmIdentifier, long version, org.apache.hadoop.yarn.api.records.Token token)
static AppCollectorData	newInstance(org.apache.hadoop.yarn.api.records.ApplicationId id, String collectorAddr, org.apache.hadoop.yarn.api.records.Token token)
abstract void	setApplicationId(org.apache.hadoop.yarn.api.records.ApplicationId id)
abstract void	setCollectorAddr(String addr)
abstract void	setCollectorToken(org.apache.hadoop.yarn.api.records.Token token)
abstract void	setRMIdentifier(long rmId)
abstract void	setVersion(long version)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TIMESTAMP_VALUE

protected static final long DEFAULT_TIMESTAMP_VALUE

See Also:

• Constant Field Values

Constructor Details

AppCollectorData

public AppCollectorData()

Method Details

newInstance

public static AppCollectorData newInstance(org.apache.hadoop.yarn.api.records.ApplicationId id,
 String collectorAddr,
 long rmIdentifier,
 long version,
 org.apache.hadoop.yarn.api.records.Token token)

newInstance

public static AppCollectorData newInstance(org.apache.hadoop.yarn.api.records.ApplicationId id,
 String collectorAddr,
 long rmIdentifier,
 long version)

newInstance

public static AppCollectorData newInstance(org.apache.hadoop.yarn.api.records.ApplicationId id,
 String collectorAddr,
 org.apache.hadoop.yarn.api.records.Token token)

newInstance

public static AppCollectorData newInstance(org.apache.hadoop.yarn.api.records.ApplicationId id,
 String collectorAddr)

happensBefore

public static boolean happensBefore(AppCollectorData dataA,
 AppCollectorData dataB)

Returns if a collector data item happens before another one. Null data items happens before any other non-null items. Non-null data items A happens before another non-null item B when A's rmIdentifier is less than B's rmIdentifier. Or A's version is less than B's if they have the same rmIdentifier.

Parameters:

dataA - first collector data item.

dataB - second collector data item.

Returns:

true if dataA happens before dataB.

isStamped

public boolean isStamped()

Returns if the collector data has been stamped by the RM with a RM cluster timestamp and a version number.

Returns:

true if RM has already assigned a timestamp for this collector. Otherwise, it means the RM has not recognized the existence of this collector.

getApplicationId

public abstract org.apache.hadoop.yarn.api.records.ApplicationId getApplicationId()

setApplicationId

public abstract void setApplicationId(org.apache.hadoop.yarn.api.records.ApplicationId id)

getCollectorAddr

public abstract String getCollectorAddr()

setCollectorAddr

public abstract void setCollectorAddr(String addr)

getRMIdentifier

public abstract long getRMIdentifier()

setRMIdentifier

public abstract void setRMIdentifier(long rmId)

getVersion

public abstract long getVersion()

setVersion

public abstract void setVersion(long version)

getCollectorToken

public abstract org.apache.hadoop.yarn.api.records.Token getCollectorToken()

Get delegation token for app collector which AM will use to publish entities.

Returns:

the delegation token for app collector.

setCollectorToken

public abstract void setCollectorToken(org.apache.hadoop.yarn.api.records.Token token)