Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-server / hadoop-yarn-server-resourcemanager / apidocs / org / apache / hadoop / yarn / server / resourcemanager / reservation / InMemoryPlan.html
blob: 57bee50e0a88828697005ab5c8d0b9291a99a355 [file] [log] [blame]
<!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:11 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InMemoryPlan (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="InMemoryPlan (Apache Hadoop YARN ResourceManager 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"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,"i28":10,"i29":10,"i30":10,"i31":10};
var tabs = {65535:["t0","All 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/InMemoryPlan.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/reservation/FairSchedulerPlanFollower.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryReservationAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html" target="_top">Frames</a></li>
<li><a href="InMemoryPlan.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.reservation</div>
<h2 title="Class InMemoryPlan" class="title">Class InMemoryPlan</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>org.apache.hadoop.yarn.server.resourcemanager.reservation.InMemoryPlan</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/Plan.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">Plan</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanContext</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanEdit</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">InMemoryPlan</span>
extends <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>
implements <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/Plan.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">Plan</a></pre>
<div class="block">This class represents an in memory representation of the state of our
reservation system, and provides accelerated access to both individual
reservations and aggregate utilization of resources over time.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#InMemoryPlan-org.apache.hadoop.yarn.server.resourcemanager.scheduler.QueueMetrics-org.apache.hadoop.yarn.server.resourcemanager.reservation.SharingPolicy-org.apache.hadoop.yarn.server.resourcemanager.reservation.planning.ReservationAgent-org.apache.hadoop.yarn.api.records.Resource-long-org.apache.hadoop.yarn.util.resource.ResourceCalculator-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.api.records.Resource-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.reservation.planning.Planner-boolean-long-org.apache.hadoop.yarn.server.resourcemanager.RMContext-">InMemoryPlan</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueMetrics</a>&nbsp;queueMetrics,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/SharingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">SharingPolicy</a>&nbsp;policy,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/ReservationAgent.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">ReservationAgent</a>&nbsp;agent,
org.apache.hadoop.yarn.api.records.Resource&nbsp;totalCapacity,
long&nbsp;step,
org.apache.hadoop.yarn.util.resource.ResourceCalculator&nbsp;resCalc,
org.apache.hadoop.yarn.api.records.Resource&nbsp;minAlloc,
org.apache.hadoop.yarn.api.records.Resource&nbsp;maxAlloc,
<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>&nbsp;queueName,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/Planner.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">Planner</a>&nbsp;replanner,
boolean&nbsp;getMoveOnExpiry,
long&nbsp;maxPeriodicity,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">RMContext</a>&nbsp;rmContext)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#InMemoryPlan-org.apache.hadoop.yarn.server.resourcemanager.scheduler.QueueMetrics-org.apache.hadoop.yarn.server.resourcemanager.reservation.SharingPolicy-org.apache.hadoop.yarn.server.resourcemanager.reservation.planning.ReservationAgent-org.apache.hadoop.yarn.api.records.Resource-long-org.apache.hadoop.yarn.util.resource.ResourceCalculator-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.api.records.Resource-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.reservation.planning.Planner-boolean-long-org.apache.hadoop.yarn.server.resourcemanager.RMContext-org.apache.hadoop.yarn.util.Clock-">InMemoryPlan</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueMetrics</a>&nbsp;queueMetrics,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/SharingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">SharingPolicy</a>&nbsp;policy,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/ReservationAgent.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">ReservationAgent</a>&nbsp;agent,
org.apache.hadoop.yarn.api.records.Resource&nbsp;totalCapacity,
long&nbsp;step,
org.apache.hadoop.yarn.util.resource.ResourceCalculator&nbsp;resCalc,
org.apache.hadoop.yarn.api.records.Resource&nbsp;minAlloc,
org.apache.hadoop.yarn.api.records.Resource&nbsp;maxAlloc,
<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>&nbsp;queueName,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/Planner.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">Planner</a>&nbsp;replanner,
boolean&nbsp;getMoveOnExpiry,
long&nbsp;maxPeriodicty,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">RMContext</a>&nbsp;rmContext,
org.apache.hadoop.yarn.util.Clock&nbsp;clock)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#InMemoryPlan-org.apache.hadoop.yarn.server.resourcemanager.scheduler.QueueMetrics-org.apache.hadoop.yarn.server.resourcemanager.reservation.SharingPolicy-org.apache.hadoop.yarn.server.resourcemanager.reservation.planning.ReservationAgent-org.apache.hadoop.yarn.api.records.Resource-long-org.apache.hadoop.yarn.util.resource.ResourceCalculator-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.api.records.Resource-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.reservation.planning.Planner-boolean-org.apache.hadoop.yarn.server.resourcemanager.RMContext-">InMemoryPlan</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueMetrics</a>&nbsp;queueMetrics,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/SharingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">SharingPolicy</a>&nbsp;policy,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/ReservationAgent.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">ReservationAgent</a>&nbsp;agent,
org.apache.hadoop.yarn.api.records.Resource&nbsp;totalCapacity,
long&nbsp;step,
org.apache.hadoop.yarn.util.resource.ResourceCalculator&nbsp;resCalc,
org.apache.hadoop.yarn.api.records.Resource&nbsp;minAlloc,
org.apache.hadoop.yarn.api.records.Resource&nbsp;maxAlloc,
<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>&nbsp;queueName,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/Planner.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">Planner</a>&nbsp;replanner,
boolean&nbsp;getMoveOnExpiry,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">RMContext</a>&nbsp;rmContext)</code>&nbsp;</td>
</tr>
</table>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#addReservation-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationAllocation-boolean-">addReservation</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&nbsp;reservation,
boolean&nbsp;isRecovering)</code>
<div class="block">Add a new <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> to the plan.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#archiveCompletedReservations-long-">archiveCompletedReservations</a></span>(long&nbsp;tick)</code>
<div class="block">Method invoked to garbage collect old reservations.</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/reservation/InMemoryPlan.html#deleteReservation-org.apache.hadoop.yarn.api.records.ReservationId-">deleteReservation</a></span>(org.apache.hadoop.yarn.api.records.ReservationId&nbsp;reservationID)</code>
<div class="block">Delete an existing <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> from the plan identified
uniquely by its <code>ReservationId</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<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>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getAllReservations--">getAllReservations</a></span>()</code>
<div class="block">Gets all the reservations in the plan</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getAvailableResourceOverTime-java.lang.String-org.apache.hadoop.yarn.api.records.ReservationId-long-long-long-">getAvailableResourceOverTime</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>&nbsp;user,
org.apache.hadoop.yarn.api.records.ReservationId&nbsp;oldId,
long&nbsp;start,
long&nbsp;end,
long&nbsp;period)</code>
<div class="block">This method returns the amount of resources available to a given user
(optionally if removing a certain reservation) over the start-end time
range.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getConsumptionForUserOverTime-java.lang.String-long-long-">getConsumptionForUserOverTime</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>&nbsp;user,
long&nbsp;start,
long&nbsp;end)</code>
<div class="block">This method returns a RLE encoded view of the user reservation utilization
between start and end time.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getCumulativeLoadOverTime-long-long-">getCumulativeLoadOverTime</a></span>(long&nbsp;start,
long&nbsp;end)</code>
<div class="block">Get the cumulative load over a time interval.</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/reservation/InMemoryPlan.html#getEarliestStartTime--">getEarliestStartTime</a></span>()</code>
<div class="block">Gets the time (UTC in ms) at which the first reservation starts</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getLastEndTime--">getLastEndTime</a></span>()</code>
<div class="block">Returns the time (UTC in ms) at which the last reservation terminates</div>
</td>
</tr>
<tr id="i9" 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/reservation/InMemoryPlan.html#getMaximumAllocation--">getMaximumAllocation</a></span>()</code>
<div class="block">Returns the single largest <code>Resource</code> allocation that can be reserved
in this plan</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getMaximumPeriodicity--">getMaximumPeriodicity</a></span>()</code>
<div class="block">Returns the maximum periodicity allowed in a recurrence expression
for reservations of a particular plan.</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/reservation/InMemoryPlan.html#getMinimumAllocation--">getMinimumAllocation</a></span>()</code>
<div class="block">Returns the single smallest <code>Resource</code> allocation that can be
reserved in this plan</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getMoveOnExpiry--">getMoveOnExpiry</a></span>()</code>
<div class="block">Instructs the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanFollower.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>PlanFollower</code></a> on what to do for applications
which are still running when the reservation is expiring (move-to-default
vs kill)</div>
</td>
</tr>
<tr id="i13" 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/reservation/InMemoryPlan.html#getQueueMetrics--">getQueueMetrics</a></span>()</code>
<div class="block">Return the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><code>QueueMetrics</code></a> for the queue in the
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceScheduler.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><code>ResourceScheduler</code></a> corresponding to this plan</div>
</td>
</tr>
<tr id="i14" 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/reservation/InMemoryPlan.html#getQueueName--">getQueueName</a></span>()</code>
<div class="block">Return the name of the queue in the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceScheduler.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><code>ResourceScheduler</code></a> corresponding
to this plan</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/Planner.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">Planner</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getReplanner--">getReplanner</a></span>()</code>
<div class="block">Return an instance of a <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/Planner.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning"><code>Planner</code></a>, which will be invoked in response
to unexpected reduction in the resources of this plan</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/ReservationAgent.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">ReservationAgent</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getReservationAgent--">getReservationAgent</a></span>()</code>
<div class="block">Return the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/ReservationAgent.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning"><code>ReservationAgent</code></a> configured for this plan that is
responsible for optimally placing various reservation requests</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getReservationById-org.apache.hadoop.yarn.api.records.ReservationId-">getReservationById</a></span>(org.apache.hadoop.yarn.api.records.ReservationId&nbsp;reservationID)</code>
<div class="block">Return a <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> identified by its
<code>ReservationId</code></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>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getReservationByUserAtTime-java.lang.String-long-">getReservationByUserAtTime</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>&nbsp;user,
long&nbsp;t)</code>
<div class="block">Return a set of <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> that belongs to a certain
user and overlaps time t.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getReservationCountForUserOverTime-java.lang.String-long-long-">getReservationCountForUserOverTime</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>&nbsp;user,
long&nbsp;start,
long&nbsp;end)</code>
<div class="block">This method returns a RLE encoded view of the user reservation count
utilization between start and end time.</div>
</td>
</tr>
<tr id="i20" 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>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getReservations-org.apache.hadoop.yarn.api.records.ReservationId-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationInterval-">getReservations</a></span>(org.apache.hadoop.yarn.api.records.ReservationId&nbsp;reservationID,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationInterval.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationInterval</a>&nbsp;interval)</code>
<div class="block">Return a set of <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> identified by any user.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<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>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getReservations-org.apache.hadoop.yarn.api.records.ReservationId-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationInterval-java.lang.String-">getReservations</a></span>(org.apache.hadoop.yarn.api.records.ReservationId&nbsp;reservationID,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationInterval.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationInterval</a>&nbsp;interval,
<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>&nbsp;user)</code>
<div class="block">Return a set of <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> identified by the user who
made the reservation.</div>
</td>
</tr>
<tr id="i22" 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>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getReservationsAtTime-long-">getReservationsAtTime</a></span>(long&nbsp;tick)</code>
<div class="block">Gets all the active reservations at the specified point of time</div>
</td>
</tr>
<tr id="i23" 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/reservation/InMemoryPlan.html#getResourceCalculator--">getResourceCalculator</a></span>()</code>
<div class="block">Returns the system <code>ResourceCalculator</code></div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/SharingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">SharingPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getSharingPolicy--">getSharingPolicy</a></span>()</code>
<div class="block">Return the configured <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/SharingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>SharingPolicy</code></a> that governs the sharing of the
resources of the plan between its various users</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#getStep--">getStep</a></span>()</code>
<div class="block">Returns the configured "step" or granularity of time of the plan in millis.</div>
</td>
</tr>
<tr id="i26" 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/reservation/InMemoryPlan.html#getTotalCapacity--">getTotalCapacity</a></span>()</code>
<div class="block">Returns the overall capacity in terms of <code>Resource</code> assigned to this
plan (typically will correspond to the absolute capacity of the
corresponding queue).</div>
</td>
</tr>
<tr id="i27" 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/reservation/InMemoryPlan.html#getTotalCommittedResources-long-">getTotalCommittedResources</a></span>(long&nbsp;t)</code>
<div class="block">Returns the total <code>Resource</code> reserved for all users at the specified
time</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/reservation/InMemoryPlan.html#setTotalCapacity-org.apache.hadoop.yarn.api.records.Resource-">setTotalCapacity</a></span>(org.apache.hadoop.yarn.api.records.Resource&nbsp;cap)</code>
<div class="block">Sets the overall capacity in terms of <code>Resource</code> assigned to this
plan.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<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/reservation/InMemoryPlan.html#toCumulativeString--">toCumulativeString</a></span>()</code>&nbsp;</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/reservation/InMemoryPlan.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html#updateReservation-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationAllocation-">updateReservation</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&nbsp;reservation)</code>
<div class="block">Updates an existing <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> in the plan.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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#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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="InMemoryPlan-org.apache.hadoop.yarn.server.resourcemanager.scheduler.QueueMetrics-org.apache.hadoop.yarn.server.resourcemanager.reservation.SharingPolicy-org.apache.hadoop.yarn.server.resourcemanager.reservation.planning.ReservationAgent-org.apache.hadoop.yarn.api.records.Resource-long-org.apache.hadoop.yarn.util.resource.ResourceCalculator-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.api.records.Resource-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.reservation.planning.Planner-boolean-org.apache.hadoop.yarn.server.resourcemanager.RMContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>InMemoryPlan</h4>
<pre>public&nbsp;InMemoryPlan(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueMetrics</a>&nbsp;queueMetrics,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/SharingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">SharingPolicy</a>&nbsp;policy,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/ReservationAgent.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">ReservationAgent</a>&nbsp;agent,
org.apache.hadoop.yarn.api.records.Resource&nbsp;totalCapacity,
long&nbsp;step,
org.apache.hadoop.yarn.util.resource.ResourceCalculator&nbsp;resCalc,
org.apache.hadoop.yarn.api.records.Resource&nbsp;minAlloc,
org.apache.hadoop.yarn.api.records.Resource&nbsp;maxAlloc,
<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>&nbsp;queueName,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/Planner.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">Planner</a>&nbsp;replanner,
boolean&nbsp;getMoveOnExpiry,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">RMContext</a>&nbsp;rmContext)</pre>
</li>
</ul>
<a name="InMemoryPlan-org.apache.hadoop.yarn.server.resourcemanager.scheduler.QueueMetrics-org.apache.hadoop.yarn.server.resourcemanager.reservation.SharingPolicy-org.apache.hadoop.yarn.server.resourcemanager.reservation.planning.ReservationAgent-org.apache.hadoop.yarn.api.records.Resource-long-org.apache.hadoop.yarn.util.resource.ResourceCalculator-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.api.records.Resource-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.reservation.planning.Planner-boolean-long-org.apache.hadoop.yarn.server.resourcemanager.RMContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>InMemoryPlan</h4>
<pre>public&nbsp;InMemoryPlan(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueMetrics</a>&nbsp;queueMetrics,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/SharingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">SharingPolicy</a>&nbsp;policy,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/ReservationAgent.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">ReservationAgent</a>&nbsp;agent,
org.apache.hadoop.yarn.api.records.Resource&nbsp;totalCapacity,
long&nbsp;step,
org.apache.hadoop.yarn.util.resource.ResourceCalculator&nbsp;resCalc,
org.apache.hadoop.yarn.api.records.Resource&nbsp;minAlloc,
org.apache.hadoop.yarn.api.records.Resource&nbsp;maxAlloc,
<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>&nbsp;queueName,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/Planner.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">Planner</a>&nbsp;replanner,
boolean&nbsp;getMoveOnExpiry,
long&nbsp;maxPeriodicity,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">RMContext</a>&nbsp;rmContext)</pre>
</li>
</ul>
<a name="InMemoryPlan-org.apache.hadoop.yarn.server.resourcemanager.scheduler.QueueMetrics-org.apache.hadoop.yarn.server.resourcemanager.reservation.SharingPolicy-org.apache.hadoop.yarn.server.resourcemanager.reservation.planning.ReservationAgent-org.apache.hadoop.yarn.api.records.Resource-long-org.apache.hadoop.yarn.util.resource.ResourceCalculator-org.apache.hadoop.yarn.api.records.Resource-org.apache.hadoop.yarn.api.records.Resource-java.lang.String-org.apache.hadoop.yarn.server.resourcemanager.reservation.planning.Planner-boolean-long-org.apache.hadoop.yarn.server.resourcemanager.RMContext-org.apache.hadoop.yarn.util.Clock-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>InMemoryPlan</h4>
<pre>public&nbsp;InMemoryPlan(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueMetrics</a>&nbsp;queueMetrics,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/SharingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">SharingPolicy</a>&nbsp;policy,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/ReservationAgent.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">ReservationAgent</a>&nbsp;agent,
org.apache.hadoop.yarn.api.records.Resource&nbsp;totalCapacity,
long&nbsp;step,
org.apache.hadoop.yarn.util.resource.ResourceCalculator&nbsp;resCalc,
org.apache.hadoop.yarn.api.records.Resource&nbsp;minAlloc,
org.apache.hadoop.yarn.api.records.Resource&nbsp;maxAlloc,
<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>&nbsp;queueName,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/Planner.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">Planner</a>&nbsp;replanner,
boolean&nbsp;getMoveOnExpiry,
long&nbsp;maxPeriodicty,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">RMContext</a>&nbsp;rmContext,
org.apache.hadoop.yarn.util.Clock&nbsp;clock)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getQueueMetrics--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueMetrics</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler">QueueMetrics</a>&nbsp;getQueueMetrics()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getQueueMetrics--">PlanContext</a></code></span></div>
<div class="block">Return the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><code>QueueMetrics</code></a> for the queue in the
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceScheduler.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><code>ResourceScheduler</code></a> corresponding to this plan</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getQueueMetrics--">getQueueMetrics</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanContext</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/QueueMetrics.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><code>QueueMetrics</code></a> for the queue in the
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceScheduler.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><code>ResourceScheduler</code></a> corresponding to this plan</dd>
</dl>
</li>
</ul>
<a name="getAllReservations--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllReservations</h4>
<pre>public&nbsp;<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>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&gt;&nbsp;getAllReservations()</pre>
<div class="block">Gets all the reservations in the plan</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>set of all reservations handled by this Plan</dd>
</dl>
</li>
</ul>
<a name="addReservation-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationAllocation-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addReservation</h4>
<pre>public&nbsp;boolean&nbsp;addReservation(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&nbsp;reservation,
boolean&nbsp;isRecovering)
throws <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/exceptions/PlanningException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation.exceptions">PlanningException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html#addReservation-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationAllocation-boolean-">PlanEdit</a></code></span></div>
<div class="block">Add a new <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> to the plan.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html#addReservation-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationAllocation-boolean-">addReservation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanEdit</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reservation</code> - the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> to be added to the
plan</dd>
<dd><code>isRecovering</code> - flag to indicate if reservation is being added as part
of failover or not</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if addition is successful, false otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/exceptions/PlanningException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation.exceptions">PlanningException</a></code> - if addition is unsuccessful</dd>
</dl>
</li>
</ul>
<a name="updateReservation-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationAllocation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateReservation</h4>
<pre>public&nbsp;boolean&nbsp;updateReservation(<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&nbsp;reservation)
throws <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/exceptions/PlanningException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation.exceptions">PlanningException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html#updateReservation-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationAllocation-">PlanEdit</a></code></span></div>
<div class="block">Updates an existing <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> in the plan. This is
required for re-negotiation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html#updateReservation-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationAllocation-">updateReservation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanEdit</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reservation</code> - the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> to be updated the plan</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if update is successful, false otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/exceptions/PlanningException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation.exceptions">PlanningException</a></code> - if update is unsuccessful</dd>
</dl>
</li>
</ul>
<a name="deleteReservation-org.apache.hadoop.yarn.api.records.ReservationId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteReservation</h4>
<pre>public&nbsp;boolean&nbsp;deleteReservation(org.apache.hadoop.yarn.api.records.ReservationId&nbsp;reservationID)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html#deleteReservation-org.apache.hadoop.yarn.api.records.ReservationId-">PlanEdit</a></code></span></div>
<div class="block">Delete an existing <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> from the plan identified
uniquely by its <code>ReservationId</code>. This will generally be used for
garbage collection.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html#deleteReservation-org.apache.hadoop.yarn.api.records.ReservationId-">deleteReservation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanEdit</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reservationID</code> - the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> to be deleted from
the plan identified uniquely by its <code>ReservationId</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if delete is successful, false otherwise</dd>
</dl>
</li>
</ul>
<a name="archiveCompletedReservations-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>archiveCompletedReservations</h4>
<pre>public&nbsp;void&nbsp;archiveCompletedReservations(long&nbsp;tick)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html#archiveCompletedReservations-long-">PlanEdit</a></code></span></div>
<div class="block">Method invoked to garbage collect old reservations. It cleans up expired
reservations that have fallen out of the sliding archival window.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html#archiveCompletedReservations-long-">archiveCompletedReservations</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanEdit</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tick</code> - the current time from which the archival window is computed</dd>
</dl>
</li>
</ul>
<a name="getReservationsAtTime-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReservationsAtTime</h4>
<pre>public&nbsp;<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>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&gt;&nbsp;getReservationsAtTime(long&nbsp;tick)</pre>
<div class="block">Gets all the active reservations at the specified point of time</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tick</code> - the time (UTC in ms) for which the active reservations are
requested</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>set of active reservations at the specified time</dd>
</dl>
</li>
</ul>
<a name="getStep--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStep</h4>
<pre>public&nbsp;long&nbsp;getStep()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getStep--">PlanContext</a></code></span></div>
<div class="block">Returns the configured "step" or granularity of time of the plan in millis.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getStep--">getStep</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanContext</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>plan step in millis</dd>
</dl>
</li>
</ul>
<a name="getSharingPolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSharingPolicy</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/SharingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">SharingPolicy</a>&nbsp;getSharingPolicy()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getSharingPolicy--">PlanContext</a></code></span></div>
<div class="block">Return the configured <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/SharingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>SharingPolicy</code></a> that governs the sharing of the
resources of the plan between its various users</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getSharingPolicy--">getSharingPolicy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanContext</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/SharingPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>SharingPolicy</code></a> that governs the sharing of
the resources of the plan between its various users</dd>
</dl>
</li>
</ul>
<a name="getReservationAgent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReservationAgent</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/ReservationAgent.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">ReservationAgent</a>&nbsp;getReservationAgent()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getReservationAgent--">PlanContext</a></code></span></div>
<div class="block">Return the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/ReservationAgent.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning"><code>ReservationAgent</code></a> configured for this plan that is
responsible for optimally placing various reservation requests</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getReservationAgent--">getReservationAgent</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanContext</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/ReservationAgent.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning"><code>ReservationAgent</code></a> configured for this plan</dd>
</dl>
</li>
</ul>
<a name="getReservationCountForUserOverTime-java.lang.String-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReservationCountForUserOverTime</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a>&nbsp;getReservationCountForUserOverTime(<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>&nbsp;user,
long&nbsp;start,
long&nbsp;end)</pre>
<div class="block">This method returns a RLE encoded view of the user reservation count
utilization between start and end time.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user being considered</dd>
<dd><code>start</code> - start of the time interval.</dd>
<dd><code>end</code> - end of the time interval.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>RLE encoded view of reservation used over time</dd>
</dl>
</li>
</ul>
<a name="getConsumptionForUserOverTime-java.lang.String-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConsumptionForUserOverTime</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a>&nbsp;getConsumptionForUserOverTime(<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>&nbsp;user,
long&nbsp;start,
long&nbsp;end)</pre>
<div class="block">This method returns a RLE encoded view of the user reservation utilization
between start and end time.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user being considered</dd>
<dd><code>start</code> - start of the time interval.</dd>
<dd><code>end</code> - end of the time interval.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>RLE encoded view of resources used over time</dd>
</dl>
</li>
</ul>
<a name="getTotalCommittedResources-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalCommittedResources</h4>
<pre>public&nbsp;org.apache.hadoop.yarn.api.records.Resource&nbsp;getTotalCommittedResources(long&nbsp;t)</pre>
<div class="block">Returns the total <code>Resource</code> reserved for all users at the specified
time</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>t</code> - the time (UTC in ms) for which the reserved resources are
requested</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the total <code>Resource</code> reserved for all users at the specified
time</dd>
</dl>
</li>
</ul>
<a name="getReservations-org.apache.hadoop.yarn.api.records.ReservationId-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationInterval-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReservations</h4>
<pre>public&nbsp;<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>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&gt;&nbsp;getReservations(org.apache.hadoop.yarn.api.records.ReservationId&nbsp;reservationID,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationInterval.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationInterval</a>&nbsp;interval)</pre>
<div class="block">Return a set of <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> identified by any user.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reservationID</code> - the unqiue id to identify the
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a></dd>
<dd><code>interval</code> - the time interval used to retrieve the reservation
allocations from. Only reservations with start time no greater
than the interval end time, and end time no less than the interval
start time will be selected.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a set of <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> identified by any user</dd>
</dl>
</li>
</ul>
<a name="getReservations-org.apache.hadoop.yarn.api.records.ReservationId-org.apache.hadoop.yarn.server.resourcemanager.reservation.ReservationInterval-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReservations</h4>
<pre>public&nbsp;<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>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&gt;&nbsp;getReservations(org.apache.hadoop.yarn.api.records.ReservationId&nbsp;reservationID,
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationInterval.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationInterval</a>&nbsp;interval,
<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>&nbsp;user)</pre>
<div class="block">Return a set of <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> identified by the user who
made the reservation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reservationID</code> - the unqiue id to identify the
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a></dd>
<dd><code>interval</code> - the time interval used to retrieve the reservation
allocations from. Only reservations with start time no greater
than the interval end time, and end time no less than the interval
start time will be selected.</dd>
<dd><code>user</code> - the user to retrieve the reservation allocation from.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a set of <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> identified by the user who
made the reservation</dd>
</dl>
</li>
</ul>
<a name="getReservationById-org.apache.hadoop.yarn.api.records.ReservationId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReservationById</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&nbsp;getReservationById(org.apache.hadoop.yarn.api.records.ReservationId&nbsp;reservationID)</pre>
<div class="block">Return a <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> identified by its
<code>ReservationId</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reservationID</code> - the unique id to identify the
<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> identified by the specified id</dd>
</dl>
</li>
</ul>
<a name="getTotalCapacity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalCapacity</h4>
<pre>public&nbsp;org.apache.hadoop.yarn.api.records.Resource&nbsp;getTotalCapacity()</pre>
<div class="block">Returns the overall capacity in terms of <code>Resource</code> assigned to this
plan (typically will correspond to the absolute capacity of the
corresponding queue).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the overall capacity in terms of <code>Resource</code> assigned to this
plan</dd>
</dl>
</li>
</ul>
<a name="getAvailableResourceOverTime-java.lang.String-org.apache.hadoop.yarn.api.records.ReservationId-long-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAvailableResourceOverTime</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a>&nbsp;getAvailableResourceOverTime(<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>&nbsp;user,
org.apache.hadoop.yarn.api.records.ReservationId&nbsp;oldId,
long&nbsp;start,
long&nbsp;end,
long&nbsp;period)
throws <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/exceptions/PlanningException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation.exceptions">PlanningException</a></pre>
<div class="block">This method returns the amount of resources available to a given user
(optionally if removing a certain reservation) over the start-end time
range. If the request is periodic (period is non-zero) we return the
minimum amount of resources available to periodic reservations (in all
"period" windows within the system maxPeriod / LCM).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user being considered</dd>
<dd><code>oldId</code> - the identifier of the existing reservation</dd>
<dd><code>start</code> - start of the time interval.</dd>
<dd><code>end</code> - end of the time interval.</dd>
<dd><code>period</code> - the ms periodicty for this request (loop and pick min till
maxPeriodicity)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a view of the plan as it is available to this user</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/exceptions/PlanningException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation.exceptions">PlanningException</a></code> - if operation is unsuccessful</dd>
</dl>
</li>
</ul>
<a name="getMinimumAllocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinimumAllocation</h4>
<pre>public&nbsp;org.apache.hadoop.yarn.api.records.Resource&nbsp;getMinimumAllocation()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getMinimumAllocation--">PlanContext</a></code></span></div>
<div class="block">Returns the single smallest <code>Resource</code> allocation that can be
reserved in this plan</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getMinimumAllocation--">getMinimumAllocation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanContext</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the single smallest <code>Resource</code> allocation that can be
reserved in this plan</dd>
</dl>
</li>
</ul>
<a name="setTotalCapacity-org.apache.hadoop.yarn.api.records.Resource-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTotalCapacity</h4>
<pre>public&nbsp;void&nbsp;setTotalCapacity(org.apache.hadoop.yarn.api.records.Resource&nbsp;cap)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html#setTotalCapacity-org.apache.hadoop.yarn.api.records.Resource-">PlanEdit</a></code></span></div>
<div class="block">Sets the overall capacity in terms of <code>Resource</code> assigned to this
plan.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html#setTotalCapacity-org.apache.hadoop.yarn.api.records.Resource-">setTotalCapacity</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanEdit.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanEdit</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cap</code> - the overall capacity in terms of <code>Resource</code> assigned
to this plan</dd>
</dl>
</li>
</ul>
<a name="getEarliestStartTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEarliestStartTime</h4>
<pre>public&nbsp;long&nbsp;getEarliestStartTime()</pre>
<div class="block">Gets the time (UTC in ms) at which the first reservation starts</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the time (UTC in ms) at which the first reservation starts</dd>
</dl>
</li>
</ul>
<a name="getLastEndTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastEndTime</h4>
<pre>public&nbsp;long&nbsp;getLastEndTime()</pre>
<div class="block">Returns the time (UTC in ms) at which the last reservation terminates</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the time (UTC in ms) at which the last reservation terminates</dd>
</dl>
</li>
</ul>
<a name="getResourceCalculator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceCalculator</h4>
<pre>public&nbsp;org.apache.hadoop.yarn.util.resource.ResourceCalculator&nbsp;getResourceCalculator()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getResourceCalculator--">PlanContext</a></code></span></div>
<div class="block">Returns the system <code>ResourceCalculator</code></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getResourceCalculator--">getResourceCalculator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanContext</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the system <code>ResourceCalculator</code></dd>
</dl>
</li>
</ul>
<a name="getQueueName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueName</h4>
<pre>public&nbsp;<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>&nbsp;getQueueName()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getQueueName--">PlanContext</a></code></span></div>
<div class="block">Return the name of the queue in the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceScheduler.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><code>ResourceScheduler</code></a> corresponding
to this plan</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getQueueName--">getQueueName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanContext</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the queue in the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ResourceScheduler.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><code>ResourceScheduler</code></a>
corresponding to this plan</dd>
</dl>
</li>
</ul>
<a name="getMaximumAllocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumAllocation</h4>
<pre>public&nbsp;org.apache.hadoop.yarn.api.records.Resource&nbsp;getMaximumAllocation()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getMaximumAllocation--">PlanContext</a></code></span></div>
<div class="block">Returns the single largest <code>Resource</code> allocation that can be reserved
in this plan</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getMaximumAllocation--">getMaximumAllocation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanContext</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the single largest <code>Resource</code> allocation that can be reserved
in this plan</dd>
</dl>
</li>
</ul>
<a name="getMaximumPeriodicity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumPeriodicity</h4>
<pre>public&nbsp;long&nbsp;getMaximumPeriodicity()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getMaximumPeriodicity--">PlanContext</a></code></span></div>
<div class="block">Returns the maximum periodicity allowed in a recurrence expression
for reservations of a particular plan. This value must be divisible by
the recurrence expression of a newly submitted reservation. Otherwise, the
reservation submission will fail.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getMaximumPeriodicity--">getMaximumPeriodicity</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanContext</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum periodicity allowed in a recurrence expression for
reservations of a particular plan.</dd>
</dl>
</li>
</ul>
<a name="toCumulativeString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toCumulativeString</h4>
<pre>public&nbsp;<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>&nbsp;toCumulativeString()</pre>
</li>
</ul>
<a name="getReplanner--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReplanner</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/Planner.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning">Planner</a>&nbsp;getReplanner()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getReplanner--">PlanContext</a></code></span></div>
<div class="block">Return an instance of a <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/Planner.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning"><code>Planner</code></a>, which will be invoked in response
to unexpected reduction in the resources of this plan</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getReplanner--">getReplanner</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanContext</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of a <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/planning/Planner.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation.planning"><code>Planner</code></a>, which will be invoked in response
to unexpected reduction in the resources of this plan</dd>
</dl>
</li>
</ul>
<a name="getMoveOnExpiry--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMoveOnExpiry</h4>
<pre>public&nbsp;boolean&nbsp;getMoveOnExpiry()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getMoveOnExpiry--">PlanContext</a></code></span></div>
<div class="block">Instructs the <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanFollower.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>PlanFollower</code></a> on what to do for applications
which are still running when the reservation is expiring (move-to-default
vs kill)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html#getMoveOnExpiry--">getMoveOnExpiry</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/PlanContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">PlanContext</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if remaining applications have to be killed, false if they
have to migrated</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<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>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
</dl>
</li>
</ul>
<a name="getReservationByUserAtTime-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReservationByUserAtTime</h4>
<pre>public&nbsp;<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>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation">ReservationAllocation</a>&gt;&nbsp;getReservationByUserAtTime(<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>&nbsp;user,
long&nbsp;t)</pre>
<div class="block">Return a set of <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a> that belongs to a certain
user and overlaps time t.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user being considered</dd>
<dd><code>t</code> - the instant in time being considered</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>set of active <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/ReservationAllocation.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.reservation"><code>ReservationAllocation</code></a>s for this user at this
time</dd>
</dl>
</li>
</ul>
<a name="getCumulativeLoadOverTime-long-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCumulativeLoadOverTime</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/RLESparseResourceAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation">RLESparseResourceAllocation</a>&nbsp;getCumulativeLoadOverTime(long&nbsp;start,
long&nbsp;end)
throws <a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/exceptions/PlanningException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation.exceptions">PlanningException</a></pre>
<div class="block">Get the cumulative load over a time interval.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>start</code> - start of the time interval.</dd>
<dd><code>end</code> - end of the time interval.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>RLE sparse allocation.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/exceptions/PlanningException.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation.exceptions">PlanningException</a></code> - if operation is unsuccessful</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/InMemoryPlan.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/reservation/FairSchedulerPlanFollower.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryReservationAllocation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.reservation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/reservation/InMemoryPlan.html" target="_top">Frames</a></li>
<li><a href="InMemoryPlan.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>