| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:12:12 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>YarnScheduler (Apache Hadoop YARN ResourceManager 3.3.1 API)</title> |
| <meta name="date" content="2021-06-15"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="YarnScheduler (Apache Hadoop YARN ResourceManager 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/YarnScheduler.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerUtils.MaxResourceValidationResult.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html" target="_top">Frames</a></li> |
| <li><a href="YarnScheduler.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.yarn.server.resourcemanager.scheduler</div> |
| <h2 title="Interface YarnScheduler" class="title">Interface YarnScheduler</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>org.apache.hadoop.yarn.event.EventHandler<<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/event/SchedulerEvent.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.event">SchedulerEvent</a>></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfScheduler.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">MutableConfScheduler</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/PreemptableResourceScheduler.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">PreemptableResourceScheduler</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceScheduler.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">ResourceScheduler</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/AbstractYarnScheduler.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">AbstractYarnScheduler</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CapacityScheduler.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CapacityScheduler</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FairScheduler.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair">FairScheduler</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fifo/FifoScheduler.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.fifo">FifoScheduler</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">YarnScheduler</span> |
| extends org.apache.hadoop.yarn.event.EventHandler<<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/event/SchedulerEvent.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.event">SchedulerEvent</a>></pre> |
| <div class="block">This interface is used by the components to talk to the |
| scheduler for allocating of resources, cleaning up resources.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#addQueue-org.apache.hadoop.yarn.server.resourcemanager.scheduler.Queue-">addQueue</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">Queue</a> newQueue)</code> |
| <div class="block">Add to the scheduler a new Queue.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Allocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">Allocation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#allocate-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-java.util.List-java.util.List-java.util.List-java.util.List-java.util.List-org.apache.hadoop.yarn.server.resourcemanager.scheduler.ContainerUpdates-">allocate</a></span>(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.ResourceRequest> ask, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.SchedulingRequest> schedulingRequests, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.ContainerId> release, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> blacklistAdditions, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> blacklistRemovals, |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ContainerUpdates.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">ContainerUpdates</a> updateRequests)</code> |
| <div class="block">The main api between the ApplicationMaster and the Scheduler.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#checkAccess-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.yarn.api.records.QueueACL-java.lang.String-">checkAccess</a></span>(org.apache.hadoop.security.UserGroupInformation callerUGI, |
| org.apache.hadoop.yarn.api.records.QueueACL acl, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName)</code> |
| <div class="block">Check if the user has permission to perform the operation.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#checkAndGetApplicationLifetime-java.lang.String-long-">checkAndGetApplicationLifetime</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName, |
| long lifetime)</code> |
| <div class="block">Verify whether a submitted application lifetime is valid as per configured |
| Queue lifetime.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Priority</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#checkAndGetApplicationPriority-org.apache.hadoop.yarn.api.records.Priority-org.apache.hadoop.security.UserGroupInformation-java.lang.String-org.apache.hadoop.yarn.api.records.ApplicationId-">checkAndGetApplicationPriority</a></span>(org.apache.hadoop.yarn.api.records.Priority priorityRequestedByApp, |
| org.apache.hadoop.security.UserGroupInformation user, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queuePath, |
| org.apache.hadoop.yarn.api.records.ApplicationId applicationId)</code> |
| <div class="block">Verify whether a submitted application priority is valid as per configured |
| Queue</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getAppResourceUsageReport-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-">getAppResourceUsageReport</a></span>(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)</code> |
| <div class="block">Get a resource usage report from a given app attempt ID.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.ApplicationAttemptId></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getAppsInQueue-java.lang.String-">getAppsInQueue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName)</code> |
| <div class="block">Gets the apps under a given queue</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getClusterResource--">getClusterResource</a></span>()</code> |
| <div class="block">Get the whole resource capacity of the cluster.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Priority</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getMaxClusterLevelAppPriority--">getMaxClusterLevelAppPriority</a></span>()</code> |
| <div class="block">Get cluster max priority.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getMaximumApplicationLifetime-java.lang.String-">getMaximumApplicationLifetime</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName)</code> |
| <div class="block">Get maximum lifetime for a queue.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getMaximumResourceCapability--">getMaximumResourceCapability</a></span>()</code> |
| <div class="block">Get maximum allocatable <code>Resource</code> at the cluster level.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getMaximumResourceCapability-java.lang.String-">getMaximumResourceCapability</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName)</code> |
| <div class="block">Get maximum allocatable <code>Resource</code> for the queue specified.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getMinimumResourceCapability--">getMinimumResourceCapability</a></span>()</code> |
| <div class="block">Get minimum allocatable <code>Resource</code>.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerNodeReport.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerNodeReport</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getNodeReport-org.apache.hadoop.yarn.api.records.NodeId-">getNodeReport</a></span>(org.apache.hadoop.yarn.api.records.NodeId nodeId)</code> |
| <div class="block">Get node resource usage report.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Resource</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getNormalizedResource-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.api.records.Resource-">getNormalizedResource</a></span>(org.apache.hadoop.yarn.api.records.Resource requestedResource, |
| org.apache.hadoop.yarn.api.records.Resource maxResourceCapability)</code> |
| <div class="block">Normalize a resource request using scheduler level maximum resource or |
| queue based maximum resource.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getNumClusterNodes--">getNumClusterNodes</a></span>()</code> |
| <div class="block">Get the number of nodes available in the cluster.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.ResourceRequest></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getPendingResourceRequestsForAttempt-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-">getPendingResourceRequestsForAttempt</a></span>(org.apache.hadoop.yarn.api.records.ApplicationAttemptId attemptId)</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.SchedulingRequest></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getPendingSchedulingRequestsForAttempt-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-">getPendingSchedulingRequestsForAttempt</a></span>(org.apache.hadoop.yarn.api.records.ApplicationAttemptId attemptId)</code> |
| <div class="block">Get pending scheduling request for specified application attempt.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getPlanQueues--">getPlanQueues</a></span>()</code> |
| <div class="block">Gets the list of names for queues managed by the Reservation System</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.QueueInfo</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getQueueInfo-java.lang.String-boolean-boolean-">getQueueInfo</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName, |
| boolean includeChildQueues, |
| boolean recursive)</code> |
| <div class="block">Get queue information</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.QueueUserACLInfo></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getQueueUserAclInfo--">getQueueUserAclInfo</a></span>()</code> |
| <div class="block">Get acls for queues for current user.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.util.resource.ResourceCalculator</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getResourceCalculator--">getResourceCalculator</a></span>()</code> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getRMContainer-org.apache.hadoop.yarn.api.records.ContainerId-">getRMContainer</a></span>(org.apache.hadoop.yarn.api.records.ContainerId containerId)</code> |
| <div class="block">Get the container for the given containerId.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueMetrics</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getRootQueueMetrics--">getRootQueueMetrics</a></span>()</code> |
| <div class="block">Get the root queue for the scheduler.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerAppReport.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerAppReport</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getSchedulerAppInfo-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-">getSchedulerAppInfo</a></span>(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)</code> |
| <div class="block">Get the Scheduler app for a given app attempt Id.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerNode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getSchedulerNode-org.apache.hadoop.yarn.api.records.NodeId-">getSchedulerNode</a></span>(org.apache.hadoop.yarn.api.records.NodeId nodeId)</code> |
| <div class="block">Get SchedulerNode corresponds to nodeId.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><org.apache.hadoop.yarn.proto.YarnServiceProtos.SchedulerResourceTypes></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getSchedulingResourceTypes--">getSchedulingResourceTypes</a></span>()</code> |
| <div class="block">Return a collection of the resource types that are considered when |
| scheduling</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.Container></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#getTransferredContainers-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-">getTransferredContainers</a></span>(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)</code> |
| <div class="block">Get previous attempts' live containers for work-preserving AM restart.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#killAllAppsInQueue-java.lang.String-">killAllAppsInQueue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName)</code> |
| <div class="block">Terminate all applications in the specified queue.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#moveAllApps-java.lang.String-java.lang.String-">moveAllApps</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sourceQueue, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> destQueue)</code> |
| <div class="block">Completely drain sourceQueue of applications, by moving all of them to |
| destQueue.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#moveApplication-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-">moveApplication</a></span>(org.apache.hadoop.yarn.api.records.ApplicationId appId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newQueue)</code> |
| <div class="block">Moves the given application to the given queue</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#preValidateMoveApplication-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-">preValidateMoveApplication</a></span>(org.apache.hadoop.yarn.api.records.ApplicationId appId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newQueue)</code> </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#removeQueue-java.lang.String-">removeQueue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName)</code> |
| <div class="block">Remove an existing queue.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#setClusterMaxPriority-org.apache.hadoop.conf.Configuration-">setClusterMaxPriority</a></span>(org.apache.hadoop.conf.Configuration conf)</code> |
| <div class="block">Set the cluster max priority</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#setEntitlement-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.QueueEntitlement-">setEntitlement</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queue, |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/QueueEntitlement.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common">QueueEntitlement</a> entitlement)</code> |
| <div class="block">This method increase the entitlement for current queue (must respect |
| invariants, e.g., no overcommit of parents, non negative, etc.).</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.yarn.api.records.Priority</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html#updateApplicationPriority-org.apache.hadoop.yarn.api.records.Priority-org.apache.hadoop.yarn.api.records.ApplicationId-org.apache.hadoop.thirdparty.com.google.common.util.concurrent.SettableFuture-org.apache.hadoop.security.UserGroupInformation-">updateApplicationPriority</a></span>(org.apache.hadoop.yarn.api.records.Priority newPriority, |
| org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| org.apache.hadoop.thirdparty.com.google.common.util.concurrent.SettableFuture<<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> future, |
| org.apache.hadoop.security.UserGroupInformation user)</code> |
| <div class="block">Change application priority of a submitted application at runtime</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.event.EventHandler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.hadoop.yarn.event.EventHandler</h3> |
| <code>handle</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getQueueInfo-java.lang.String-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueueInfo</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| org.apache.hadoop.yarn.api.records.QueueInfo getQueueInfo(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName, |
| boolean includeChildQueues, |
| boolean recursive) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Get queue information</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queueName</code> - queue name</dd> |
| <dd><code>includeChildQueues</code> - include child queues?</dd> |
| <dd><code>recursive</code> - get children queues?</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>queue information</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueueUserAclInfo--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueueUserAclInfo</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.QueueUserACLInfo> getQueueUserAclInfo()</pre> |
| <div class="block">Get acls for queues for current user.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>acls for queues for current user</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClusterResource--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClusterResource</h4> |
| <pre>@InterfaceAudience.LimitedPrivate(value="yarn") |
| @InterfaceStability.Unstable |
| org.apache.hadoop.yarn.api.records.Resource getClusterResource()</pre> |
| <div class="block">Get the whole resource capacity of the cluster.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the whole resource capacity of the cluster.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMinimumResourceCapability--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinimumResourceCapability</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| org.apache.hadoop.yarn.api.records.Resource getMinimumResourceCapability()</pre> |
| <div class="block">Get minimum allocatable <code>Resource</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>minimum allocatable resource</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaximumResourceCapability--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaximumResourceCapability</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| org.apache.hadoop.yarn.api.records.Resource getMaximumResourceCapability()</pre> |
| <div class="block">Get maximum allocatable <code>Resource</code> at the cluster level.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>maximum allocatable resource</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaximumResourceCapability-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaximumResourceCapability</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| org.apache.hadoop.yarn.api.records.Resource getMaximumResourceCapability(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName)</pre> |
| <div class="block">Get maximum allocatable <code>Resource</code> for the queue specified.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queueName</code> - queue name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>maximum allocatable resource</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResourceCalculator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResourceCalculator</h4> |
| <pre>@InterfaceAudience.LimitedPrivate(value="yarn") |
| @InterfaceStability.Evolving |
| org.apache.hadoop.yarn.util.resource.ResourceCalculator getResourceCalculator()</pre> |
| </li> |
| </ul> |
| <a name="getNumClusterNodes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumClusterNodes</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| int getNumClusterNodes()</pre> |
| <div class="block">Get the number of nodes available in the cluster.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of available nodes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allocate-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-java.util.List-java.util.List-java.util.List-java.util.List-java.util.List-org.apache.hadoop.yarn.server.resourcemanager.scheduler.ContainerUpdates-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocate</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Stable |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Allocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">Allocation</a> allocate(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.ResourceRequest> ask, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.SchedulingRequest> schedulingRequests, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.ContainerId> release, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> blacklistAdditions, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> blacklistRemovals, |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ContainerUpdates.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">ContainerUpdates</a> updateRequests)</pre> |
| <div class="block">The main api between the ApplicationMaster and the Scheduler. |
| The ApplicationMaster is updating his future resource requirements |
| and may release containers he doens't need.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appAttemptId</code> - </dd> |
| <dd><code>ask</code> - </dd> |
| <dd><code>schedulingRequests</code> - </dd> |
| <dd><code>release</code> - </dd> |
| <dd><code>blacklistAdditions</code> - </dd> |
| <dd><code>blacklistRemovals</code> - </dd> |
| <dd><code>updateRequests</code> - @return the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Allocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><code>Allocation</code></a> for the application</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNodeReport-org.apache.hadoop.yarn.api.records.NodeId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNodeReport</h4> |
| <pre>@InterfaceAudience.LimitedPrivate(value="yarn") |
| @InterfaceStability.Stable |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerNodeReport.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerNodeReport</a> getNodeReport(org.apache.hadoop.yarn.api.records.NodeId nodeId)</pre> |
| <div class="block">Get node resource usage report.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeId</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerNodeReport.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><code>SchedulerNodeReport</code></a> for the node or null |
| if nodeId does not point to a defined node.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchedulerAppInfo-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchedulerAppInfo</h4> |
| <pre>@InterfaceAudience.LimitedPrivate(value="yarn") |
| @InterfaceStability.Stable |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerAppReport.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerAppReport</a> getSchedulerAppInfo(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)</pre> |
| <div class="block">Get the Scheduler app for a given app attempt Id.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appAttemptId</code> - the id of the application attempt</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SchedulerApp for this given attempt.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAppResourceUsageReport-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAppResourceUsageReport</h4> |
| <pre>@InterfaceAudience.LimitedPrivate(value="yarn") |
| @InterfaceStability.Evolving |
| org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport getAppResourceUsageReport(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)</pre> |
| <div class="block">Get a resource usage report from a given app attempt ID.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appAttemptId</code> - the id of the application attempt</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>resource usage report for this given attempt</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRootQueueMetrics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRootQueueMetrics</h4> |
| <pre>@InterfaceAudience.LimitedPrivate(value="yarn") |
| @InterfaceStability.Evolving |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueMetrics</a> getRootQueueMetrics()</pre> |
| <div class="block">Get the root queue for the scheduler.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the root queue for the scheduler.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkAccess-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.yarn.api.records.QueueACL-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkAccess</h4> |
| <pre>boolean checkAccess(org.apache.hadoop.security.UserGroupInformation callerUGI, |
| org.apache.hadoop.yarn.api.records.QueueACL acl, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName)</pre> |
| <div class="block">Check if the user has permission to perform the operation. |
| If the user has <code>QueueACL.ADMINISTER_QUEUE</code> permission, |
| this user can view/modify the applications in this queue</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callerUGI</code> - </dd> |
| <dd><code>acl</code> - </dd> |
| <dd><code>queueName</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the user has the permission, |
| <code>false</code> otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAppsInQueue-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAppsInQueue</h4> |
| <pre>@InterfaceAudience.LimitedPrivate(value="yarn") |
| @InterfaceStability.Stable |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.ApplicationAttemptId> getAppsInQueue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName)</pre> |
| <div class="block">Gets the apps under a given queue</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queueName</code> - the name of the queue.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a collection of app attempt ids in the given queue.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRMContainer-org.apache.hadoop.yarn.api.records.ContainerId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRMContainer</h4> |
| <pre>@InterfaceAudience.LimitedPrivate(value="yarn") |
| @InterfaceStability.Unstable |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/rmcontainer/RMContainer.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.rmcontainer">RMContainer</a> getRMContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId)</pre> |
| <div class="block">Get the container for the given containerId.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>containerId</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the container for the given containerId.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="moveApplication-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>moveApplication</h4> |
| <pre>@InterfaceAudience.LimitedPrivate(value="yarn") |
| @InterfaceStability.Evolving |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> moveApplication(org.apache.hadoop.yarn.api.records.ApplicationId appId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newQueue) |
| throws org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">Moves the given application to the given queue</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appId</code> - </dd> |
| <dd><code>newQueue</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the queue the application was placed into</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if the move cannot be carried out</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="preValidateMoveApplication-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>preValidateMoveApplication</h4> |
| <pre>@InterfaceAudience.LimitedPrivate(value="yarn") |
| @InterfaceStability.Evolving |
| void preValidateMoveApplication(org.apache.hadoop.yarn.api.records.ApplicationId appId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newQueue) |
| throws org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appId</code> - Application ID</dd> |
| <dd><code>newQueue</code> - Target QueueName</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if the pre-validation for move cannot be carried out</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="moveAllApps-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>moveAllApps</h4> |
| <pre>void moveAllApps(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sourceQueue, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> destQueue) |
| throws org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">Completely drain sourceQueue of applications, by moving all of them to |
| destQueue.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sourceQueue</code> - </dd> |
| <dd><code>destQueue</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="killAllAppsInQueue-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>killAllAppsInQueue</h4> |
| <pre>void killAllAppsInQueue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName) |
| throws org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">Terminate all applications in the specified queue.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queueName</code> - the name of queue to be drained</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeQueue-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeQueue</h4> |
| <pre>void removeQueue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName) |
| throws org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">Remove an existing queue. Implementations might limit when a queue could be |
| removed (e.g., must have zero entitlement, and no applications running, or |
| must be a leaf, etc..).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queueName</code> - name of the queue to remove</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addQueue-org.apache.hadoop.yarn.server.resourcemanager.scheduler.Queue-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addQueue</h4> |
| <pre>void addQueue(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">Queue</a> newQueue) |
| throws org.apache.hadoop.yarn.exceptions.YarnException, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Add to the scheduler a new Queue. Implementations might limit what type of |
| queues can be dynamically added (e.g., Queue must be a leaf, must be |
| attached to existing parent, must have zero entitlement).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newQueue</code> - the queue being added.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEntitlement-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.scheduler.common.QueueEntitlement-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEntitlement</h4> |
| <pre>void setEntitlement(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queue, |
| <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/common/QueueEntitlement.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.common">QueueEntitlement</a> entitlement) |
| throws org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">This method increase the entitlement for current queue (must respect |
| invariants, e.g., no overcommit of parents, non negative, etc.). |
| Entitlement is a general term for weights in FairScheduler, capacity for |
| the CapacityScheduler, etc.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queue</code> - the queue for which we change entitlement</dd> |
| <dd><code>entitlement</code> - the new entitlement for the queue (capacity, |
| maxCapacity, etc..)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPlanQueues--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPlanQueues</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getPlanQueues() |
| throws org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">Gets the list of names for queues managed by the Reservation System</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of queues which support reservations</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchedulingResourceTypes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchedulingResourceTypes</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><org.apache.hadoop.yarn.proto.YarnServiceProtos.SchedulerResourceTypes> getSchedulingResourceTypes()</pre> |
| <div class="block">Return a collection of the resource types that are considered when |
| scheduling</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an EnumSet containing the resource types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkAndGetApplicationPriority-org.apache.hadoop.yarn.api.records.Priority-org.apache.hadoop.security.UserGroupInformation-java.lang.String-org.apache.hadoop.yarn.api.records.ApplicationId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkAndGetApplicationPriority</h4> |
| <pre>org.apache.hadoop.yarn.api.records.Priority checkAndGetApplicationPriority(org.apache.hadoop.yarn.api.records.Priority priorityRequestedByApp, |
| org.apache.hadoop.security.UserGroupInformation user, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queuePath, |
| org.apache.hadoop.yarn.api.records.ApplicationId applicationId) |
| throws org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">Verify whether a submitted application priority is valid as per configured |
| Queue</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>priorityRequestedByApp</code> - Submitted Application priority.</dd> |
| <dd><code>user</code> - User who submitted the Application</dd> |
| <dd><code>queuePath</code> - Name of the Queue</dd> |
| <dd><code>applicationId</code> - Application ID</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Updated Priority from scheduler</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateApplicationPriority-org.apache.hadoop.yarn.api.records.Priority-org.apache.hadoop.yarn.api.records.ApplicationId-org.apache.hadoop.thirdparty.com.google.common.util.concurrent.SettableFuture-org.apache.hadoop.security.UserGroupInformation-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateApplicationPriority</h4> |
| <pre>org.apache.hadoop.yarn.api.records.Priority updateApplicationPriority(org.apache.hadoop.yarn.api.records.Priority newPriority, |
| org.apache.hadoop.yarn.api.records.ApplicationId applicationId, |
| org.apache.hadoop.thirdparty.com.google.common.util.concurrent.SettableFuture<<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> future, |
| org.apache.hadoop.security.UserGroupInformation user) |
| throws org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">Change application priority of a submitted application at runtime</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newPriority</code> - Submitted Application priority.</dd> |
| <dd><code>applicationId</code> - Application ID</dd> |
| <dd><code>future</code> - Sets any type of exception happened from StateStore</dd> |
| <dd><code>user</code> - who submitted the application</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>updated priority</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTransferredContainers-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransferredContainers</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.Container> getTransferredContainers(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)</pre> |
| <div class="block">Get previous attempts' live containers for work-preserving AM restart.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>appAttemptId</code> - the id of the application attempt</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>list of live containers for the given attempt</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setClusterMaxPriority-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setClusterMaxPriority</h4> |
| <pre>void setClusterMaxPriority(org.apache.hadoop.conf.Configuration conf) |
| throws org.apache.hadoop.yarn.exceptions.YarnException</pre> |
| <div class="block">Set the cluster max priority</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPendingResourceRequestsForAttempt-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPendingResourceRequestsForAttempt</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.ResourceRequest> getPendingResourceRequestsForAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId attemptId)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>attemptId</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPendingSchedulingRequestsForAttempt-org.apache.hadoop.yarn.api.records.ApplicationAttemptId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPendingSchedulingRequestsForAttempt</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.yarn.api.records.SchedulingRequest> getPendingSchedulingRequestsForAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId attemptId)</pre> |
| <div class="block">Get pending scheduling request for specified application attempt.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>attemptId</code> - the id of the application attempt</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>pending scheduling requests</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxClusterLevelAppPriority--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxClusterLevelAppPriority</h4> |
| <pre>org.apache.hadoop.yarn.api.records.Priority getMaxClusterLevelAppPriority()</pre> |
| <div class="block">Get cluster max priority.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>maximum priority of cluster</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchedulerNode-org.apache.hadoop.yarn.api.records.NodeId-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchedulerNode</h4> |
| <pre><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerNode.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">SchedulerNode</a> getSchedulerNode(org.apache.hadoop.yarn.api.records.NodeId nodeId)</pre> |
| <div class="block">Get SchedulerNode corresponds to nodeId.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeId</code> - the node id of RMNode</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SchedulerNode corresponds to nodeId</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNormalizedResource-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.api.records.Resource-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNormalizedResource</h4> |
| <pre>org.apache.hadoop.yarn.api.records.Resource getNormalizedResource(org.apache.hadoop.yarn.api.records.Resource requestedResource, |
| org.apache.hadoop.yarn.api.records.Resource maxResourceCapability)</pre> |
| <div class="block">Normalize a resource request using scheduler level maximum resource or |
| queue based maximum resource.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>requestedResource</code> - the resource to be normalized</dd> |
| <dd><code>maxResourceCapability</code> - Maximum container allocation value, if null or |
| empty scheduler level maximum container allocation value will be |
| used</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the normalized resource</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkAndGetApplicationLifetime-java.lang.String-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkAndGetApplicationLifetime</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Evolving |
| long checkAndGetApplicationLifetime(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName, |
| long lifetime)</pre> |
| <div class="block">Verify whether a submitted application lifetime is valid as per configured |
| Queue lifetime.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queueName</code> - Name of the Queue</dd> |
| <dd><code>lifetime</code> - configured application lifetime</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>valid lifetime as per queue</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaximumApplicationLifetime-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getMaximumApplicationLifetime</h4> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Evolving |
| long getMaximumApplicationLifetime(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queueName)</pre> |
| <div class="block">Get maximum lifetime for a queue.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queueName</code> - to get lifetime</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>maximum lifetime in seconds</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/YarnScheduler.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/SchedulerUtils.MaxResourceValidationResult.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.html" target="_top">Frames</a></li> |
| <li><a href="YarnScheduler.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |