org.apache.hadoop.yarn.api.records

Class ApplicationReport

java.lang.Object

org.apache.hadoop.yarn.api.records.ApplicationReport

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract class ApplicationReport
extends Object

ApplicationReport is a report of an application.

It includes details such as:

• ApplicationId of the application.
• Applications user.
• Application queue.
• Application name.
• Host on which the ApplicationMaster is running.
• RPC port of the ApplicationMaster.
• Tracking URL.
• YarnApplicationState of the application.
• Diagnostic information in case of errors.
• Start time of the application.
• Client Token of the application (if security is enabled).

See Also:

ApplicationBaseProtocol.getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest)

Constructor Summary

Constructors

Constructor and Description
ApplicationReport()

Method Summary

Modifier and Type	Method and Description
abstract String	getAmNodeLabelExpression() Get the default Node Label expression for all the application's containers
abstract Token	getAMRMToken() Get the AMRM token of the application.
abstract ApplicationId	getApplicationId() Get the ApplicationId of the application.
abstract ApplicationResourceUsageReport	getApplicationResourceUsageReport() Retrieve the structure containing the job resources for this application
abstract Set<String>	getApplicationTags() Get all tags corresponding to the application
abstract Map<ApplicationTimeoutType,ApplicationTimeout>	getApplicationTimeouts()
abstract String	getApplicationType() Get the application's Type
abstract String	getAppNodeLabelExpression() Get the default Node Label expression for all the application's containers
abstract Token	getClientToAMToken() Get the client token for communicating with the ApplicationMaster.
abstract ApplicationAttemptId	getCurrentApplicationAttemptId() Get the ApplicationAttemptId of the current attempt of the application
abstract String	getDiagnostics() Get the diagnositic information of the application in case of errors.
abstract FinalApplicationStatus	getFinalApplicationStatus() Get the final finish status of the application.
abstract long	getFinishTime() Get the finish time of the application.
abstract String	getHost() Get the host on which the ApplicationMaster is running.
abstract long	getLaunchTime()
abstract org.apache.hadoop.yarn.api.records.LogAggregationStatus	getLogAggregationStatus() Get log aggregation status for the application
abstract String	getName() Get the user-defined name of the application.
abstract Priority	getPriority() Get priority of the application
abstract float	getProgress() Get the application's progress ( range 0.0 to 1.0 )
abstract String	getQueue() Get the queue to which the application was submitted.
abstract String	getRMClusterId() Get RM ClusterId.
abstract int	getRpcPort() Get the RPC port of the ApplicationMaster.
abstract long	getStartTime() Get the start time of the application.
abstract long	getSubmitTime()
abstract String	getTrackingUrl() Get the tracking url for the application.
abstract String	getUser() Get the user who submitted the application.
abstract YarnApplicationState	getYarnApplicationState() Get the YarnApplicationState of the application.
abstract boolean	isUnmanagedApp()
abstract void	setAmNodeLabelExpression(String amNodeLabelExpression)
abstract void	setAppNodeLabelExpression(String appNodeLabelExpression)
abstract void	setRMClusterId(String rmClusterId)
abstract void	setUnmanagedApp(boolean unmanagedApplication)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationReport

public ApplicationReport()

Method Detail

getApplicationId

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract ApplicationId getApplicationId()

Get the ApplicationId of the application.

Returns:

ApplicationId of the application

getCurrentApplicationAttemptId

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract ApplicationAttemptId getCurrentApplicationAttemptId()

Get the ApplicationAttemptId of the current attempt of the application

Returns:

ApplicationAttemptId of the attempt

getUser

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract String getUser()

Get the user who submitted the application.

Returns:

user who submitted the application

getQueue

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract String getQueue()

Get the queue to which the application was submitted.

Returns:

queue to which the application was submitted

getName

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract String getName()

Get the user-defined name of the application.

Returns:

name of the application

getHost

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract String getHost()

Get the host on which the ApplicationMaster is running.

Returns:

host on which the ApplicationMaster is running

getRpcPort

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract int getRpcPort()

