@InterfaceAudience.Public @InterfaceStability.Stable public abstract class ApplicationReport extends Object
ApplicationReport
is a report of an application.
It includes details such as:
ApplicationId
of the application.ApplicationMaster
is running.ApplicationMaster
.YarnApplicationState
of the application.Token
of the application (if security is enabled).Constructor and Description |
---|
ApplicationReport() |
Modifier and Type | Method and Description |
---|---|
abstract String |
getAmNodeLabelExpression()
Get the default Node Label expression for all the application's containers
|
abstract Token |
getAMRMToken()
Get the AMRM token of the application.
|
abstract ApplicationId |
getApplicationId()
Get the
ApplicationId of the application. |
abstract ApplicationResourceUsageReport |
getApplicationResourceUsageReport()
Retrieve the structure containing the job resources for this application
|
abstract Set<String> |
getApplicationTags()
Get all tags corresponding to the application
|
abstract Map<ApplicationTimeoutType,ApplicationTimeout> |
getApplicationTimeouts() |
abstract String |
getApplicationType()
Get the application's Type
|
abstract String |
getAppNodeLabelExpression()
Get the default Node Label expression for all the application's containers
|
abstract Token |
getClientToAMToken()
Get the client token for communicating with the
ApplicationMaster . |
abstract ApplicationAttemptId |
getCurrentApplicationAttemptId()
Get the
ApplicationAttemptId of the current
attempt of the application |
abstract String |
getDiagnostics()
Get the diagnositic information of the application in case of
errors.
|
abstract FinalApplicationStatus |
getFinalApplicationStatus()
Get the final finish status of the application.
|
abstract long |
getFinishTime()
Get the finish time of the application.
|
abstract String |
getHost()
Get the host on which the
ApplicationMaster
is running. |
abstract long |
getLaunchTime() |
abstract LogAggregationStatus |
getLogAggregationStatus()
Get log aggregation status for the application
|
abstract String |
getName()
Get the user-defined name of the application.
|
abstract String |
getOriginalTrackingUrl()
Get the original not-proxied tracking url for the application.
|
abstract Priority |
getPriority()
Get priority of the application
|
abstract float |
getProgress()
Get the application's progress ( range 0.0 to 1.0 )
|
abstract String |
getQueue()
Get the queue to which the application was submitted.
|
abstract String |
getRMClusterId()
Get RM ClusterId.
|
abstract int |
getRpcPort()
Get the RPC port of the
ApplicationMaster . |
abstract long |
getStartTime()
Get the start time of the application.
|
abstract long |
getSubmitTime() |
abstract String |
getTrackingUrl()
Get the tracking url for the application.
|
abstract String |
getUser()
Get the user who submitted the application.
|
abstract YarnApplicationState |
getYarnApplicationState()
Get the
YarnApplicationState of the application. |
abstract boolean |
isUnmanagedApp() |
static ApplicationReport |
newInstance(ApplicationId applicationId,
ApplicationAttemptId applicationAttemptId,
String user,
String queue,
String name,
String host,
int rpcPort,
Token clientToAMToken,
YarnApplicationState state,
String diagnostics,
String url,
long startTime,
long finishTime,
FinalApplicationStatus finalStatus,
ApplicationResourceUsageReport appResources,
String origTrackingUrl,
float progress,
String applicationType,
Token amRmToken,
Set<String> tags,
boolean unmanagedApplication,
Priority priority,
String appNodeLabelExpression,
String amNodeLabelExpression) |
static ApplicationReport |
newInstance(ApplicationId applicationId,
ApplicationAttemptId applicationAttemptId,
String user,
String queue,
String name,
String host,
int rpcPort,
Token clientToAMToken,
YarnApplicationState state,
String diagnostics,
String url,
long startTime,
long launchTime,
long finishTime,
FinalApplicationStatus finalStatus,
ApplicationResourceUsageReport appResources,
String origTrackingUrl,
float progress,
String applicationType,
Token amRmToken) |
static ApplicationReport |
newInstance(ApplicationId applicationId,
ApplicationAttemptId applicationAttemptId,
String user,
String queue,
String name,
String host,
int rpcPort,
Token clientToAMToken,
YarnApplicationState state,
String diagnostics,
String url,
long startTime,
long launchTime,
long finishTime,
FinalApplicationStatus finalStatus,
ApplicationResourceUsageReport appResources,
String origTrackingUrl,
float progress,
String applicationType,
Token amRmToken,
Set<String> tags,
boolean unmanagedApplication,
Priority priority,
String appNodeLabelExpression,
String amNodeLabelExpression) |
static ApplicationReport |
newInstance(ApplicationId applicationId,
ApplicationAttemptId applicationAttemptId,
String user,
String queue,
String name,
String host,
int rpcPort,
Token clientToAMToken,
YarnApplicationState state,
String diagnostics,
String url,
long startTime,
long submitTime,
long launchTime,
long finishTime,
FinalApplicationStatus finalStatus,
ApplicationResourceUsageReport appResources,
String origTrackingUrl,
float progress,
String applicationType,
Token amRmToken) |
static ApplicationReport |
newInstance(ApplicationId applicationId,
ApplicationAttemptId applicationAttemptId,
String user,
String queue,
String name,
String host,
int rpcPort,
Token clientToAMToken,
YarnApplicationState state,
String diagnostics,
String url,
long startTime,
long submitTime,
long launchTime,
long finishTime,
FinalApplicationStatus finalStatus,
ApplicationResourceUsageReport appResources,
String origTrackingUrl,
float progress,
String applicationType,
Token amRmToken,
Set<String> tags,
boolean unmanagedApplication,
Priority priority,
String appNodeLabelExpression,
String amNodeLabelExpression) |
abstract void |
setAmNodeLabelExpression(String amNodeLabelExpression) |
abstract void |
setAMRMToken(Token amRmToken) |
abstract void |
setApplicationId(ApplicationId applicationId) |
abstract void |
setApplicationResourceUsageReport(ApplicationResourceUsageReport appResources)
Store the structure containing the job resources for this application
|
abstract void |
setApplicationTags(Set<String> tags) |
abstract void |
setApplicationTimeouts(Map<ApplicationTimeoutType,ApplicationTimeout> timeouts) |
abstract void |
setApplicationType(String applicationType) |
abstract void |
setAppNodeLabelExpression(String appNodeLabelExpression) |
abstract void |
setClientToAMToken(Token clientToAMToken) |
abstract void |
setCurrentApplicationAttemptId(ApplicationAttemptId applicationAttemptId) |
abstract void |
setDiagnostics(String diagnostics) |
abstract void |
setFinalApplicationStatus(FinalApplicationStatus finishState) |
abstract void |
setFinishTime(long finishTime) |
abstract void |
setHost(String host) |
abstract void |
setLaunchTime(long setLaunchTime) |
abstract void |
setLogAggregationStatus(LogAggregationStatus logAggregationStatus) |
abstract void |
setName(String name) |
abstract void |
setOriginalTrackingUrl(String url) |
abstract void |
setPriority(Priority priority) |
abstract void |
setProgress(float progress) |
abstract void |
setQueue(String queue) |
abstract void |
setRMClusterId(String rmClusterId) |
abstract void |
setRpcPort(int rpcPort) |
abstract void |
setStartTime(long startTime) |
abstract void |
setSubmitTime(long submitTime) |
abstract void |
setTrackingUrl(String url) |
abstract void |
setUnmanagedApp(boolean unmanagedApplication) |
abstract void |
setUser(String user) |
abstract void |
setYarnApplicationState(YarnApplicationState state) |
@InterfaceAudience.Private @InterfaceStability.Unstable public static ApplicationReport newInstance(ApplicationId applicationId, ApplicationAttemptId applicationAttemptId, String user, String queue, String name, String host, int rpcPort, Token clientToAMToken, YarnApplicationState state, String diagnostics, String url, long startTime, long launchTime, long finishTime, FinalApplicationStatus finalStatus, ApplicationResourceUsageReport appResources, String origTrackingUrl, float progress, String applicationType, Token amRmToken)
@InterfaceAudience.Private @InterfaceStability.Unstable public static ApplicationReport newInstance(ApplicationId applicationId, ApplicationAttemptId applicationAttemptId, String user, String queue, String name, String host, int rpcPort, Token clientToAMToken, YarnApplicationState state, String diagnostics, String url, long startTime, long submitTime, long launchTime, long finishTime, FinalApplicationStatus finalStatus, ApplicationResourceUsageReport appResources, String origTrackingUrl, float progress, String applicationType, Token amRmToken)
@InterfaceAudience.Private @InterfaceStability.Unstable public static ApplicationReport newInstance(ApplicationId applicationId, ApplicationAttemptId applicationAttemptId, String user, String queue, String name, String host, int rpcPort, Token clientToAMToken, YarnApplicationState state, String diagnostics, String url, long startTime, long finishTime, FinalApplicationStatus finalStatus, ApplicationResourceUsageReport appResources, String origTrackingUrl, float progress, String applicationType, Token amRmToken, Set<String> tags, boolean unmanagedApplication, Priority priority, String appNodeLabelExpression, String amNodeLabelExpression)
@InterfaceAudience.Private @InterfaceStability.Unstable public static ApplicationReport newInstance(ApplicationId applicationId, ApplicationAttemptId applicationAttemptId, String user, String queue, String name, String host, int rpcPort, Token clientToAMToken, YarnApplicationState state, String diagnostics, String url, long startTime, long launchTime, long finishTime, FinalApplicationStatus finalStatus, ApplicationResourceUsageReport appResources, String origTrackingUrl, float progress, String applicationType, Token amRmToken, Set<String> tags, boolean unmanagedApplication, Priority priority, String appNodeLabelExpression, String amNodeLabelExpression)
@InterfaceAudience.Private @InterfaceStability.Unstable public static ApplicationReport newInstance(ApplicationId applicationId, ApplicationAttemptId applicationAttemptId, String user, String queue, String name, String host, int rpcPort, Token clientToAMToken, YarnApplicationState state, String diagnostics, String url, long startTime, long submitTime, long launchTime, long finishTime, FinalApplicationStatus finalStatus, ApplicationResourceUsageReport appResources, String origTrackingUrl, float progress, String applicationType, Token amRmToken, Set<String> tags, boolean unmanagedApplication, Priority priority, String appNodeLabelExpression, String amNodeLabelExpression)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract ApplicationId getApplicationId()
ApplicationId
of the application.ApplicationId
of the application@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setApplicationId(ApplicationId applicationId)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract ApplicationAttemptId getCurrentApplicationAttemptId()
ApplicationAttemptId
of the current
attempt of the applicationApplicationAttemptId
of the attempt@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setCurrentApplicationAttemptId(ApplicationAttemptId applicationAttemptId)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract String getUser()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setUser(String user)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract String getQueue()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setQueue(String queue)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract String getName()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setName(String name)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract String getHost()
ApplicationMaster
is running.ApplicationMaster
is running@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setHost(String host)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract int getRpcPort()
ApplicationMaster
.ApplicationMaster
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setRpcPort(int rpcPort)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract Token getClientToAMToken()
ApplicationMaster
.
ClientToAMToken is the security token used by the AMs to verify
authenticity of any client
.
The ResourceManager
, provides a secure token (via
getClientToAMToken()
) which is verified by the
ApplicationMaster when the client directly talks to an AM.
ApplicationMaster
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setClientToAMToken(Token clientToAMToken)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract YarnApplicationState getYarnApplicationState()
YarnApplicationState
of the application.YarnApplicationState
of the application@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setYarnApplicationState(YarnApplicationState state)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract String getDiagnostics()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setDiagnostics(String diagnostics)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract String getTrackingUrl()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setTrackingUrl(String url)
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract String getOriginalTrackingUrl()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setOriginalTrackingUrl(String url)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract long getStartTime()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setStartTime(long startTime)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract long getSubmitTime()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setSubmitTime(long submitTime)
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setLaunchTime(long setLaunchTime)
@InterfaceAudience.Public @InterfaceStability.Unstable public abstract long getLaunchTime()
@InterfaceAudience.Public @InterfaceStability.Stable public abstract long getFinishTime()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setFinishTime(long finishTime)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract FinalApplicationStatus getFinalApplicationStatus()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setFinalApplicationStatus(FinalApplicationStatus finishState)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract ApplicationResourceUsageReport getApplicationResourceUsageReport()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setApplicationResourceUsageReport(ApplicationResourceUsageReport appResources)
appResources
- structure for this application@InterfaceAudience.Public @InterfaceStability.Stable public abstract float getProgress()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setProgress(float progress)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract String getApplicationType()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setApplicationType(String applicationType)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract Set<String> getApplicationTags()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setApplicationTags(Set<String> tags)
@InterfaceAudience.Private @InterfaceStability.Stable public abstract void setAMRMToken(Token amRmToken)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract Token getAMRMToken()
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:
@InterfaceAudience.Public @InterfaceStability.Stable public abstract LogAggregationStatus getLogAggregationStatus()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setLogAggregationStatus(LogAggregationStatus logAggregationStatus)
@InterfaceAudience.Public @InterfaceStability.Unstable public abstract boolean isUnmanagedApp()
@InterfaceAudience.Public @InterfaceStability.Unstable public abstract void setUnmanagedApp(boolean unmanagedApplication)
unmanagedApplication
- true if RM should not manage the AM@InterfaceAudience.Public @InterfaceStability.Stable public abstract Priority getPriority()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setPriority(Priority priority)
@InterfaceStability.Unstable public abstract String getAppNodeLabelExpression()
@InterfaceStability.Unstable public abstract void setAppNodeLabelExpression(String appNodeLabelExpression)
@InterfaceStability.Unstable public abstract String getAmNodeLabelExpression()
@InterfaceStability.Unstable public abstract void setAmNodeLabelExpression(String amNodeLabelExpression)
@InterfaceAudience.Public @InterfaceStability.Unstable public abstract Map<ApplicationTimeoutType,ApplicationTimeout> getApplicationTimeouts()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setApplicationTimeouts(Map<ApplicationTimeoutType,ApplicationTimeout> timeouts)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract String getRMClusterId()
@InterfaceAudience.Public @InterfaceStability.Stable public abstract void setRMClusterId(String rmClusterId)
Copyright © 2008–2024 Apache Software Foundation. All rights reserved.