@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract class YarnClient
extends org.apache.hadoop.service.AbstractService
Modifier | Constructor and Description |
---|---|
protected |
YarnClient(String name) |
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 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 List<org.apache.hadoop.yarn.api.records.NodeToLabelsList> |
getClusterNodeLabels()
Get labels for nodes 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 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 boolean |
refreshClusterNodeLabels()
Refresh labels for nodes in the cluster
|
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. |
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 protected YarnClient(String name)
@InterfaceAudience.Public public static YarnClient createYarnClient()
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.
YarnClientApplication
built for a new applicationorg.apache.hadoop.yarn.exceptions.YarnException
IOException
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
appContext
- ApplicationSubmissionContext
containing all the details
needed to submit a new applicationApplicationId
of the accepted applicationorg.apache.hadoop.yarn.exceptions.YarnException
IOException
createApplication()
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.
applicationId
- ApplicationId
of the application that needs to be killedorg.apache.hadoop.yarn.exceptions.YarnException
- in case of errors or if YARN rejects the request due to
access-control restrictions.IOException
getQueueAclsInfo()
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:
appId
- ApplicationId
of the application that needs a reportorg.apache.hadoop.yarn.exceptions.YarnException
IOException
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
UserGroupInformation
of the
current user.
The AMRM token will be returned only if all the following conditions are
met:
appId
- ApplicationId
of the application to get the AMRM tokenorg.apache.hadoop.yarn.exceptions.YarnException
IOException
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)
.
org.apache.hadoop.yarn.exceptions.YarnException
IOException
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)
.
applicationTypes
- org.apache.hadoop.yarn.exceptions.YarnException
IOException
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)
.
applicationStates
- org.apache.hadoop.yarn.exceptions.YarnException
IOException
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)
.
applicationTypes
- applicationStates
- org.apache.hadoop.yarn.exceptions.YarnException
IOException
public abstract org.apache.hadoop.yarn.api.records.YarnClusterMetrics getYarnClusterMetrics() throws org.apache.hadoop.yarn.exceptions.YarnException, IOException
Get metrics (YarnClusterMetrics
) about the cluster.
org.apache.hadoop.yarn.exceptions.YarnException
IOException
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.
states
- The NodeState
s to filter on. If no filter states are
given, nodes in all states will be returned.org.apache.hadoop.yarn.exceptions.YarnException
IOException
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.
renewer
- Address of the renewer who can renew these tokens when needed by
securely talking to YARN.Token
) that can be used to
talk to YARNorg.apache.hadoop.yarn.exceptions.YarnException
IOException
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.
queueName
- Name of the queue whose information is neededorg.apache.hadoop.yarn.exceptions.YarnException
- in case of errors or if YARN rejects the request due to
access-control restrictions.IOException
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
org.apache.hadoop.yarn.exceptions.YarnException
IOException
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.
org.apache.hadoop.yarn.exceptions.YarnException
IOException
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
parent
- Name of the queue whose child-queues' information is neededorg.apache.hadoop.yarn.exceptions.YarnException
IOException
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.
QueueUserACLInfo
) for
current userorg.apache.hadoop.yarn.exceptions.YarnException
IOException
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.
applicationAttemptId
- ApplicationAttemptId
of the application attempt that needs
a reportorg.apache.hadoop.yarn.exceptions.YarnException
{@link
- ApplicationAttemptNotFoundException} if application attempt
not foundIOException
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.
applicationId
- org.apache.hadoop.yarn.exceptions.YarnException
IOException
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.
containerId
- ContainerId
of the container that needs a reportorg.apache.hadoop.yarn.exceptions.YarnException
{@link
- ContainerNotFoundException} if container not found.IOException
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.
applicationAttemptId
- org.apache.hadoop.yarn.exceptions.YarnException
IOException
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.
appId
- Application to move.queue
- Queue to place it in to.org.apache.hadoop.yarn.exceptions.YarnException
IOException
public abstract boolean refreshClusterNodeLabels() throws org.apache.hadoop.yarn.exceptions.YarnException, IOException
Refresh labels for nodes in the cluster
org.apache.hadoop.yarn.exceptions.YarnException
IOException
public abstract List<org.apache.hadoop.yarn.api.records.NodeToLabelsList> getClusterNodeLabels() throws org.apache.hadoop.yarn.exceptions.YarnException, IOException
Get labels for nodes in the cluster
org.apache.hadoop.yarn.exceptions.YarnException
IOException
Copyright © 2014 Apache Software Foundation. All Rights Reserved.