Get the RPC port of the ApplicationMaster.

Returns:

RPC port of the ApplicationMaster

getClientToAMToken

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract Token getClientToAMToken()

Get the client token for communicating with the ApplicationMaster.

ClientToAMToken is the security token used by the AMs to verify authenticity of any client.

The ResourceManager, provides a secure token (via getClientToAMToken()) which is verified by the ApplicationMaster when the client directly talks to an AM.

Returns:

client token for communicating with the ApplicationMaster

getYarnApplicationState

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract YarnApplicationState getYarnApplicationState()

Get the YarnApplicationState of the application.

Returns:

YarnApplicationState of the application

getDiagnostics

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract String getDiagnostics()

Get the diagnositic information of the application in case of errors.

Returns:

diagnositic information of the application in case of errors

getTrackingUrl

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract String getTrackingUrl()

Get the tracking url for the application.

Returns:

tracking url for the application

getStartTime

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract long getStartTime()

Get the start time of the application.

Returns:

start time of the application

getSubmitTime

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract long getSubmitTime()

getLaunchTime

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract long getLaunchTime()

getFinishTime

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract long getFinishTime()

Get the finish time of the application.

Returns:

finish time of the application

getFinalApplicationStatus

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract FinalApplicationStatus getFinalApplicationStatus()

Get the final finish status of the application.

Returns:

final finish status of the application

getApplicationResourceUsageReport

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract ApplicationResourceUsageReport getApplicationResourceUsageReport()

Retrieve the structure containing the job resources for this application

Returns:

the job resources structure for this application

getProgress

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract float getProgress()

Get the application's progress ( range 0.0 to 1.0 )

Returns:

application's progress

getApplicationType

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract String getApplicationType()

Get the application's Type

Returns:

application's Type

getApplicationTags

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract Set<String> getApplicationTags()

Get all tags corresponding to the application

Returns:

Application's tags

getAMRMToken

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract Token getAMRMToken()

Get the AMRM token of the application.

The AMRM token is required for AM to RM scheduling operations. For managed Application Masters YARN takes care of injecting it. For unmanaged Applications Masters, the token must be obtained via this method and set in the UserGroupInformation of the current user.

The AMRM token will be returned only if all the following conditions are met:

• the requester is the owner of the ApplicationMaster
• the application master is an unmanaged ApplicationMaster
• the application master is in ACCEPTED state

Else this method returns NULL.

Returns:

the AM to RM token if available.

getLogAggregationStatus

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract org.apache.hadoop.yarn.api.records.LogAggregationStatus getLogAggregationStatus()

Get log aggregation status for the application

Returns:

Application's log aggregation status

isUnmanagedApp

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract boolean isUnmanagedApp()

Returns:

true if the AM is not managed by the RM

setUnmanagedApp

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract void setUnmanagedApp(boolean unmanagedApplication)

Parameters:

unmanagedApplication - true if RM should not manage the AM

getPriority

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract Priority getPriority()

Get priority of the application

Returns:

Application's priority

getAppNodeLabelExpression

@InterfaceStability.Unstable
public abstract String getAppNodeLabelExpression()

Get the default Node Label expression for all the application's containers

Returns:

Application's NodeLabelExpression

setAppNodeLabelExpression

@InterfaceStability.Unstable
public abstract void setAppNodeLabelExpression(String appNodeLabelExpression)

getAmNodeLabelExpression

@InterfaceStability.Unstable
public abstract String getAmNodeLabelExpression()

Get the default Node Label expression for all the application's containers

Returns:

Application's NodeLabelExpression

setAmNodeLabelExpression

@InterfaceStability.Unstable
public abstract void setAmNodeLabelExpression(String amNodeLabelExpression)

getApplicationTimeouts

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract Map<ApplicationTimeoutType,ApplicationTimeout> getApplicationTimeouts()

getRMClusterId

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract String getRMClusterId()

Get RM ClusterId.

Returns:

RM ClusterId

setRMClusterId

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract void setRMClusterId(String rmClusterId)