org.apache.hadoop.yarn.client.api

Class YarnClient

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.yarn.client.api.YarnClient

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.service.Service

Direct Known Subclasses:

YarnClientImpl

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract class YarnClient
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

Modifier	Constructor and Description
protected	YarnClient(String name)

Method Summary

Methods

Modifier and Type	Method and Description
abstract YarnClientApplication	createApplication() Obtain a YarnClientApplication for a new application, which in turn contains the ApplicationSubmissionContext and GetNewApplicationResponse objects.
static YarnClient	createYarnClient() Create a new instance of YarnClient.
abstract org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse	deleteReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest request) The interface used by clients to remove an existing Reservation.
abstract List<org.apache.hadoop.yarn.api.records.QueueInfo>	getAllQueues() Get information (QueueInfo) about all queues, recursively if there is a hierarchy
abstract org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.AMRMTokenIdentifier>	getAMRMToken(org.apache.hadoop.yarn.api.records.ApplicationId appId) Get the AMRM token of the application.
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 List<org.apache.hadoop.yarn.api.records.ApplicationReport>	getApplications(EnumSet<org.apache.hadoop.yarn.api.records.YarnApplicationState> applicationStates) Get a report (ApplicationReport) of Applications matching the given application states in the cluster.
abstract List<org.apache.hadoop.yarn.api.records.ApplicationReport>	getApplications(Set<String> applicationTypes) Get a report (ApplicationReport) of Applications matching the given application types in the cluster.
abstract List<org.apache.hadoop.yarn.api.records.ApplicationReport>	getApplications(Set<String> applicationTypes, EnumSet<org.apache.hadoop.yarn.api.records.YarnApplicationState> applicationStates) Get a report (ApplicationReport) of Applications matching the given application types and application states in the cluster.
abstract List<org.apache.hadoop.yarn.api.records.QueueInfo>	getChildQueueInfos(String parent) Get information (QueueInfo) about all the immediate children queues of the given queue
abstract Set<String>	getClusterNodeLabels() The interface used by client to get node labels 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.
abstract List<org.apache.hadoop.yarn.api.records.NodeReport>	getNodeReports(org.apache.hadoop.yarn.api.records.NodeState... states) Get a report of nodes (NodeReport) in the cluster.
abstract Map<org.apache.hadoop.yarn.api.records.NodeId,Set<String>>	getNodeToLabels() The interface used by client to get node to labels mappings in existing cluster
abstract List<org.apache.hadoop.yarn.api.records.QueueUserACLInfo>	getQueueAclsInfo() Get information about acls for current user on all the existing queues.
abstract org.apache.hadoop.yarn.api.records.QueueInfo	getQueueInfo(String queueName) Get information (QueueInfo) about a given queue.
abstract org.apache.hadoop.yarn.api.records.Token	getRMDelegationToken(org.apache.hadoop.io.Text renewer) Get a delegation token so as to be able to talk to YARN using those tokens.
abstract List<org.apache.hadoop.yarn.api.records.QueueInfo>	getRootQueueInfos() Get information (QueueInfo) about top level queues.
abstract org.apache.hadoop.yarn.api.records.YarnClusterMetrics	getYarnClusterMetrics() Get metrics (YarnClusterMetrics) about the cluster.
abstract void	killApplication(org.apache.hadoop.yarn.api.records.ApplicationId applicationId) Kill an application identified by given ID.
abstract void	moveApplicationAcrossQueues(org.apache.hadoop.yarn.api.records.ApplicationId appId, String queue) Attempts to move the given application to the given queue.
abstract org.apache.hadoop.yarn.api.records.ApplicationId	submitApplication(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext appContext) Submit a new application to YARN. It is a blocking call - it will not return ApplicationId until the submitted application is submitted successfully and accepted by the ResourceManager.
abstract org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse	submitReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest request) The interface used by clients to submit a new reservation to the ResourceManager.
abstract org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse	updateReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest request) The interface used by clients to update an existing Reservation.

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

YarnClient

@InterfaceAudience.Private
protected YarnClient(String name)

Method Detail

createYarnClient

@InterfaceAudience.Public
public static YarnClient createYarnClient()

Create a new instance of YarnClient.

createApplication

public abstract YarnClientApplication createApplication()
                                                 throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                        IOException

Obtain a YarnClientApplication for a new application, which in turn contains the ApplicationSubmissionContext and GetNewApplicationResponse objects.

Returns:

YarnClientApplication built for a new application

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

submitApplication

public abstract org.apache.hadoop.yarn.api.records.ApplicationId submitApplication(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext appContext)
                                                                            throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                   IOException

