Package 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
@Public @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
    Description
    protected
    YarnClient(String name)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract YarnClientApplication
    createApplication()
    Obtain a YarnClientApplication for a new application, which in turn contains the ApplicationSubmissionContext and GetNewApplicationResponse objects.
    abstract org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse
    createReservation()
    Obtain a GetNewReservationResponse for a new reservation, which contains the ReservationId object.
    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 void
    failApplicationAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId)
    Fail an application attempt identified by given ID.
    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.ApplicationReport>
    getApplications(Set<String> applicationTypes, EnumSet<org.apache.hadoop.yarn.api.records.YarnApplicationState> applicationStates, Set<String> applicationTags)
    Get a report (ApplicationReport) of Applications matching the given application types, application states and application tags in the cluster.
    abstract List<org.apache.hadoop.yarn.api.records.ApplicationReport>
    getApplications(Set<String> queues, Set<String> users, Set<String> applicationTypes, EnumSet<org.apache.hadoop.yarn.api.records.YarnApplicationState> applicationStates)
    Get a report (ApplicationReport) of Applications matching the given users, queues, application types and application states in the cluster.
    List<org.apache.hadoop.yarn.api.records.ApplicationReport>
    getApplications(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest request)
    Get a list of ApplicationReports that match the given GetApplicationsRequest.
    abstract Map<org.apache.hadoop.yarn.api.records.NodeAttributeKey,List<org.apache.hadoop.yarn.api.records.NodeToAttributeValue>>
    getAttributesToNodes(Set<org.apache.hadoop.yarn.api.records.NodeAttributeKey> attributes)
    The interface used by client to get mapping of AttributeKey to associated NodeToAttributeValue list for specified node attributeKeys 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<org.apache.hadoop.yarn.api.records.NodeAttributeInfo>
    getClusterAttributes()
    The interface used by client to get node attributes in the cluster.
    abstract List<org.apache.hadoop.yarn.api.records.NodeLabel>
    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 Map<String,Set<org.apache.hadoop.yarn.api.records.NodeId>>
    getLabelsToNodes()
    The interface used by client to get labels to nodes mapping in existing cluster
    abstract Map<String,Set<org.apache.hadoop.yarn.api.records.NodeId>>
    getLabelsToNodes(Set<String> labels)
    The interface used by client to get labels to nodes mapping for specified labels in existing 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<String,Set<org.apache.hadoop.yarn.api.records.NodeAttribute>>
    getNodeToAttributes(Set<String> hostNames)
    The interface used by client to get all node to attribute mapping in existing 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.QueueInfo
    getQueueInfo(String queueName, String subClusterId)
    Get information (QueueInfo) about a given queue.
    abstract org.apache.hadoop.yarn.api.records.Resource
    getResourceProfile(String profile)
    Get the details of a specific resource profile from the RM.
    abstract Map<String,org.apache.hadoop.yarn.api.records.Resource>
    getResourceProfiles()
    Get the resource profiles available in the RM.
    abstract List<org.apache.hadoop.yarn.api.records.ResourceTypeInfo>
    getResourceTypeInfo()
    Get available resource types supported by RM.
    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
    killApplication(org.apache.hadoop.yarn.api.records.ApplicationId applicationId, String diagnostics)
    Kill an application identified by given ID.
    abstract org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse
    listReservations(org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest request)
    The interface used by clients to get the list of reservations in a plan.
    abstract void
    moveApplicationAcrossQueues(org.apache.hadoop.yarn.api.records.ApplicationId appId, String queue)
    Attempts to move the given application to the given queue.
    abstract void
    shellToContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId, org.apache.hadoop.yarn.api.records.ShellContainerCommand command)
    The interface used by client to get a shell to a container.
    abstract void
    signalToContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId, org.apache.hadoop.yarn.api.records.SignalContainerCommand command)
    Signal a container identified by given ID.
    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.records.Priority
    updateApplicationPriority(org.apache.hadoop.yarn.api.records.ApplicationId applicationId, org.apache.hadoop.yarn.api.records.Priority priority)
    The interface used by client to set priority of an application
    org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse
    updateApplicationTimeouts(org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest request)
     
    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 Details

    • YarnClient

      @Private protected YarnClient(String name)

  • Method Details

    • createYarnClient

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

    • failApplicationAttempt

      public abstract void failApplicationAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId applicationAttemptId) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException

      Fail an application attempt identified by given ID.

      Parameters:
      applicationAttemptId - ApplicationAttemptId of the attempt to fail.
      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:

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

    • killApplication

      public abstract void killApplication(org.apache.hadoop.yarn.api.records.ApplicationId applicationId, String diagnostics) 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
      diagnostics - for killing an application.
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - in case of errors or if YARN rejects the request due to access-control restrictions.
      IOException

    • 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 - set of application types you are interested in
      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 - set of application states you are interested in
      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 - set of application types you are interested in
      applicationStates - set of application states you are interested in
      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, Set<String> applicationTags) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException

      Get a report (ApplicationReport) of Applications matching the given application types, application states and application tags 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 - set of application types you are interested in
      applicationStates - set of application states you are interested in
      applicationTags - set of application tags you are interested in
      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> queues, Set<String> users, 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 users, queues, application types and application states in the cluster. If any of the params is set to null, it is not used when filtering.

      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:
      queues - set of queues you are interested in
      users - set of users you are interested in
      applicationTypes - set of application types you are interested in
      applicationStates - set of application states you are interested in
      Returns:
      a list of reports of applications
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException
      IOException

    • getApplications

      public List<org.apache.hadoop.yarn.api.records.ApplicationReport> getApplications(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException

      Get a list of ApplicationReports that match the given GetApplicationsRequest.

      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:
      request - the request object to get the list of applications.
      Returns:
      The list of ApplicationReports that match the request
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - Exception specific to YARN.
      IOException - Exception mostly related to connection errors.

    • 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 - I/O exception has occurred.

    • getQueueInfo

      public abstract org.apache.hadoop.yarn.api.records.QueueInfo getQueueInfo(String queueName, String subClusterId) 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.
      subClusterId - sub-cluster Id.
      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 - I/O exception has occurred.

    • 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
      org.apache.hadoop.yarn.exceptions.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 - application id of the app
      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
      org.apache.hadoop.yarn.exceptions.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 - application attempt id
      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

    • createReservation

      public abstract org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse createReservation() throws org.apache.hadoop.yarn.exceptions.YarnException, IOException

      Obtain a GetNewReservationResponse for a new reservation, which contains the ReservationId object.

      Returns:
      The GetNewReservationResponse containing a new ReservationId object.
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if reservation cannot be created.
      IOException - if reservation cannot be created.

    • submitReservation

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

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

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

    • listReservations

      @Public @Unstable public abstract org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse listReservations(org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException

      The interface used by clients to get the list of reservations in a plan. The reservationId will be used to search for reservations to list if it is provided. Otherwise, it will select active reservations within the startTime and endTime (inclusive).

      Parameters:
      request - to list reservations in a plan. Contains fields to select String queue, ReservationId reservationId, long startTime, long endTime, and a bool includeReservationAllocations. queue: Required. Cannot be null or empty. Refers to the reservable queue in the scheduler that was selected when creating a reservation submission ReservationSubmissionRequest. reservationId: Optional. If provided, other fields will be ignored. startTime: Optional. If provided, only reservations that end after the startTime will be selected. This defaults to 0 if an invalid number is used. endTime: Optional. If provided, only reservations that start on or before endTime will be selected. This defaults to Long.MAX_VALUE if an invalid number is used. includeReservationAllocations: Optional. Flag that determines whether the entire reservation allocations are to be returned. Reservation allocations are subject to change in the event of re-planning as described by ReservationDefinition.
      Returns:
      response that contains information about reservations that are being searched for.
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if the request is invalid
      IOException - if the request failed otherwise

    • getNodeToLabels

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

    • getLabelsToNodes

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

      The interface used by client to get labels to nodes mapping in existing cluster

      Returns:
      node to labels mappings
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException
      IOException

    • getLabelsToNodes

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

      The interface used by client to get labels to nodes mapping for specified labels in existing cluster

      Parameters:
      labels - labels for which labels to nodes mapping has to be retrieved
      Returns:
      labels to nodes mappings for specific labels
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException
      IOException

    • getClusterNodeLabels

      @Public @Unstable public abstract List<org.apache.hadoop.yarn.api.records.NodeLabel> 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 - when there is a failure in ApplicationClientProtocol
      IOException - when there is a failure in ApplicationClientProtocol

    • updateApplicationPriority

      @Public @Unstable public abstract org.apache.hadoop.yarn.api.records.Priority updateApplicationPriority(org.apache.hadoop.yarn.api.records.ApplicationId applicationId, org.apache.hadoop.yarn.api.records.Priority priority) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException

      The interface used by client to set priority of an application

      Parameters:
      applicationId -
      priority -
      Returns:
      updated priority of an application.
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException
      IOException

    • signalToContainer

      public abstract void signalToContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId, org.apache.hadoop.yarn.api.records.SignalContainerCommand command) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException

      Signal a container identified by given ID.

      Parameters:
      containerId - ContainerId of the container that needs to be signaled
      command - the signal container command
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException
      IOException

    • updateApplicationTimeouts

      @Public @Unstable public org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse updateApplicationTimeouts(org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest request) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException
      IOException

    • getResourceProfiles

      @Public @Unstable public abstract Map<String,org.apache.hadoop.yarn.api.records.Resource> getResourceProfiles() throws org.apache.hadoop.yarn.exceptions.YarnException, IOException

      Get the resource profiles available in the RM.

      Returns:
      a Map of the resource profile names to their capabilities
      Throws:
      org.apache.hadoop.yarn.exceptions.YARNFeatureNotEnabledException - if resource-profile is disabled
      org.apache.hadoop.yarn.exceptions.YarnException - if any error happens inside YARN
      IOException - in case of other errors

    • getResourceProfile

      @Public @Unstable public abstract org.apache.hadoop.yarn.api.records.Resource getResourceProfile(String profile) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException

      Get the details of a specific resource profile from the RM.

      Parameters:
      profile - the profile name
      Returns:
      resource profile name with its capabilities
      Throws:
      org.apache.hadoop.yarn.exceptions.YARNFeatureNotEnabledException - if resource-profile is disabled
      org.apache.hadoop.yarn.exceptions.YarnException - if any error happens inside YARN
      IOException - in case of other others

    • getResourceTypeInfo

      @Public @Unstable public abstract List<org.apache.hadoop.yarn.api.records.ResourceTypeInfo> getResourceTypeInfo() throws org.apache.hadoop.yarn.exceptions.YarnException, IOException

      Get available resource types supported by RM.

      Returns:
      list of supported resource types with detailed information
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - if any issue happens inside YARN
      IOException - in case of other others

    • getClusterAttributes

      @Public @Unstable public abstract Set<org.apache.hadoop.yarn.api.records.NodeAttributeInfo> getClusterAttributes() throws org.apache.hadoop.yarn.exceptions.YarnException, IOException

      The interface used by client to get node attributes in the cluster.

      Returns:
      cluster node attributes collection
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException - when there is a failure in ApplicationClientProtocol
      IOException - when there is a failure in ApplicationClientProtocol

    • getAttributesToNodes

      @Public @Unstable public abstract Map<org.apache.hadoop.yarn.api.records.NodeAttributeKey,List<org.apache.hadoop.yarn.api.records.NodeToAttributeValue>> getAttributesToNodes(Set<org.apache.hadoop.yarn.api.records.NodeAttributeKey> attributes) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException

      The interface used by client to get mapping of AttributeKey to associated NodeToAttributeValue list for specified node attributeKeys in the cluster.

      Parameters:
      attributes - AttributeKeys for which associated NodeToAttributeValue mapping value has to be retrieved. If empty or null is set then will return mapping for all attributeKeys in the cluster
      Returns:
      mapping of AttributeKey to List of associated NodeToAttributeValue's.
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException
      IOException

    • getNodeToAttributes

      @Public @Unstable public abstract Map<String,Set<org.apache.hadoop.yarn.api.records.NodeAttribute>> getNodeToAttributes(Set<String> hostNames) throws org.apache.hadoop.yarn.exceptions.YarnException, IOException

      The interface used by client to get all node to attribute mapping in existing cluster.

      Parameters:
      hostNames - HostNames for which host to attributes mapping has to be retrived.If empty or null is set then will return all nodes to attributes mapping in cluster.
      Returns:
      Node to attribute mappings
      Throws:
      org.apache.hadoop.yarn.exceptions.YarnException
      IOException

    • shellToContainer

      @Public @Unstable public abstract void shellToContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId, org.apache.hadoop.yarn.api.records.ShellContainerCommand command) throws IOException

      The interface used by client to get a shell to a container.

      Parameters:
      containerId - Container ID
      command - Shell type
      Throws:
      IOException - if connection fails.