org.apache.hadoop.yarn.api.records.impl.pb

Class ApplicationReportPBImpl

java.lang.Object

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

org.apache.hadoop.yarn.api.records.impl.pb.ApplicationReportPBImpl

@InterfaceAudience.Private
@InterfaceStability.Unstable
public class ApplicationReportPBImpl
extends ApplicationReport

Constructor Summary

Constructors

Constructor and Description
ApplicationReportPBImpl()
ApplicationReportPBImpl(YarnProtos.ApplicationReportProto proto)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
Token	getAMRMToken() Get the AMRM token of the application.
ApplicationId	getApplicationId() Get the ApplicationId of the application.
ApplicationResourceUsageReport	getApplicationResourceUsageReport() Retrieve the structure containing the job resources for this application
String	getApplicationType() Get the application's Type
Token	getClientToAMToken() Get the client token for communicating with the ApplicationMaster.
ApplicationAttemptId	getCurrentApplicationAttemptId() Get the ApplicationAttemptId of the current attempt of the application
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.
float	getProgress() Get the application's progress ( range 0.0 to 1.0 )
YarnProtos.ApplicationReportProto	getProto()
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.
int	hashCode()
void	setAMRMToken(Token amRmToken)
void	setApplicationId(ApplicationId applicationId)
void	setApplicationResourceUsageReport(ApplicationResourceUsageReport appInfo) Store the structure containing the job resources for this application
void	setApplicationType(String applicationType)
void	setClientToAMToken(Token clientToAMToken)
void	setCurrentApplicationAttemptId(ApplicationAttemptId applicationAttemptId)
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	setProgress(float progress)
void	setQueue(String queue)
void	setRpcPort(int rpcPort)
void	setStartTime(long startTime)
void	setTrackingUrl(String url)
void	setUser(String user)
void	setYarnApplicationState(YarnApplicationState state)
String	toString()

Methods inherited from class org.apache.hadoop.yarn.api.records.ApplicationReport

newInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationReportPBImpl

public ApplicationReportPBImpl()

ApplicationReportPBImpl

public ApplicationReportPBImpl(YarnProtos.ApplicationReportProto proto)

Method Detail

getApplicationId

public ApplicationId getApplicationId()

Description copied from class: ApplicationReport

Get the ApplicationId of the application.

Specified by:

getApplicationId in class ApplicationReport

Returns:

ApplicationId of the application

setApplicationResourceUsageReport

public void setApplicationResourceUsageReport(ApplicationResourceUsageReport appInfo)

Description copied from class: ApplicationReport

Store the structure containing the job resources for this application

Specified by:

setApplicationResourceUsageReport in class ApplicationReport

Parameters:

appInfo - structure for this application

getCurrentApplicationAttemptId

public ApplicationAttemptId getCurrentApplicationAttemptId()

Description copied from class: ApplicationReport

Get the ApplicationAttemptId of the current attempt of the application

Specified by:

getCurrentApplicationAttemptId in class ApplicationReport

Returns:

ApplicationAttemptId of the attempt

getApplicationResourceUsageReport

public ApplicationResourceUsageReport getApplicationResourceUsageReport()

Description copied from class: ApplicationReport

Retrieve the structure containing the job resources for this application

Specified by:

getApplicationResourceUsageReport in class ApplicationReport

Returns:

the job resources structure for this application

getTrackingUrl

public String getTrackingUrl()

Description copied from class: ApplicationReport

Get the tracking url for the application.

Specified by:

getTrackingUrl in class ApplicationReport

Returns:

tracking url for the application

getOriginalTrackingUrl

public String getOriginalTrackingUrl()

Description copied from class: ApplicationReport

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

Specified by:

getOriginalTrackingUrl in class ApplicationReport

Returns:

the original not-proxied tracking url for the application

getName

public String getName()

Description copied from class: ApplicationReport

Get the user-defined name of the application.

Specified by:

getName in class ApplicationReport

Returns:

name of the application

getQueue

public String getQueue()

Description copied from class: ApplicationReport

Get the queue to which the application was submitted.

Specified by:

getQueue in class ApplicationReport

Returns:

queue to which the application was submitted

getYarnApplicationState

public YarnApplicationState getYarnApplicationState()

Description copied from class: ApplicationReport

Get the YarnApplicationState of the application.

Specified by:

getYarnApplicationState in class ApplicationReport

Returns:

YarnApplicationState of the application

getHost

public String getHost()

Description copied from class: ApplicationReport