Submit a new application to YARN. It is a blocking call - it will not return ApplicationId until the submitted application is submitted successfully and accepted by the ResourceManager.

Users should provide an ApplicationId as part of the parameter ApplicationSubmissionContext when submitting a new application, otherwise it will throw the ApplicationIdNotProvidedException.

This internally calls (SubmitApplicationRequest), and after that, it internally invokes (GetApplicationReportRequest) and waits till it can make sure that the application gets properly submitted. If RM fails over or RM restart happens before ResourceManager saves the application's state, #getApplicationReport(GetApplicationReportRequest) will throw the ApplicationNotFoundException. This API automatically resubmits the application with the same ApplicationSubmissionContext when it catches the ApplicationNotFoundException

Parameters:

appContext - ApplicationSubmissionContext containing all the details needed to submit a new application

Returns:

ApplicationId of the accepted application

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

See Also:

createApplication()

killApplication

public abstract void killApplication(org.apache.hadoop.yarn.api.records.ApplicationId applicationId)
                              throws org.apache.hadoop.yarn.exceptions.YarnException,
                                     IOException

Kill an application identified by given ID.

Parameters:

applicationId - ApplicationId of the application that needs to be killed

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - in case of errors or if YARN rejects the request due to access-control restrictions.

IOException

See Also:

getQueueAclsInfo()

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

IOException

getAMRMToken

public abstract org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.AMRMTokenIdentifier> getAMRMToken(org.apache.hadoop.yarn.api.records.ApplicationId appId)
                                                                                                                  throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                                         IOException

Get the AMRM token of the application.

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:

the requester is the owner of the ApplicationMaster

the application master is an unmanaged ApplicationMaster

the application master is in ACCEPTED state

Else this method returns NULL.

Parameters:

appId - ApplicationId of the application to get the AMRM token

Returns:

the AMRM token if available

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getApplications

public 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).

Returns:

a list of reports of all running applications

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getApplications

public abstract List<org.apache.hadoop.yarn.api.records.ApplicationReport> getApplications(Set<String> applicationTypes)
                                                                                    throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                           IOException

Get a report (ApplicationReport) of Applications matching the given application types 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).

Parameters:

applicationTypes -

Returns:

a list of reports of applications

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getApplications

public abstract List<org.apache.hadoop.yarn.api.records.ApplicationReport> getApplications(EnumSet<org.apache.hadoop.yarn.api.records.YarnApplicationState> applicationStates)
                                                                                    throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                           IOException

Get a report (ApplicationReport) of Applications matching the given application states 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).

Parameters:

applicationStates -

Returns:

a list of reports of applications

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getApplications

public abstract List<org.apache.hadoop.yarn.api.records.ApplicationReport> getApplications(Set<String> applicationTypes,
                                                                         EnumSet<org.apache.hadoop.yarn.api.records.YarnApplicationState> applicationStates)
                                                                                    throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                           IOException

Get a report (ApplicationReport) of Applications matching the given application types and application states 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).

Parameters:

applicationTypes -

applicationStates -

Returns:

a list of reports of applications

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getYarnClusterMetrics

public abstract org.apache.hadoop.yarn.api.records.YarnClusterMetrics getYarnClusterMetrics()
                                                                                     throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                            IOException

Get metrics (YarnClusterMetrics) about the cluster.

Returns:

cluster metrics

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getNodeReports

public abstract List<org.apache.hadoop.yarn.api.records.NodeReport> getNodeReports(org.apache.hadoop.yarn.api.records.NodeState... states)
                                                                            throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                   IOException

Get a report of nodes (NodeReport) in the cluster.

Parameters:

states - The NodeStates to filter on. If no filter states are given, nodes in all states will be returned.

Returns:

A list of node reports

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getRMDelegationToken

public abstract org.apache.hadoop.yarn.api.records.Token getRMDelegationToken(org.apache.hadoop.io.Text renewer)
                                                                       throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                              IOException

Get a delegation token so as to be able to talk to YARN using those tokens.

Parameters:

renewer - Address of the renewer who can renew these tokens when needed by securely talking to YARN.

Returns:

a delegation token (Token) that can be used to talk to YARN

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getQueueInfo

public abstract org.apache.hadoop.yarn.api.records.QueueInfo getQueueInfo(String queueName)
                                                                   throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                          IOException

Get information (QueueInfo) about a given queue.

Parameters:

queueName - Name of the queue whose information is needed

Returns:

queue information

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - in case of errors or if YARN rejects the request due to access-control restrictions.

IOException

getAllQueues

