public interface RMApp extends org.apache.hadoop.yarn.event.EventHandler<RMAppEvent>
RMAppImpl
for its implementation. This interface
exposes methods to access various updates in application status/report.Modifier and Type | Method and Description |
---|---|
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 . |
String |
getAmNodeLabelExpression()
Return the node label expression of the AM container.
|
org.apache.hadoop.yarn.api.records.ResourceRequest |
getAMResourceRequest() |
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 |
Set<String> |
getApplicationTags()
Get tags for the application
|
String |
getApplicationType()
Returns the application type
|
String |
getAppNodeLabelExpression() |
org.apache.hadoop.ipc.CallerContext |
getCallerContext() |
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 |
Map<org.apache.hadoop.yarn.api.records.NodeId,org.apache.hadoop.yarn.server.api.protocolrecords.LogAggregationReport> |
getLogAggregationReportsForApp() |
org.apache.hadoop.yarn.api.records.LogAggregationStatus |
getLogAggregationStatusForAppReport() |
int |
getMaxAppAttempts()
The number of max attempts of the application.
|
String |
getName()
The name of the application as set in
ApplicationSubmissionContext.setApplicationName(String) . |
String |
getOriginalTrackingUrl()
The original tracking url for the application master.
|
float |
getProgress()
Progress of application.
|
String |
getQueue()
Each Application is submitted to a queue decided by
ApplicationSubmissionContext.setQueue(String) . |
Set<org.apache.hadoop.yarn.api.records.NodeId> |
getRanNodes()
Nodes on which the containers for this
RMApp ran. |
org.apache.hadoop.yarn.api.records.ReservationId |
getReservationId() |
RMAppAttempt |
getRMAppAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)
RMApp can have multiple application attempts RMAppAttempt . |
RMAppMetrics |
getRMAppMetrics()
Get RMAppMetrics of the
RMApp . |
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 |
isAppFinalStateStored()
Check whether this application's state has been saved to the state store.
|
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 . |
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 idRMAppAttempt
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 reportApplicationReport
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 transferredCollection
long getFinishTime()
RMApp
long getStartTime()
long getSubmitTime()
String getTrackingUrl()
String getOriginalTrackingUrl()
StringBuilder getDiagnostics()
org.apache.hadoop.yarn.api.records.FinalApplicationStatus getFinalApplicationStatus()
FinishApplicationMasterRequest.setFinalApplicationStatus(FinalApplicationStatus)
.FinishApplicationMasterRequest.setFinalApplicationStatus(FinalApplicationStatus)
.int getMaxAppAttempts()
String getApplicationType()
Set<String> getApplicationTags()
boolean isAppFinalStateStored()
Set<org.apache.hadoop.yarn.api.records.NodeId> getRanNodes()
RMApp
ran.org.apache.hadoop.yarn.api.records.YarnApplicationState createApplicationState()
RMApp
.RMAppMetrics getRMAppMetrics()
RMApp
.org.apache.hadoop.yarn.api.records.ReservationId getReservationId()
org.apache.hadoop.yarn.api.records.ResourceRequest getAMResourceRequest()
Map<org.apache.hadoop.yarn.api.records.NodeId,org.apache.hadoop.yarn.server.api.protocolrecords.LogAggregationReport> getLogAggregationReportsForApp()
org.apache.hadoop.yarn.api.records.LogAggregationStatus getLogAggregationStatusForAppReport()
String getAmNodeLabelExpression()
String getAppNodeLabelExpression()
org.apache.hadoop.ipc.CallerContext getCallerContext()
Copyright © 2017 Apache Software Foundation. All Rights Reserved.