Google Git
Sign in
apache / storm-site / refs/heads/asf-site / . / content / releases / current / javadocs / org / apache / storm / scheduler / multitenant / FreePool.html
blob: a5e599fce810b72caeb008b7a793dca85ea1fb75 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>FreePool (Storm 2.6.2 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.storm.scheduler.multitenant, class: FreePool">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/FreePool.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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<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>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.storm.scheduler.multitenant</a></div>
<h1 title="Class FreePool" class="title">Class FreePool</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">org.apache.storm.scheduler.multitenant.NodePool</a>
<div class="inheritance">org.apache.storm.scheduler.multitenant.FreePool</div>
</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">FreePool</span>
<span class="extends-implements">extends <a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a></span></div>
<div class="block">All of the machines that currently have nothing assigned to them.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.storm.scheduler.multitenant.NodePool">Nested classes/interfaces inherited from class&nbsp;org.apache.storm.scheduler.multitenant.<a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a></h2>
<code><a href="NodePool.NodeAndSlotCounts.html" title="class in org.apache.storm.scheduler.multitenant">NodePool.NodeAndSlotCounts</a>, <a href="NodePool.RoundRobinSlotScheduler.html" title="class in org.apache.storm.scheduler.multitenant">NodePool.RoundRobinSlotScheduler</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.storm.scheduler.multitenant.NodePool">Fields inherited from class&nbsp;org.apache.storm.scheduler.multitenant.<a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a></h3>
<code><a href="NodePool.html#cluster">cluster</a>, <a href="NodePool.html#nodeIdToNode">nodeIdToNode</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">FreePool</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addTopology(org.apache.storm.scheduler.TopologyDetails)" class="member-name-link">addTopology</a><wbr>(<a href="../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a>&nbsp;td)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add a topology to the pool.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canAdd(org.apache.storm.scheduler.TopologyDetails)" class="member-name-link">canAdd</a><wbr>(<a href="../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a>&nbsp;td)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Check if this topology can be added to this pool.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="NodePool.NodeAndSlotCounts.html" title="class in org.apache.storm.scheduler.multitenant">NodePool.NodeAndSlotCounts</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNodeAndSlotCountIfSlotsWereTaken(int)" class="member-name-link">getNodeAndSlotCountIfSlotsWereTaken</a><wbr>(int&nbsp;slotsNeeded)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the number of nodes and slots this would provide to get the slots needed.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#init(org.apache.storm.scheduler.Cluster,java.util.Map)" class="member-name-link">init</a><wbr>(<a href="../Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a>&nbsp;cluster,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="Node.html" title="class in org.apache.storm.scheduler.multitenant">Node</a>&gt;&nbsp;nodeIdToNode)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Initialize the pool.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nodesAvailable()" class="member-name-link">nodesAvailable</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the number of available nodes.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#scheduleAsNeeded(org.apache.storm.scheduler.multitenant.NodePool...)" class="member-name-link">scheduleAsNeeded</a><wbr>(<a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a>...&nbsp;lesserPools)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Reschedule any topologies as needed.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#slotsAvailable()" class="member-name-link">slotsAvailable</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get number of available slots.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="Node.html" title="class in org.apache.storm.scheduler.multitenant">Node</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#takeNodes(int)" class="member-name-link">takeNodes</a><wbr>(int&nbsp;nodesNeeded)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Take up to nodesNeeded from this pool.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="Node.html" title="class in org.apache.storm.scheduler.multitenant">Node</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#takeNodesBySlots(int)" class="member-name-link">takeNodesBySlots</a><wbr>(int&nbsp;slotsNeeded)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Take nodes from this pool that can fulfill possibly up to the slotsNeeded.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.storm.scheduler.multitenant.NodePool">Methods inherited from class&nbsp;org.apache.storm.scheduler.multitenant.<a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a></h3>
<code><a href="NodePool.html#getNodeCountIfSlotsWereTaken(int,org.apache.storm.scheduler.multitenant.NodePool%5B%5D)">getNodeCountIfSlotsWereTaken</a>, <a href="NodePool.html#nodesAvailable(org.apache.storm.scheduler.multitenant.NodePool%5B%5D)">nodesAvailable</a>, <a href="NodePool.html#slotsAvailable(org.apache.storm.scheduler.multitenant.NodePool%5B%5D)">slotsAvailable</a>, <a href="NodePool.html#takeNodes(int,org.apache.storm.scheduler.multitenant.NodePool%5B%5D)">takeNodes</a>, <a href="NodePool.html#takeNodesBySlot(int,org.apache.storm.scheduler.multitenant.NodePool%5B%5D)">takeNodesBySlot</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>FreePool</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">FreePool</span>()</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="init(org.apache.storm.scheduler.Cluster,java.util.Map)">
<h3>init</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">init</span><wbr><span class="parameters">(<a href="../Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a>&nbsp;cluster,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="Node.html" title="class in org.apache.storm.scheduler.multitenant">Node</a>&gt;&nbsp;nodeIdToNode)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="NodePool.html#init(org.apache.storm.scheduler.Cluster,java.util.Map)">NodePool</a></code></span></div>
<div class="block">Initialize the pool.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="NodePool.html#init(org.apache.storm.scheduler.Cluster,java.util.Map)">init</a></code>&nbsp;in class&nbsp;<code><a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a></code></dd>
<dt>Parameters:</dt>
<dd><code>cluster</code> - the cluster</dd>
<dd><code>nodeIdToNode</code> - the mapping of node id to nodes</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addTopology(org.apache.storm.scheduler.TopologyDetails)">
<h3>addTopology</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addTopology</span><wbr><span class="parameters">(<a href="../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a>&nbsp;td)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="NodePool.html#addTopology(org.apache.storm.scheduler.TopologyDetails)">NodePool</a></code></span></div>
<div class="block">Add a topology to the pool.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="NodePool.html#addTopology(org.apache.storm.scheduler.TopologyDetails)">addTopology</a></code>&nbsp;in class&nbsp;<code><a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a></code></dd>
<dt>Parameters:</dt>
<dd><code>td</code> - the topology to add</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="canAdd(org.apache.storm.scheduler.TopologyDetails)">
<h3>canAdd</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">canAdd</span><wbr><span class="parameters">(<a href="../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a>&nbsp;td)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="NodePool.html#canAdd(org.apache.storm.scheduler.TopologyDetails)">NodePool</a></code></span></div>
<div class="block">Check if this topology can be added to this pool.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="NodePool.html#canAdd(org.apache.storm.scheduler.TopologyDetails)">canAdd</a></code>&nbsp;in class&nbsp;<code><a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a></code></dd>
<dt>Parameters:</dt>
<dd><code>td</code> - the topology</dd>
<dt>Returns:</dt>
<dd>true if it can else false</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="takeNodes(int)">
<h3>takeNodes</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="Node.html" title="class in org.apache.storm.scheduler.multitenant">Node</a>&gt;</span>&nbsp;<span class="element-name">takeNodes</span><wbr><span class="parameters">(int&nbsp;nodesNeeded)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="NodePool.html#takeNodes(int)">NodePool</a></code></span></div>
<div class="block">Take up to nodesNeeded from this pool.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="NodePool.html#takeNodes(int)">takeNodes</a></code>&nbsp;in class&nbsp;<code><a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a></code></dd>
<dt>Parameters:</dt>
<dd><code>nodesNeeded</code> - the number of nodes that are needed.</dd>
<dt>Returns:</dt>
<dd>a Collection of nodes with the removed nodes in it.
This may be empty, but should not be null.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="nodesAvailable()">
<h3>nodesAvailable</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">nodesAvailable</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="NodePool.html#nodesAvailable()">NodePool</a></code></span></div>
<div class="block">Get the number of available nodes.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="NodePool.html#nodesAvailable()">nodesAvailable</a></code>&nbsp;in class&nbsp;<code><a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a></code></dd>
<dt>Returns:</dt>
<dd>the number of nodes that are available to be taken</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="slotsAvailable()">
<h3>slotsAvailable</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">slotsAvailable</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="NodePool.html#slotsAvailable()">NodePool</a></code></span></div>
<div class="block">Get number of available slots.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="NodePool.html#slotsAvailable()">slotsAvailable</a></code>&nbsp;in class&nbsp;<code><a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a></code></dd>
<dt>Returns:</dt>
<dd>the number of slots that are available to be taken</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="takeNodesBySlots(int)">
<h3>takeNodesBySlots</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="Node.html" title="class in org.apache.storm.scheduler.multitenant">Node</a>&gt;</span>&nbsp;<span class="element-name">takeNodesBySlots</span><wbr><span class="parameters">(int&nbsp;slotsNeeded)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="NodePool.html#takeNodesBySlots(int)">NodePool</a></code></span></div>
<div class="block">Take nodes from this pool that can fulfill possibly up to the slotsNeeded.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="NodePool.html#takeNodesBySlots(int)">takeNodesBySlots</a></code>&nbsp;in class&nbsp;<code><a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a></code></dd>
<dt>Parameters:</dt>
<dd><code>slotsNeeded</code> - the number of slots that are needed.</dd>
<dt>Returns:</dt>
<dd>a Collection of nodes with the removed nodes in it.
This may be empty, but should not be null.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getNodeAndSlotCountIfSlotsWereTaken(int)">
<h3>getNodeAndSlotCountIfSlotsWereTaken</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="NodePool.NodeAndSlotCounts.html" title="class in org.apache.storm.scheduler.multitenant">NodePool.NodeAndSlotCounts</a></span>&nbsp;<span class="element-name">getNodeAndSlotCountIfSlotsWereTaken</span><wbr><span class="parameters">(int&nbsp;slotsNeeded)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="NodePool.html#getNodeAndSlotCountIfSlotsWereTaken(int)">NodePool</a></code></span></div>
<div class="block">Get the number of nodes and slots this would provide to get the slots needed.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="NodePool.html#getNodeAndSlotCountIfSlotsWereTaken(int)">getNodeAndSlotCountIfSlotsWereTaken</a></code>&nbsp;in class&nbsp;<code><a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a></code></dd>
<dt>Parameters:</dt>
<dd><code>slotsNeeded</code> - the number of slots needed</dd>
<dt>Returns:</dt>
<dd>the number of nodes and slots that would be returned.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="scheduleAsNeeded(org.apache.storm.scheduler.multitenant.NodePool...)">
<h3>scheduleAsNeeded</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">scheduleAsNeeded</span><wbr><span class="parameters">(<a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a>...&nbsp;lesserPools)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="NodePool.html#scheduleAsNeeded(org.apache.storm.scheduler.multitenant.NodePool...)">NodePool</a></code></span></div>
<div class="block">Reschedule any topologies as needed.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="NodePool.html#scheduleAsNeeded(org.apache.storm.scheduler.multitenant.NodePool...)">scheduleAsNeeded</a></code>&nbsp;in class&nbsp;<code><a href="NodePool.html" title="class in org.apache.storm.scheduler.multitenant">NodePool</a></code></dd>
<dt>Parameters:</dt>
<dd><code>lesserPools</code> - pools that may be used to steal nodes from.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">toString</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>