Package org.apache.hadoop.yarn.client.api

Class AHSClient

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.yarn.client.api.AHSClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.hadoop.service.Service

Direct Known Subclasses:

AHSClientImpl, AHSv2ClientImpl

@Public
@Stable
public abstract class AHSClient
extends org.apache.hadoop.service.AbstractService

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Constructor Summary

Constructors

Constructor	Description
AHSClient(java.lang.String name)

Method Summary

Modifier and Type	Method	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 java.util.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 java.util.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 java.util.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.

Methods inherited from class org.apache.hadoop.service.AbstractService

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AHSClient

@Private
public AHSClient(java.lang.String name)

Method Detail

createAHSClient

@Public
public static AHSClient createAHSClient()

Create a new instance of AHSClient.

createAHSv2Client

@Evolving
@Public
public static AHSClient createAHSv2Client()

getApplicationReport

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,
                                                                                          java.io.IOException

Get a report of the given Application.

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:

• host - set to "N/A"
• RPC port - set to -1
• client token - set to "N/A"
• diagnostics - set to "N/A"
• tracking URL - set to "N/A"
• original tracking URL - set to "N/A"
• resource usage report - all values are -1

Parameters:

appId - ApplicationId of the application that needs a report

Returns:

application report

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

java.io.IOException

getApplications

public abstract java.util.List<org.apache.hadoop.yarn.api.records.ApplicationReport> getApplications()
                                                                                              throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                     java.io.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).

Returns:

a list of reports for all applications

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

java.io.IOException

getApplicationAttemptReport

public abstract org.apache.hadoop.yarn.api.records.ApplicationAttemptReport getApplicationAttemptReport(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId)
                                                                                                 throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                        java.io.IOException

Get a report of the given ApplicationAttempt.

In secure mode, YARN verifies access to the application, queue etc. before accepting the request.

Parameters:

applicationAttemptId - ApplicationAttemptId of the application attempt that needs a report

Returns:

application attempt report

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException - if application attempt not found

java.io.IOException

getApplicationAttempts

public abstract java.util.List<org.apache.hadoop.yarn.api.records.ApplicationAttemptReport> getApplicationAttempts(org.apache.hadoop.yarn.api.records.ApplicationId applicationId)
                                                                                                            throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                                   java.io.IOException

Get a report of all (ApplicationAttempts) of Application in the cluster.

Parameters:

applicationId -

Returns:

a list of reports for all application attempts for specified application

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

java.io.IOException

getContainerReport

public abstract org.apache.hadoop.yarn.api.records.ContainerReport getContainerReport(org.apache.hadoop.yarn.api.records.ContainerId containerId)
                                                                               throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                      java.io.IOException

Get a report of the given Container.

In secure mode, YARN verifies access to the application, queue etc. before accepting the request.

Parameters:

containerId - ContainerId of the container that needs a report

Returns:

container report

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

org.apache.hadoop.yarn.exceptions.ContainerNotFoundException - if container not found

java.io.IOException

getContainers

public abstract java.util.List<org.apache.hadoop.yarn.api.records.ContainerReport> getContainers(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId)
                                                                                          throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                 java.io.IOException

Get a report of all (Containers) of ApplicationAttempt in the cluster.

Parameters:

applicationAttemptId -

Returns:

a list of reports of all containers for specified application attempt

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

java.io.IOException