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

All Known Implementing Classes:

ApplicationReportPBImpl

@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

ApplicationId	getApplicationId() Get the ApplicationId of the application.
ApplicationResourceUsageReport	getApplicationResourceUsageReport() Retrieve the structure containing the job resources for this application
String	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	getOriginalTrackingUrl() Get the original not-proxied tracking url for 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.
void	setApplicationId(ApplicationId applicationId)
void	setApplicationResourceUsageReport(ApplicationResourceUsageReport appResources) Store the structure containing the job resources for this application
void	setClientToken(String clientToken)
void	setDiagnostics(String diagnostics)
void	setFinalApplicationStatus(FinalApplicationStatus finishState)
void	setFinishTime(long finishTime)
void	setHost(String host)
void	setName(String name)
void	setOriginalTrackingUrl(String url)
void	setQueue(String queue)
void	setRpcPort(int rpcPort)
void	setStartTime(long startTime)
void	setTrackingUrl(String url)
void	setUser(String user)
void	setYarnApplicationState(YarnApplicationState state)

Method Detail

getApplicationId

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

Get the ApplicationId of the application.

Returns:

ApplicationId of the application

setApplicationId

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setApplicationId(ApplicationId applicationId)

getUser

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

Get the user who submitted the application.

Returns:

user who submitted the application

setUser

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setUser(String user)

getQueue

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

Get the queue to which the application was submitted.

Returns:

queue to which the application was submitted

setQueue

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setQueue(String queue)

getName

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

Get the user-defined name of the application.

Returns:

name of the application

setName

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setName(String name)

getHost

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

Get the host on which the ApplicationMaster is running.

Returns:

host on which the ApplicationMaster is running

setHost

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setHost(String host)

getRpcPort

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

Get the RPC port of the ApplicationMaster.

Returns:

RPC port of the ApplicationMaster

setRpcPort

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setRpcPort(int rpcPort)

getClientToken

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

Get the client token for communicating with the ApplicationMaster.

Returns:

client token for communicating with the ApplicationMaster

setClientToken

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setClientToken(String clientToken)

getYarnApplicationState

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

Get the YarnApplicationState of the application.

Returns:

YarnApplicationState of the application

setYarnApplicationState

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setYarnApplicationState(YarnApplicationState state)

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

setDiagnostics

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setDiagnostics(String diagnostics)

getTrackingUrl

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

Get the tracking url for the application.

Returns:

tracking url for the application

setTrackingUrl

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setTrackingUrl(String url)

getOriginalTrackingUrl

@InterfaceAudience.Private
@InterfaceStability.Unstable
String getOriginalTrackingUrl()

Get the original not-proxied tracking url for the application. This is intended to only be used by the proxy itself.

Returns:

the original not-proxied tracking url for the application

setOriginalTrackingUrl

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setOriginalTrackingUrl(String url)

getStartTime

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

Get the start time of the application.

Returns:

start time of the application

setStartTime

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setStartTime(long startTime)

getFinishTime

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

Get the finish time of the application.

Returns:

finish time of the application

setFinishTime

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setFinishTime(long finishTime)

getFinalApplicationStatus

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

Get the final finish status of the application.

Returns:

final finish status of the application

setFinalApplicationStatus

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setFinalApplicationStatus(FinalApplicationStatus finishState)

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

setApplicationResourceUsageReport

@InterfaceAudience.Private
@InterfaceStability.Unstable
void setApplicationResourceUsageReport(ApplicationResourceUsageReport appResources)

Store the structure containing the job resources for this application

Parameters:

appResources - structure for this application