org.apache.hadoop.yarn.api.records

Interface ApplicationReport

@InterfaceAudience.Public
@InterfaceStability.Stable
public interface ApplicationReport

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:

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

Method Summary

Methods

Modifier and Type	Method and Description
ApplicationId	getApplicationId() Get the ApplicationId of the application.
ApplicationResourceUsageReport	getApplicationResourceUsageReport() Retrieve the structure containing the job resources for this application
ClientToken	getClientToken() Get the client token for communicating with the ApplicationMaster.
String	getDiagnostics() Get the diagnositic information of the application in case of errors.
FinalApplicationStatus	getFinalApplicationStatus() Get the final finish status of the application.
long	getFinishTime() Get the finish time of the application.
String	getHost() Get the host on which the ApplicationMaster is running.
String	getName() Get the user-defined name of the application.
String	getQueue() Get the queue to which the application was submitted.
int	getRpcPort() Get the RPC port of the ApplicationMaster.
long	getStartTime() Get the start time of the application.
String	getTrackingUrl() Get the tracking url for the application.
String	getUser() Get the user who submitted the application.
YarnApplicationState	getYarnApplicationState() Get the YarnApplicationState of the application.

Method Detail

getApplicationId

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

Get the ApplicationId of the application.

Returns:

ApplicationId of the application

getUser

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

Get the user who submitted the application.

Returns:

user who submitted the application

getQueue

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

Get the queue to which the application was submitted.

Returns:

queue to which the application was submitted

getName

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

Get the user-defined name of the application.

Returns:

name of the application

getHost

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

Get the host on which the ApplicationMaster is running.

Returns:

host on which the ApplicationMaster is running

getRpcPort

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

Get the RPC port of the ApplicationMaster.

Returns:

RPC port of the ApplicationMaster

getClientToken

@InterfaceAudience.Public
@InterfaceStability.Stable
ClientToken getClientToken()

Get the client token for communicating with the ApplicationMaster.

Returns:

client token for communicating with the ApplicationMaster

getYarnApplicationState

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

Get the YarnApplicationState of the application.

Returns:

YarnApplicationState of the application

getDiagnostics

@InterfaceAudience.Public
@InterfaceStability.Stable
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
String getTrackingUrl()

Get the tracking url for the application.

Returns:

tracking url for the application

getStartTime

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

Get the start time of the application.

Returns:

start time of the application

getFinishTime

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

Get the finish time of the application.

Returns:

finish time of the application

getFinalApplicationStatus

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

Get the final finish status of the application.

Returns:

final finish status of the application

getApplicationResourceUsageReport

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

Retrieve the structure containing the job resources for this application

Returns:

the job resources structure for this application