@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract class AHSClient
extends org.apache.hadoop.service.AbstractService
| Modifier and Type | Method and Description | 
|---|---|
| static AHSClient | createAHSClient()Create a new instance of AHSClient. | 
| static AHSClient | createAHSv2Client() | 
| abstract org.apache.hadoop.yarn.api.records.ApplicationAttemptReport | getApplicationAttemptReport(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId)
 Get a report of the given ApplicationAttempt. | 
| abstract List<org.apache.hadoop.yarn.api.records.ApplicationAttemptReport> | getApplicationAttempts(org.apache.hadoop.yarn.api.records.ApplicationId applicationId)
 Get a report of all (ApplicationAttempts) of Application in the cluster. | 
| abstract org.apache.hadoop.yarn.api.records.ApplicationReport | getApplicationReport(org.apache.hadoop.yarn.api.records.ApplicationId appId)Get a report of the given Application. | 
| abstract List<org.apache.hadoop.yarn.api.records.ApplicationReport> | getApplications()
 Get a report (ApplicationReport) of all Applications in the cluster. | 
| abstract org.apache.hadoop.yarn.api.records.ContainerReport | getContainerReport(org.apache.hadoop.yarn.api.records.ContainerId containerId)
 Get a report of the given Container. | 
| abstract List<org.apache.hadoop.yarn.api.records.ContainerReport> | getContainers(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId)
 Get a report of all (Containers) of ApplicationAttempt in the cluster. | 
close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, serviceInit, serviceStart, serviceStop, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop@InterfaceAudience.Private public AHSClient(String name)
@InterfaceAudience.Public public static AHSClient createAHSClient()
@InterfaceStability.Evolving @InterfaceAudience.Public public static AHSClient createAHSv2Client()
public abstract org.apache.hadoop.yarn.api.records.ApplicationReport getApplicationReport(org.apache.hadoop.yarn.api.records.ApplicationId appId)
                                                                                   throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                          IOException
 In secure mode, YARN verifies access to the application, queue
 etc. before accepting the request.
 
 If the user does not have VIEW_APP access then the following
 fields in the report will be set to stubbed values:
 
appId - ApplicationId of the application that needs a reportorg.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic abstract List<org.apache.hadoop.yarn.api.records.ApplicationReport> getApplications() throws org.apache.hadoop.yarn.exceptions.YarnException, IOException
Get a report (ApplicationReport) of all Applications in the cluster.
 If the user does not have VIEW_APP access for an application
 then the corresponding report will be filtered as described in
 getApplicationReport(ApplicationId).
 
org.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic abstract org.apache.hadoop.yarn.api.records.ApplicationAttemptReport getApplicationAttemptReport(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId)
                                                                                                 throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                        IOException
Get a report of the given ApplicationAttempt.
 In secure mode, YARN verifies access to the application, queue
 etc. before accepting the request.
 
applicationAttemptId - ApplicationAttemptId of the application attempt that needs
          a reportorg.apache.hadoop.yarn.exceptions.YarnExceptionorg.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException - if application attempt
         not foundIOExceptionpublic abstract List<org.apache.hadoop.yarn.api.records.ApplicationAttemptReport> getApplicationAttempts(org.apache.hadoop.yarn.api.records.ApplicationId applicationId) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException
Get a report of all (ApplicationAttempts) of Application in the cluster.
applicationId - org.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionpublic abstract org.apache.hadoop.yarn.api.records.ContainerReport getContainerReport(org.apache.hadoop.yarn.api.records.ContainerId containerId)
                                                                               throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                      IOException
Get a report of the given Container.
 In secure mode, YARN verifies access to the application, queue
 etc. before accepting the request.
 
containerId - ContainerId of the container that needs a reportorg.apache.hadoop.yarn.exceptions.YarnExceptionorg.apache.hadoop.yarn.exceptions.ContainerNotFoundException - if container not foundIOExceptionpublic abstract List<org.apache.hadoop.yarn.api.records.ContainerReport> getContainers(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException
Get a report of all (Containers) of ApplicationAttempt in the cluster.
applicationAttemptId - org.apache.hadoop.yarn.exceptions.YarnExceptionIOExceptionCopyright © 2008–2023 Apache Software Foundation. All rights reserved.