|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@InterfaceAudience.Public @InterfaceStability.Evolving public interface YarnClient
Method Summary | |
---|---|
List<QueueInfo> |
getAllQueues()
Get information ( QueueInfo ) about all queues, recursively if there
is a hierarchy |
List<ApplicationReport> |
getApplicationList()
Get a report (ApplicationReport) of all Applications in the cluster. |
ApplicationReport |
getApplicationReport(ApplicationId appId)
Get a report of the given Application. |
List<QueueInfo> |
getChildQueueInfos(String parent)
Get information ( QueueInfo ) about all the immediate children queues
of the given queue |
GetNewApplicationResponse |
getNewApplication()
Obtain a new ApplicationId for submitting new applications. |
List<NodeReport> |
getNodeReports()
Get a report of all nodes ( NodeReport ) in the cluster. |
List<QueueUserACLInfo> |
getQueueAclsInfo()
Get information about acls for current user on all the existing queues. |
QueueInfo |
getQueueInfo(String queueName)
Get information ( QueueInfo ) about a given queue. |
DelegationToken |
getRMDelegationToken(Text renewer)
Get a delegation token so as to be able to talk to YARN using those tokens. |
List<QueueInfo> |
getRootQueueInfos()
Get information ( QueueInfo ) about top level queues. |
YarnClusterMetrics |
getYarnClusterMetrics()
Get metrics ( YarnClusterMetrics ) about the cluster. |
void |
killApplication(ApplicationId applicationId)
Kill an application identified by given ID. |
ApplicationId |
submitApplication(ApplicationSubmissionContext appContext)
Submit a new application to YARN. |
Methods inherited from interface org.apache.hadoop.yarn.service.Service |
---|
getConfig, getName, getServiceState, getStartTime, init, register, start, stop, unregister |
Method Detail |
---|
GetNewApplicationResponse getNewApplication() throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
Obtain a new ApplicationId
for submitting new applications.
Returns a response which contains ApplicationId
that can be used to
submit a new application. See
submitApplication(ApplicationSubmissionContext)
.
See GetNewApplicationResponse
for other information that is
returned.
ApplicationId
to be used
to submit an application
org.apache.hadoop.yarn.exceptions.YarnRemoteException
ApplicationId submitApplication(ApplicationSubmissionContext appContext) throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
Submit a new application to YARN.
appContext
- ApplicationSubmissionContext
containing all the details
needed to submit a new application
ApplicationId
of the accepted application
org.apache.hadoop.yarn.exceptions.YarnRemoteException
getNewApplication()
void killApplication(ApplicationId applicationId) throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
Kill an application identified by given ID.
applicationId
- ApplicationId
of the application that needs to be killed
org.apache.hadoop.yarn.exceptions.YarnRemoteException
- in case of errors or if YARN rejects the request due to
access-control restrictions.getQueueAclsInfo()
ApplicationReport getApplicationReport(ApplicationId appId) throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
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 report
org.apache.hadoop.yarn.exceptions.YarnRemoteException
List<ApplicationReport> getApplicationList() throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
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.YarnRemoteException
YarnClusterMetrics getYarnClusterMetrics() throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
Get metrics (YarnClusterMetrics
) about the cluster.
org.apache.hadoop.yarn.exceptions.YarnRemoteException
List<NodeReport> getNodeReports() throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
Get a report of all nodes (NodeReport
) in the cluster.
org.apache.hadoop.yarn.exceptions.YarnRemoteException
DelegationToken getRMDelegationToken(Text renewer) throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
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.
DelegationToken
) that can be used to
talk to YARN
org.apache.hadoop.yarn.exceptions.YarnRemoteException
QueueInfo getQueueInfo(String queueName) throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
Get information (QueueInfo
) about a given queue.
queueName
- Name of the queue whose information is needed
org.apache.hadoop.yarn.exceptions.YarnRemoteException
- in case of errors or if YARN rejects the request due to
access-control restrictions.List<QueueInfo> getAllQueues() throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
Get information (QueueInfo
) about all queues, recursively if there
is a hierarchy
org.apache.hadoop.yarn.exceptions.YarnRemoteException
List<QueueInfo> getRootQueueInfos() throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
Get information (QueueInfo
) about top level queues.
org.apache.hadoop.yarn.exceptions.YarnRemoteException
List<QueueInfo> getChildQueueInfos(String parent) throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
Get information (QueueInfo
) about all the immediate children queues
of the given queue
parent
- Name of the queue whose child-queues' information is needed
org.apache.hadoop.yarn.exceptions.YarnRemoteException
List<QueueUserACLInfo> getQueueAclsInfo() throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
Get information about acls for current user on all the existing queues.
QueueUserACLInfo
) for
current user
org.apache.hadoop.yarn.exceptions.YarnRemoteException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |