|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RMApp
The interface to an Application in the ResourceManager. Take a
look at RMAppImpl
for its implementation. This interface
exposes methods to access various updates in application status/report.
Method Summary | |
---|---|
org.apache.hadoop.yarn.api.records.ApplicationReport |
createAndGetApplicationReport(String clientUserName,
boolean allowAccess)
To get the status of an application in the RM, this method can be used. |
org.apache.hadoop.yarn.api.records.YarnApplicationState |
createApplicationState()
Create the external user-facing state of ApplicationMaster from the current state of the RMApp . |
Map<org.apache.hadoop.yarn.api.records.ApplicationAttemptId,RMAppAttempt> |
getAppAttempts()
RMApp can have multiple application attempts RMAppAttempt . |
org.apache.hadoop.yarn.api.records.ApplicationId |
getApplicationId()
The application id for this RMApp . |
org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext |
getApplicationSubmissionContext()
The application submission context for this RMApp |
String |
getApplicationType()
Returns the application type |
RMAppAttempt |
getCurrentAppAttempt()
RMApp can have multiple application attempts RMAppAttempt . |
StringBuilder |
getDiagnostics()
the diagnostics information for the application master. |
org.apache.hadoop.yarn.api.records.FinalApplicationStatus |
getFinalApplicationStatus()
The final finish state of the AM when unregistering as in FinishApplicationMasterRequest.setFinalApplicationStatus(FinalApplicationStatus) . |
long |
getFinishTime()
The finish time of the RMApp |
int |
getMaxAppAttempts()
The number of max attempts of the application. |
String |
getName()
The name of the application as set in ApplicationSubmissionContext.setApplicationName(String) . |
float |
getProgress()
Progress of application. |
String |
getQueue()
Each Application is submitted to a queue decided by ApplicationSubmissionContext.setQueue(String) . |
RMAppAttempt |
getRMAppAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)
RMApp can have multiple application attempts RMAppAttempt . |
long |
getStartTime()
the start time of the application. |
RMAppState |
getState()
The current state of the RMApp . |
long |
getSubmitTime()
the submit time of the application. |
String |
getTrackingUrl()
The tracking url for the application master. |
String |
getUser()
The user who submitted this application. |
boolean |
isAppSafeToUnregister()
Check whether this application is safe to unregister. |
int |
pullRMNodeUpdates(Collection<RMNode> updatedNodes)
To receive the collection of all RMNode s whose updates have been
received by the RMApp. |
void |
setQueue(String name)
Reflects a change in the application's queue from the one specified in the ApplicationSubmissionContext . |
Methods inherited from interface org.apache.hadoop.yarn.event.EventHandler |
---|
handle |
Method Detail |
---|
org.apache.hadoop.yarn.api.records.ApplicationId getApplicationId()
RMApp
.
ApplicationId
for this RMApp
.org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext getApplicationSubmissionContext()
RMApp
ApplicationSubmissionContext
for this RMApp
RMAppState getState()
RMApp
.
RMAppState
for this application.String getUser()
float getProgress()
RMApp
.RMAppAttempt getRMAppAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)
RMApp
can have multiple application attempts RMAppAttempt
.
This method returns the RMAppAttempt
corresponding to
ApplicationAttemptId
.
appAttemptId
- the application attempt id
RMAppAttempt
corresponding to the ApplicationAttemptId
.String getQueue()
ApplicationSubmissionContext.setQueue(String)
.
This method returns the queue to which an application was submitted.
void setQueue(String name)
ApplicationSubmissionContext
.
name
- the new queue nameString getName()
ApplicationSubmissionContext.setApplicationName(String)
.
RMAppAttempt getCurrentAppAttempt()
RMApp
can have multiple application attempts RMAppAttempt
.
This method returns the current RMAppAttempt
.
RMAppAttempt
Map<org.apache.hadoop.yarn.api.records.ApplicationAttemptId,RMAppAttempt> getAppAttempts()
RMApp
can have multiple application attempts RMAppAttempt
.
This method returns the all RMAppAttempt
s for the RMApp.
RMAppAttempt
s for the RMApp.org.apache.hadoop.yarn.api.records.ApplicationReport createAndGetApplicationReport(String clientUserName, boolean allowAccess)
clientUserName
- the user name of the client requesting the reportallowAccess
- whether to allow full access to the report
ApplicationReport
detailing the status of the application.int pullRMNodeUpdates(Collection<RMNode> updatedNodes)
RMNode
s whose updates have been
received by the RMApp. Updates can be node becoming lost or becoming
healthy etc. The method clears the information from the RMApp
. So
each call to this method gives the delta from the previous call.
updatedNodes
- Collection into which the updates are transferred
Collection
long getFinishTime()
RMApp
long getStartTime()
long getSubmitTime()
String getTrackingUrl()
StringBuilder getDiagnostics()
org.apache.hadoop.yarn.api.records.FinalApplicationStatus getFinalApplicationStatus()
FinishApplicationMasterRequest.setFinalApplicationStatus(FinalApplicationStatus)
.
FinishApplicationMasterRequest.setFinalApplicationStatus(FinalApplicationStatus)
.int getMaxAppAttempts()
String getApplicationType()
boolean isAppSafeToUnregister()
org.apache.hadoop.yarn.api.records.YarnApplicationState createApplicationState()
RMApp
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |