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

Class AHSv2ClientImpl

java.lang.Object

org.apache.hadoop.service.AbstractService

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

org.apache.hadoop.yarn.client.api.impl.AHSv2ClientImpl

All Implemented Interfaces:

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

@Private
@Unstable
public class AHSv2ClientImpl
extends AHSClient

This class provides Application History client implementation which uses ATS v2 as backend.

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
AHSv2ClientImpl()

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.yarn.api.records.ApplicationAttemptReport	getApplicationAttemptReport(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId)	Get a report of the given ApplicationAttempt.
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.
org.apache.hadoop.yarn.api.records.ApplicationReport	getApplicationReport(org.apache.hadoop.yarn.api.records.ApplicationId appId)	Get a report of the given Application.
java.util.List<org.apache.hadoop.yarn.api.records.ApplicationReport>	getApplications()	Get a report (ApplicationReport) of all Applications in the cluster.
org.apache.hadoop.yarn.api.records.ContainerReport	getContainerReport(org.apache.hadoop.yarn.api.records.ContainerId containerId)	Get a report of the given Container.
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.
void	serviceInit(org.apache.hadoop.conf.Configuration conf)
void	serviceStart()
void	serviceStop()
protected void	setReaderClient(org.apache.hadoop.yarn.client.api.TimelineReaderClient readerClient)

Methods inherited from class org.apache.hadoop.yarn.client.api.AHSClient

createAHSClient, createAHSv2Client

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, 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

AHSv2ClientImpl

public AHSv2ClientImpl()

Method Detail

serviceInit

public void serviceInit(org.apache.hadoop.conf.Configuration conf)

Overrides:

serviceInit in class org.apache.hadoop.service.AbstractService

setReaderClient

@VisibleForTesting
protected void setReaderClient(org.apache.hadoop.yarn.client.api.TimelineReaderClient readerClient)

serviceStart

public void serviceStart()

Overrides:

serviceStart in class org.apache.hadoop.service.AbstractService

serviceStop

public void serviceStop()

Overrides:

serviceStop in class org.apache.hadoop.service.AbstractService

getApplicationReport

public 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

Description copied from class: AHSClient

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

Specified by:

getApplicationReport in class AHSClient

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

Description copied from class: AHSClient

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 AHSClient.getApplicationReport(ApplicationId).

Specified by:

getApplications in class AHSClient

Returns:

a list of reports for all applications

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

java.io.IOException

getApplicationAttemptReport

public 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

Description copied from class: AHSClient

Get a report of the given ApplicationAttempt.

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

Specified by:

getApplicationAttemptReport in class AHSClient

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 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

Description copied from class: AHSClient

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

Specified by:

getApplicationAttempts in class AHSClient

Returns:

a list of reports for all application attempts for specified application

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

java.io.IOException

getContainerReport

public 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

Description copied from class: AHSClient

Get a report of the given Container.

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

Specified by:

getContainerReport in class AHSClient

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 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

Description copied from class: AHSClient

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

Specified by:

getContainers in class AHSClient

Returns:

a list of reports of all containers for specified application attempt

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

java.io.IOException