Get the host on which the ApplicationMaster is running.

Specified by:

getHost in class ApplicationReport

Returns:

host on which the ApplicationMaster is running

getRpcPort

public int getRpcPort()

Description copied from class: ApplicationReport

Get the RPC port of the ApplicationMaster.

Specified by:

getRpcPort in class ApplicationReport

Returns:

RPC port of the ApplicationMaster

getClientToAMToken

public Token getClientToAMToken()

Description copied from class: ApplicationReport

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 ApplicationReport.getClientToAMToken()) which is verified by the ApplicationMaster when the client directly talks to an AM.

Specified by:

getClientToAMToken in class ApplicationReport

Returns:

client token for communicating with the ApplicationMaster

getUser

public String getUser()

Description copied from class: ApplicationReport

Get the user who submitted the application.

Specified by:

getUser in class ApplicationReport

Returns:

user who submitted the application

getDiagnostics

public String getDiagnostics()

Description copied from class: ApplicationReport

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

Specified by:

getDiagnostics in class ApplicationReport

Returns:

diagnositic information of the application in case of errors

getStartTime

public long getStartTime()

Description copied from class: ApplicationReport

Get the start time of the application.

Specified by:

getStartTime in class ApplicationReport

Returns:

start time of the application

getFinishTime

public long getFinishTime()

Description copied from class: ApplicationReport

Get the finish time of the application.

Specified by:

getFinishTime in class ApplicationReport

Returns:

finish time of the application

getFinalApplicationStatus

public FinalApplicationStatus getFinalApplicationStatus()

Description copied from class: ApplicationReport

Get the final finish status of the application.

Specified by:

getFinalApplicationStatus in class ApplicationReport

Returns:

final finish status of the application

getProgress

public float getProgress()

Description copied from class: ApplicationReport

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

Specified by:

getProgress in class ApplicationReport

Returns:

application's progress

getApplicationType

public String getApplicationType()

Description copied from class: ApplicationReport

Get the application's Type

Specified by:

getApplicationType in class ApplicationReport

Returns:

application's Type

getAMRMToken

public Token getAMRMToken()

Description copied from class: ApplicationReport

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.

Specified by:

getAMRMToken in class ApplicationReport

Returns:

the AM to RM token if available.

setApplicationId

public void setApplicationId(ApplicationId applicationId)

Specified by:

setApplicationId in class ApplicationReport

setCurrentApplicationAttemptId

public void setCurrentApplicationAttemptId(ApplicationAttemptId applicationAttemptId)

Specified by:

setCurrentApplicationAttemptId in class ApplicationReport

setTrackingUrl

public void setTrackingUrl(String url)

Specified by:

setTrackingUrl in class ApplicationReport

setOriginalTrackingUrl

public void setOriginalTrackingUrl(String url)

Specified by:

setOriginalTrackingUrl in class ApplicationReport

setName

public void setName(String name)

Specified by:

setName in class ApplicationReport

setQueue

public void setQueue(String queue)

Specified by:

setQueue in class ApplicationReport

setYarnApplicationState

public void setYarnApplicationState(YarnApplicationState state)

Specified by:

setYarnApplicationState in class ApplicationReport

setHost

public void setHost(String host)

Specified by:

setHost in class ApplicationReport

setRpcPort

public void setRpcPort(int rpcPort)

Specified by:

setRpcPort in class ApplicationReport

setClientToAMToken

public void setClientToAMToken(Token clientToAMToken)

Specified by:

setClientToAMToken in class ApplicationReport

setUser

public void setUser(String user)

Specified by:

setUser in class ApplicationReport

setApplicationType

public void setApplicationType(String applicationType)

Specified by:

setApplicationType in class ApplicationReport

setDiagnostics

public void setDiagnostics(String diagnostics)

Specified by:

setDiagnostics in class ApplicationReport

setStartTime

public void setStartTime(long startTime)

Specified by:

setStartTime in class ApplicationReport

setFinishTime

public void setFinishTime(long finishTime)

Specified by:

setFinishTime in class ApplicationReport

setFinalApplicationStatus

public void setFinalApplicationStatus(FinalApplicationStatus finishState)

Specified by:

setFinalApplicationStatus in class ApplicationReport

setProgress

public void setProgress(float progress)

Specified by:

setProgress in class ApplicationReport

setAMRMToken

public void setAMRMToken(Token amRmToken)

Specified by:

setAMRMToken in class ApplicationReport

getProto

public YarnProtos.ApplicationReportProto getProto()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object