public abstract List<org.apache.hadoop.yarn.api.records.QueueInfo> getAllQueues()
                                                                         throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                IOException

Get information (QueueInfo) about all queues, recursively if there is a hierarchy

Returns:

a list of queue-information for all queues

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getRootQueueInfos

public abstract List<org.apache.hadoop.yarn.api.records.QueueInfo> getRootQueueInfos()
                                                                              throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                     IOException

Get information (QueueInfo) about top level queues.

Returns:

a list of queue-information for all the top-level queues

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getChildQueueInfos

public abstract List<org.apache.hadoop.yarn.api.records.QueueInfo> getChildQueueInfos(String parent)
                                                                               throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                      IOException

Get information (QueueInfo) about all the immediate children queues of the given queue

Parameters:

parent - Name of the queue whose child-queues' information is needed

Returns:

a list of queue-information for all queues who are direct children of the given parent queue.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getQueueAclsInfo

public abstract List<org.apache.hadoop.yarn.api.records.QueueUserACLInfo> getQueueAclsInfo()
                                                                                    throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                           IOException

Get information about acls for current user on all the existing queues.

Returns:

a list of queue acls (QueueUserACLInfo) for current user

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

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

{@link - ApplicationAttemptNotFoundException} if application attempt not found

IOException

getApplicationAttempts

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

Parameters:

applicationId -

Returns:

a list of reports for all application attempts for specified application.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

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

{@link - ContainerNotFoundException} if container not found.

IOException

getContainers

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

Parameters:

applicationAttemptId -

Returns:

a list of reports of all containers for specified application attempts

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

moveApplicationAcrossQueues

public abstract void moveApplicationAcrossQueues(org.apache.hadoop.yarn.api.records.ApplicationId appId,
                               String queue)
                                          throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                 IOException

Attempts to move the given application to the given queue.

Parameters:

appId - Application to move.

queue - Queue to place it in to.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

submitReservation

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse submitReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest request)
                                                                                                    throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                           IOException

The interface used by clients to submit a new reservation to the ResourceManager.

The client packages all details of its request in a ReservationSubmissionRequest object. This contains information about the amount of capacity, temporal constraints, and gang needs. Furthermore, the reservation might be composed of multiple stages, with ordering dependencies among them.

In order to respond, a new admission control component in the ResourceManager performs an analysis of the resources that have been committed over the period of time the user is requesting, verify that the user requests can be fulfilled, and that it respect a sharing policy (e.g., CapacityOverTimePolicy). Once it has positively determined that the ReservationRequest is satisfiable the ResourceManager answers with a ReservationSubmissionResponse that includes a ReservationId. Upon failure to find a valid allocation the response is an exception with the message detailing the reason of failure.

The semantics guarantees that the ReservationId returned, corresponds to a valid reservation existing in the time-range request by the user. The amount of capacity dedicated to such reservation can vary overtime, depending of the allocation that has been determined. But it is guaranteed to satisfy all the constraint expressed by the user in the ReservationDefinition

Parameters:

request - request to submit a new Reservation

Returns:

response contains the ReservationId on accepting the submission

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the reservation cannot be created successfully

IOException

updateReservation

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse updateReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest request)
                                                                                                throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                       IOException

The interface used by clients to update an existing Reservation. This is referred to as a re-negotiation process, in which a user that has previously submitted a Reservation.

The allocation is attempted by virtually substituting all previous allocations related to this Reservation with new ones, that satisfy the new ReservationDefinition. Upon success the previous allocation is atomically substituted by the new one, and on failure (i.e., if the system cannot find a valid allocation for the updated request), the previous allocation remains valid.

Parameters:

request - to update an existing Reservation (the ReservationUpdateRequest should refer to an existing valid ReservationId)

Returns:

response empty on successfully updating the existing reservation

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid or reservation cannot be updated successfully

IOException

deleteReservation

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse deleteReservation(org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest request)
                                                                                                throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                                       IOException

The interface used by clients to remove an existing Reservation.

Parameters:

request - to remove an existing Reservation (the ReservationDeleteRequest should refer to an existing valid ReservationId)

Returns:

response empty on successfully deleting the existing reservation

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid or reservation cannot be deleted successfully

IOException

getNodeToLabels

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract Map<org.apache.hadoop.yarn.api.records.NodeId,Set<String>> getNodeToLabels()
                                                                                    throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                           IOException

The interface used by client to get node to labels mappings in existing cluster

Returns:

node to labels mappings

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getClusterNodeLabels

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract Set<String> getClusterNodeLabels()
                                          throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                 IOException

The interface used by client to get node labels in the cluster

Returns:

cluster node labels collection

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException