| <!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:13 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>FSQueueMetrics (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="FSQueueMetrics (Apache Hadoop YARN ResourceManager 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/FSQueueMetrics.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/fair/FSQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueType.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueMetrics.html" target="_top">Frames</a></li> |
| <li><a href="FSQueueMetrics.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><a href="#fields.inherited.from.class.org.apache.hadoop.yarn.server.resourcemanager.scheduler.QueueMetrics">Field</a> | </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.fair</div> |
| <h2 title="Class FSQueueMetrics" class="title">Class FSQueueMetrics</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">org.apache.hadoop.yarn.server.resourcemanager.scheduler.QueueMetrics</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair.FSQueueMetrics</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.apache.hadoop.metrics2.MetricsSource</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@Metrics(context="yarn") |
| public class <span class="typeNameLabel">FSQueueMetrics</span> |
| extends <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueMetrics</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.yarn.server.resourcemanager.scheduler.QueueMetrics"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueMetrics</a></h3> |
| <code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#conf">conf</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#DEFAULT_PARTITION">DEFAULT_PARTITION</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#DEFAULT_PARTITION_JMX_STR">DEFAULT_PARTITION_JMX_STR</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#METRIC_NAME_DELIMITER">METRIC_NAME_DELIMITER</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#metricsSystem">metricsSystem</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#P_RECORD_INFO">P_RECORD_INFO</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#PARTITION_INFO">PARTITION_INFO</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#QUEUE_INFO">QUEUE_INFO</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#queueName">queueName</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#registry">registry</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#USER_INFO">USER_INFO</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#users">users</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair">FSQueueMetrics</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueMetrics.html#forQueue-org.apache.hadoop.metrics2.MetricsSystem-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.scheduler.Queue-boolean-org.apache.hadoop.conf.Configuration-">forQueue</a></span>(org.apache.hadoop.metrics2.MetricsSystem ms, |
| <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, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">Queue</a> parent, |
| boolean enableUserMetrics, |
| org.apache.hadoop.conf.Configuration conf)</code> |
| <div class="block">Get the FS queue metric for the given queue.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair">FSQueueMetrics</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueMetrics.html#forQueue-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.scheduler.Queue-boolean-org.apache.hadoop.conf.Configuration-">forQueue</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, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">Queue</a> parent, |
| boolean enableUserMetrics, |
| org.apache.hadoop.conf.Configuration conf)</code> </td> |
| </tr> |
| <tr id="i2" 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/fair/FSQueueMetrics.html#getAMResourceUsage--">getAMResourceUsage</a></span>()</code> |
| <div class="block">Get resource usage of the AM.</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/fair/FSQueueMetrics.html#getAMResourceUsageMB--">getAMResourceUsageMB</a></span>()</code> |
| <div class="block">Get the AM memory usage in MB.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueMetrics.html#getAMResourceUsageVCores--">getAMResourceUsageVCores</a></span>()</code> |
| <div class="block">Get the AM VCore usage.</div> |
| </td> |
| </tr> |
| <tr id="i5" 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/fair/FSQueueMetrics.html#getFairShare--">getFairShare</a></span>()</code> |
| <div class="block">Get instantaneous fair share of the queue.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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/fair/FSQueueMetrics.html#getMaxAMShare--">getMaxAMShare</a></span>()</code> |
| <div class="block">Get maximum resource AM can use.</div> |
| </td> |
| </tr> |
| <tr id="i7" 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/fair/FSQueueMetrics.html#getMaxAMShareMB--">getMaxAMShareMB</a></span>()</code> |
| <div class="block">Get the maximum memory size AM can use in MB.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueMetrics.html#getMaxAMShareVCores--">getMaxAMShareVCores</a></span>()</code> |
| <div class="block">Get the maximum number of VCores AM can use.</div> |
| </td> |
| </tr> |
| <tr id="i9" 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/fair/FSQueueMetrics.html#getMaxApps--">getMaxApps</a></span>()</code> </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/fair/FSQueueMetrics.html#getMaxShare--">getMaxShare</a></span>()</code> |
| <div class="block">Get maximum allowed resource share for queue.</div> |
| </td> |
| </tr> |
| <tr id="i11" 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/fair/FSQueueMetrics.html#getMaxShareMB--">getMaxShareMB</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueMetrics.html#getMaxShareVirtualCores--">getMaxShareVirtualCores</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" 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/fair/FSQueueMetrics.html#getMinShare--">getMinShare</a></span>()</code> |
| <div class="block">Get minimum required resource share for queue.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueMetrics.html#getMinShareMB--">getMinShareMB</a></span>()</code> </td> |
| </tr> |
| <tr id="i15" 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/fair/FSQueueMetrics.html#getMinShareVirtualCores--">getMinShareVirtualCores</a></span>()</code> </td> |
| </tr> |
| <tr id="i16" 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/fair/FSQueueMetrics.html#getSchedulingPolicy--">getSchedulingPolicy</a></span>()</code> |
| <div class="block">Get the scheduling policy.</div> |
| </td> |
| </tr> |
| <tr id="i17" 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/fair/FSQueueMetrics.html#getSteadyFairShare--">getSteadyFairShare</a></span>()</code> |
| <div class="block">Get steady fair share for queue.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueMetrics.html#getSteadyFairShareMB--">getSteadyFairShareMB</a></span>()</code> </td> |
| </tr> |
| <tr id="i19" 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/fair/FSQueueMetrics.html#getSteadyFairShareVCores--">getSteadyFairShareVCores</a></span>()</code> </td> |
| </tr> |
| <tr id="i20" 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/fair/FSQueueMetrics.html#setAMResourceUsage-org.apache.hadoop.yarn.api.records.Resource-">setAMResourceUsage</a></span>(org.apache.hadoop.yarn.api.records.Resource resource)</code> |
| <div class="block">Set the AM resource usage.</div> |
| </td> |
| </tr> |
| <tr id="i21" 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/fair/FSQueueMetrics.html#setFairShare-org.apache.hadoop.yarn.api.records.Resource-">setFairShare</a></span>(org.apache.hadoop.yarn.api.records.Resource resource)</code> |
| <div class="block">Set instantaneous fair share of the queue.</div> |
| </td> |
| </tr> |
| <tr id="i22" 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/fair/FSQueueMetrics.html#setMaxAMShare-org.apache.hadoop.yarn.api.records.Resource-">setMaxAMShare</a></span>(org.apache.hadoop.yarn.api.records.Resource resource)</code> |
| <div class="block">Set the maximum resource AM can use.</div> |
| </td> |
| </tr> |
| <tr id="i23" 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/fair/FSQueueMetrics.html#setMaxApps-int-">setMaxApps</a></span>(int max)</code> </td> |
| </tr> |
| <tr id="i24" 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/fair/FSQueueMetrics.html#setMaxShare-org.apache.hadoop.yarn.api.records.Resource-">setMaxShare</a></span>(org.apache.hadoop.yarn.api.records.Resource resource)</code> |
| <div class="block">Set maximum allowed resource share for queue.</div> |
| </td> |
| </tr> |
| <tr id="i25" 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/fair/FSQueueMetrics.html#setMinShare-org.apache.hadoop.yarn.api.records.Resource-">setMinShare</a></span>(org.apache.hadoop.yarn.api.records.Resource resource)</code> |
| <div class="block">Set minimum required resource share for queue.</div> |
| </td> |
| </tr> |
| <tr id="i26" 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/fair/FSQueueMetrics.html#setSchedulingPolicy-java.lang.String-">setSchedulingPolicy</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> policy)</code> </td> |
| </tr> |
| <tr id="i27" 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/fair/FSQueueMetrics.html#setSteadyFairShare-org.apache.hadoop.yarn.api.records.Resource-">setSteadyFairShare</a></span>(org.apache.hadoop.yarn.api.records.Resource resource)</code> |
| <div class="block">Set steady fair share for queue.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.server.resourcemanager.scheduler.QueueMetrics"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.hadoop.yarn.server.resourcemanager.scheduler.<a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueMetrics</a></h3> |
| <code><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#activateApp-java.lang.String-">activateApp</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#addAppAttemptFirstContainerAllocationDelay-long-">addAppAttemptFirstContainerAllocationDelay</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#allocateResources-java.lang.String-java.lang.String-int-org.apache.hadoop.yarn.api.records.Resource-boolean-">allocateResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#allocateResources-java.lang.String-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">allocateResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#clearQueueMetrics--">clearQueueMetrics</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#createQueueMetricsForCustomResources--">createQueueMetricsForCustomResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#deactivateApp-java.lang.String-">deactivateApp</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#decrActiveUsers--">decrActiveUsers</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#decrPendingResources-java.lang.String-java.lang.String-int-org.apache.hadoop.yarn.api.records.Resource-">decrPendingResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#decrReserveResource-org.apache.hadoop.yarn.api.records.Resource-">decrReserveResource</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#fillInValuesFromAvailableResources-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.api.records.Resource-">fillInValuesFromAvailableResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#finishApp-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.rmapp.RMAppState-">finishApp</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#finishAppAttempt-org.apache.hadoop.yarn.api.records.ApplicationId-boolean-java.lang.String-">finishAppAttempt</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getActiveApps--">getActiveApps</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getActiveUsers--">getActiveUsers</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAggegatedReleasedContainers--">getAggegatedReleasedContainers</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAggregateAllocatedContainers--">getAggregateAllocatedContainers</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAggregatedPreemptedSecondsResources--">getAggregatedPreemptedSecondsResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAggregateMemoryMBPreempted--">getAggregateMemoryMBPreempted</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAggregateMemoryMBSecondsPreempted--">getAggregateMemoryMBSecondsPreempted</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAggregateNodeLocalContainersAllocated--">getAggregateNodeLocalContainersAllocated</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAggregateOffSwitchContainersAllocated--">getAggregateOffSwitchContainersAllocated</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAggregatePreemptedContainers--">getAggregatePreemptedContainers</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAggregateRackLocalContainersAllocated--">getAggregateRackLocalContainersAllocated</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAggregateVcoreSecondsPreempted--">getAggregateVcoreSecondsPreempted</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAggregateVcoresPreempted--">getAggregateVcoresPreempted</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAllocatedContainers--">getAllocatedContainers</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAllocatedMB--">getAllocatedMB</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAllocatedResources--">getAllocatedResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAllocatedVirtualCores--">getAllocatedVirtualCores</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAppsCompleted--">getAppsCompleted</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAppsFailed--">getAppsFailed</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAppsKilled--">getAppsKilled</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAppsPending--">getAppsPending</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAppsRunning--">getAppsRunning</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAppsSubmitted--">getAppsSubmitted</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAvailableMB--">getAvailableMB</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAvailableResources--">getAvailableResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getAvailableVirtualCores--">getAvailableVirtualCores</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getMetrics-org.apache.hadoop.metrics2.MetricsCollector-boolean-">getMetrics</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getMetricsSystem--">getMetricsSystem</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getParentQueue--">getParentQueue</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getPartitionQueueMetrics-java.lang.String-">getPartitionQueueMetrics</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getPendingContainers--">getPendingContainers</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getPendingMB--">getPendingMB</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getPendingResources--">getPendingResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getPendingVirtualCores--">getPendingVirtualCores</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getQueueMetrics--">getQueueMetrics</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getQueueMetricsForCustomResources--">getQueueMetricsForCustomResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getReservedContainers--">getReservedContainers</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getReservedMB--">getReservedMB</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getReservedResources--">getReservedResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getReservedVirtualCores--">getReservedVirtualCores</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#getUserMetrics-java.lang.String-">getUserMetrics</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#incrActiveUsers--">incrActiveUsers</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#incrNodeTypeAggregations-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.scheduler.NodeType-">incrNodeTypeAggregations</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#incrPendingResources-java.lang.String-java.lang.String-int-org.apache.hadoop.yarn.api.records.Resource-">incrPendingResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#incrReserveResources-org.apache.hadoop.yarn.api.records.Resource-">incrReserveResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#internalAllocateResources-java.lang.String-java.lang.String-int-org.apache.hadoop.yarn.api.records.Resource-boolean-">internalAllocateResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#internalDecrPendingResources-java.lang.String-java.lang.String-int-org.apache.hadoop.yarn.api.records.Resource-">internalDecrPendingResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#internalIncrPendingResources-java.lang.String-java.lang.String-int-org.apache.hadoop.yarn.api.records.Resource-">internalIncrPendingResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#internalReleaseResources-java.lang.String-java.lang.String-int-org.apache.hadoop.yarn.api.records.Resource-">internalReleaseResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#internalReserveResources-java.lang.String-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">internalReserveResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#internalUnReserveResources-java.lang.String-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">internalUnReserveResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#moveAppFrom-org.apache.hadoop.yarn.server.resourcemanager.scheduler.AppSchedulingInfo-">moveAppFrom</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#moveAppTo-org.apache.hadoop.yarn.server.resourcemanager.scheduler.AppSchedulingInfo-">moveAppTo</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#preemptContainer--">preemptContainer</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#registerCustomResources--">registerCustomResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#releaseResources-java.lang.String-java.lang.String-int-org.apache.hadoop.yarn.api.records.Resource-">releaseResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#reserveResource-java.lang.String-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">reserveResource</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#runAppAttempt-org.apache.hadoop.yarn.api.records.ApplicationId-java.lang.String-">runAppAttempt</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#setAvailableResources-org.apache.hadoop.yarn.api.records.Resource-">setAvailableResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#setAvailableResourcesToQueue-org.apache.hadoop.yarn.api.records.Resource-">setAvailableResourcesToQueue</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#setAvailableResourcesToQueue-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">setAvailableResourcesToQueue</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#setAvailableResourcesToUser-java.lang.String-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">setAvailableResourcesToUser</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#setParent-org.apache.hadoop.yarn.server.resourcemanager.scheduler.QueueMetrics-">setParent</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#setQueueMetricsForCustomResources-org.apache.hadoop.yarn.server.resourcemanager.scheduler.QueueMetricsForCustomResources-">setQueueMetricsForCustomResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#sourceName-java.lang.String-">sourceName</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#submitApp-java.lang.String-">submitApp</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#submitAppAttempt-java.lang.String-">submitAppAttempt</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#tag-org.apache.hadoop.metrics2.MetricsInfo-java.lang.String-">tag</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#unreserveResource-java.lang.String-java.lang.String-org.apache.hadoop.yarn.api.records.Resource-">unreserveResource</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#updatePreemptedForCustomResources-org.apache.hadoop.yarn.api.records.Resource-">updatePreemptedForCustomResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#updatePreemptedMemoryMBSeconds-long-">updatePreemptedMemoryMBSeconds</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#updatePreemptedResources-org.apache.hadoop.yarn.api.records.Resource-">updatePreemptedResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#updatePreemptedSecondsForCustomResources-org.apache.hadoop.yarn.api.records.Resource-long-">updatePreemptedSecondsForCustomResources</a>, <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html#updatePreemptedVcoreSeconds-long-">updatePreemptedVcoreSeconds</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<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></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="getFairShare--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFairShare</h4> |
| <pre>public org.apache.hadoop.yarn.api.records.Resource getFairShare()</pre> |
| <div class="block">Get instantaneous fair share of the queue.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the returned <code>Resource</code> also contains custom resource types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFairShare-org.apache.hadoop.yarn.api.records.Resource-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFairShare</h4> |
| <pre>public void setFairShare(org.apache.hadoop.yarn.api.records.Resource resource)</pre> |
| <div class="block">Set instantaneous fair share of the queue.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - the passed <code>Resource</code> object may also contain custom |
| resource types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSteadyFairShareMB--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSteadyFairShareMB</h4> |
| <pre>public long getSteadyFairShareMB()</pre> |
| </li> |
| </ul> |
| <a name="getSteadyFairShareVCores--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSteadyFairShareVCores</h4> |
| <pre>public long getSteadyFairShareVCores()</pre> |
| </li> |
| </ul> |
| <a name="getSteadyFairShare--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSteadyFairShare</h4> |
| <pre>public org.apache.hadoop.yarn.api.records.Resource getSteadyFairShare()</pre> |
| <div class="block">Get steady fair share for queue.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the returned <code>Resource</code> also contains custom resource types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSteadyFairShare-org.apache.hadoop.yarn.api.records.Resource-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSteadyFairShare</h4> |
| <pre>public void setSteadyFairShare(org.apache.hadoop.yarn.api.records.Resource resource)</pre> |
| <div class="block">Set steady fair share for queue.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - the passed <code>Resource</code> object may also contain custom |
| resource types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMinShareMB--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinShareMB</h4> |
| <pre>public long getMinShareMB()</pre> |
| </li> |
| </ul> |
| <a name="getMinShareVirtualCores--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinShareVirtualCores</h4> |
| <pre>public long getMinShareVirtualCores()</pre> |
| </li> |
| </ul> |
| <a name="getMinShare--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinShare</h4> |
| <pre>public org.apache.hadoop.yarn.api.records.Resource getMinShare()</pre> |
| <div class="block">Get minimum required resource share for queue.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the returned <code>Resource</code> also contains custom resource types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMinShare-org.apache.hadoop.yarn.api.records.Resource-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMinShare</h4> |
| <pre>public void setMinShare(org.apache.hadoop.yarn.api.records.Resource resource)</pre> |
| <div class="block">Set minimum required resource share for queue.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - the passed <code>Resource</code> object may also contain custom |
| resource types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxShareMB--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxShareMB</h4> |
| <pre>public long getMaxShareMB()</pre> |
| </li> |
| </ul> |
| <a name="getMaxShareVirtualCores--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxShareVirtualCores</h4> |
| <pre>public long getMaxShareVirtualCores()</pre> |
| </li> |
| </ul> |
| <a name="getMaxShare--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxShare</h4> |
| <pre>public org.apache.hadoop.yarn.api.records.Resource getMaxShare()</pre> |
| <div class="block">Get maximum allowed resource share for queue.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the returned <code>Resource</code> also contains custom resource types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxShare-org.apache.hadoop.yarn.api.records.Resource-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxShare</h4> |
| <pre>public void setMaxShare(org.apache.hadoop.yarn.api.records.Resource resource)</pre> |
| <div class="block">Set maximum allowed resource share for queue.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - the passed <code>Resource</code> object may also contain custom |
| resource types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxApps--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxApps</h4> |
| <pre>public int getMaxApps()</pre> |
| </li> |
| </ul> |
| <a name="setMaxApps-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxApps</h4> |
| <pre>public void setMaxApps(int max)</pre> |
| </li> |
| </ul> |
| <a name="getMaxAMShareMB--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxAMShareMB</h4> |
| <pre>public long getMaxAMShareMB()</pre> |
| <div class="block">Get the maximum memory size AM can use in MB.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum memory size AM can use</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxAMShareVCores--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxAMShareVCores</h4> |
| <pre>public int getMaxAMShareVCores()</pre> |
| <div class="block">Get the maximum number of VCores AM can use.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum number of VCores AM can use</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxAMShare--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxAMShare</h4> |
| <pre>public org.apache.hadoop.yarn.api.records.Resource getMaxAMShare()</pre> |
| <div class="block">Get maximum resource AM can use.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the returned <code>Resource</code> also contains custom resource types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxAMShare-org.apache.hadoop.yarn.api.records.Resource-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxAMShare</h4> |
| <pre>public void setMaxAMShare(org.apache.hadoop.yarn.api.records.Resource resource)</pre> |
| <div class="block">Set the maximum resource AM can use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - the passed <code>Resource</code> object may also contain custom |
| resource types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAMResourceUsageMB--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAMResourceUsageMB</h4> |
| <pre>public long getAMResourceUsageMB()</pre> |
| <div class="block">Get the AM memory usage in MB.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the AM memory usage</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAMResourceUsageVCores--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAMResourceUsageVCores</h4> |
| <pre>public int getAMResourceUsageVCores()</pre> |
| <div class="block">Get the AM VCore usage.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the AM VCore usage</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAMResourceUsage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAMResourceUsage</h4> |
| <pre>public org.apache.hadoop.yarn.api.records.Resource getAMResourceUsage()</pre> |
| <div class="block">Get resource usage of the AM.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the returned <code>Resource</code> also contains custom resource types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAMResourceUsage-org.apache.hadoop.yarn.api.records.Resource-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAMResourceUsage</h4> |
| <pre>public void setAMResourceUsage(org.apache.hadoop.yarn.api.records.Resource resource)</pre> |
| <div class="block">Set the AM resource usage.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - the passed <code>Resource</code> object may also contain custom |
| resource types</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSchedulingPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchedulingPolicy</h4> |
| <pre>@Metric(value="Scheduling policy") |
| public <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> getSchedulingPolicy()</pre> |
| <div class="block">Get the scheduling policy.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the scheduling policy</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSchedulingPolicy-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchedulingPolicy</h4> |
| <pre>public void setSchedulingPolicy(<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> policy)</pre> |
| </li> |
| </ul> |
| <a name="forQueue-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.scheduler.Queue-boolean-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forQueue</h4> |
| <pre>public static <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair">FSQueueMetrics</a> forQueue(<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, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">Queue</a> parent, |
| boolean enableUserMetrics, |
| org.apache.hadoop.conf.Configuration conf)</pre> |
| </li> |
| </ul> |
| <a name="forQueue-org.apache.hadoop.metrics2.MetricsSystem-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.scheduler.Queue-boolean-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>forQueue</h4> |
| <pre>public static <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair">FSQueueMetrics</a> forQueue(org.apache.hadoop.metrics2.MetricsSystem ms, |
| <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, |
| <a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/Queue.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">Queue</a> parent, |
| boolean enableUserMetrics, |
| org.apache.hadoop.conf.Configuration conf)</pre> |
| <div class="block">Get the FS queue metric for the given queue. Create one and register it to |
| metrics system if there isn't one for the queue.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ms</code> - the metric system</dd> |
| <dd><code>queueName</code> - queue name</dd> |
| <dd><code>parent</code> - parent queue</dd> |
| <dd><code>enableUserMetrics</code> - if user metrics is needed</dd> |
| <dd><code>conf</code> - configuration</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an FSQueueMetrics object</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/FSQueueMetrics.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/fair/FSQueue.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueType.html" title="enum in org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSQueueMetrics.html" target="_top">Frames</a></li> |
| <li><a href="FSQueueMetrics.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><a href="#fields.inherited.from.class.org.apache.hadoop.yarn.server.resourcemanager.scheduler.QueueMetrics">Field</a> | </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> |