| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ISchedulingState (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, interface: ISchedulingState"> |
| <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/ISchedulingState.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> <a href="package-summary.html">org.apache.storm.scheduler</a></div> |
| <h1 title="Interface ISchedulingState" class="title">Interface ISchedulingState</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a></code>, <code><a href="SingleTopologyCluster.html" title="class in org.apache.storm.scheduler">SingleTopologyCluster</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ISchedulingState</span></div> |
| <div class="block">An interface that provides access to the current scheduling state. |
| The scheduling state is not guaranteed to be thread safe.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab3"><code><a href="resource/normalization/NormalizedResourceRequest.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceRequest</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAllScheduledResourcesForNode(java.lang.String)" class="member-name-link">getAllScheduledResourcesForNode</a><wbr>(<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> nodeId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get all scheduled resources for node.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAssignablePorts(org.apache.storm.scheduler.SupervisorDetails)" class="member-name-link">getAssignablePorts</a><wbr>(<a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a> supervisor)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the ports that are not blacklisted.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAssignableSlots()" class="member-name-link">getAssignableSlots</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get all non-blacklisted slots in the cluster.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAssignableSlots(org.apache.storm.scheduler.SupervisorDetails)" class="member-name-link">getAssignableSlots</a><wbr>(<a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a> supervisor)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return all non-blacklisted slots on this supervisor.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAssignedNumWorkers(org.apache.storm.scheduler.TopologyDetails)" class="member-name-link">getAssignedNumWorkers</a><wbr>(<a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topology)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the number of workers assigned to a topology.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<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-tab5"><code><a href="#getAssignedRacks(java.lang.String...)" class="member-name-link">getAssignedRacks</a><wbr>(<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>... topologyIds)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Determine the list of racks on which topologyIds have been assigned.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SchedulerAssignment.html" title="interface in org.apache.storm.scheduler">SchedulerAssignment</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAssignmentById(java.lang.String)" class="member-name-link">getAssignmentById</a><wbr>(<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> topologyId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">get the current assignment for the topology.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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><<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="SchedulerAssignment.html" title="interface in org.apache.storm.scheduler">SchedulerAssignment</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAssignments()" class="member-name-link">getAssignments</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get all the assignments.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAvailablePorts(org.apache.storm.scheduler.SupervisorDetails)" class="member-name-link">getAvailablePorts</a><wbr>(<a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a> supervisor)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return the available ports of this supervisor.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="resource/normalization/NormalizedResourceOffer.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceOffer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAvailableResources(org.apache.storm.scheduler.SupervisorDetails)" class="member-name-link">getAvailableResources</a><wbr>(<a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a> sd)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the resources on the supervisor that are available to be scheduled.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAvailableSlots()" class="member-name-link">getAvailableSlots</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get all the available worker slots in the cluster.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAvailableSlots(org.apache.storm.scheduler.SupervisorDetails)" class="member-name-link">getAvailableSlots</a><wbr>(<a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a> supervisor)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return all the available slots on this supervisor.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getBlacklistedHosts()" class="member-name-link">getBlacklistedHosts</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get all of the hosts that are blacklisted.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getClusterTotalCpuResource()" class="member-name-link">getClusterTotalCpuResource</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the total amount of CPU resources in cluster.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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><<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="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getClusterTotalGenericResources()" class="member-name-link">getClusterTotalGenericResources</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the total amount of generic resources (excluding CPU and memory) in cluster.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getClusterTotalMemoryResource()" class="member-name-link">getClusterTotalMemoryResource</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the total amount of memory resources in cluster.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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><<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="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></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getConf()" class="member-name-link">getConf</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the nimbus configuration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"><code><a href="#getHost(java.lang.String)" class="member-name-link">getHost</a><wbr>(<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> supervisorId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Map a supervisor to a given host.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <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><<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="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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getHostToRack()" class="member-name-link">getHostToRack</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Get host -> rack map - the inverse of networkTopography.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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><<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="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a>>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getNeedsSchedulingComponentToExecutors(org.apache.storm.scheduler.TopologyDetails)" class="member-name-link">getNeedsSchedulingComponentToExecutors</a><wbr>(<a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topology)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the component name to executor list for executors that need to be scheduled.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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><<a href="ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a>,<wbr><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getNeedsSchedulingExecutorToComponents(org.apache.storm.scheduler.TopologyDetails)" class="member-name-link">getNeedsSchedulingExecutorToComponents</a><wbr>(<a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topology)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the executor to component name map for executors that need to be scheduled.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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><<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="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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-tab3"><code><a href="#getNetworkTopography()" class="member-name-link">getNetworkTopography</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the network topography (rackId -> nodes in the rack).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getNonBlacklistedAvailableSlots(java.util.List)" class="member-name-link">getNonBlacklistedAvailableSlots</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>> blacklistedSupervisorIds)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get all the available worker slots in the cluster, that are not blacklisted.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="resource/normalization/NormalizedResourceOffer.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceOffer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getNonBlacklistedClusterAvailableResources(java.util.Collection)" class="member-name-link">getNonBlacklistedClusterAvailableResources</a><wbr>(<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><<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>> blacklistedSupervisorIds)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the resources in the cluster that are available for scheduling.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getScheduledCpuForNode(java.lang.String)" class="member-name-link">getScheduledCpuForNode</a><wbr>(<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> nodeId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the total cpu currently scheduled on a node.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getScheduledMemoryForNode(java.lang.String)" class="member-name-link">getScheduledMemoryForNode</a><wbr>(<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> nodeId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the total memory currently scheduled on a node.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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><<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="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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getStatusMap()" class="member-name-link">getStatusMap</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get all topology scheduler statuses.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSupervisorById(java.lang.String)" class="member-name-link">getSupervisorById</a><wbr>(<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> nodeId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get a specific supervisor with the <code>nodeId</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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><<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="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSupervisors()" class="member-name-link">getSupervisors</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get all the supervisors.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSupervisorsByHost(java.lang.String)" class="member-name-link">getSupervisorsByHost</a><wbr>(<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> host)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get all the supervisors on the specified <code>host</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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><<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="SupervisorResources.html" title="class in org.apache.storm.scheduler">SupervisorResources</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSupervisorsResourcesMap()" class="member-name-link">getSupervisorsResourcesMap</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the amount of used and free resources on a supervisor.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Topologies.html" title="class in org.apache.storm.scheduler">Topologies</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTopologies()" class="member-name-link">getTopologies</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get all of the topologies.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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><<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="../daemon/nimbus/TopologyResources.html" title="class in org.apache.storm.daemon.nimbus">TopologyResources</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTopologyResourcesMap()" class="member-name-link">getTopologyResourcesMap</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the amount of resources used by topologies.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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><<a href="ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getUnassignedExecutors(org.apache.storm.scheduler.TopologyDetails)" class="member-name-link">getUnassignedExecutors</a><wbr>(<a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topology)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">get the unassigned executors of the topology.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getUsedPorts(org.apache.storm.scheduler.SupervisorDetails)" class="member-name-link">getUsedPorts</a><wbr>(<a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a> supervisor)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get all the used ports of this supervisor.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getUsedSlots()" class="member-name-link">getUsedSlots</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get all currently occupied slots.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getUsedSlotsByTopologyId(java.lang.String)" class="member-name-link">getUsedSlotsByTopologyId</a><wbr>(<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> topologyId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">get slots used by a topology.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../generated/WorkerResources.html" title="class in org.apache.storm.generated">WorkerResources</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getWorkerResources(org.apache.storm.scheduler.WorkerSlot)" class="member-name-link">getWorkerResources</a><wbr>(<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a> ws)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the resources for a given slot.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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><<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="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><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>,<wbr><a href="../generated/WorkerResources.html" title="class in org.apache.storm.generated">WorkerResources</a>>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getWorkerResourcesMap()" class="member-name-link">getWorkerResourcesMap</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the reference to the full topology->worker resource map.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isBlackListed(java.lang.String)" class="member-name-link">isBlackListed</a><wbr>(<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> supervisorId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Check is a given supervisor is on a blacklisted host.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isBlacklistedHost(java.lang.String)" class="member-name-link">isBlacklistedHost</a><wbr>(<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> host)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Check if a given host is blacklisted.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isSlotOccupied(org.apache.storm.scheduler.WorkerSlot)" class="member-name-link">isSlotOccupied</a><wbr>(<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a> slot)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Check if a slot is occupied or not.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#needsScheduling(org.apache.storm.scheduler.TopologyDetails)" class="member-name-link">needsScheduling</a><wbr>(<a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topology)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Does the topology need scheduling.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#needsSchedulingRas(org.apache.storm.scheduler.TopologyDetails)" class="member-name-link">needsSchedulingRas</a><wbr>(<a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topology)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Like <a href="#needsScheduling(org.apache.storm.scheduler.TopologyDetails)"><code>needsScheduling(TopologyDetails)</code></a> but does not take into account the number of workers requested.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#needsSchedulingTopologies()" class="member-name-link">needsSchedulingTopologies</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get all of the topologies that need scheduling.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#wouldFit(org.apache.storm.scheduler.WorkerSlot,org.apache.storm.scheduler.ExecutorDetails,org.apache.storm.scheduler.TopologyDetails,org.apache.storm.scheduler.resource.normalization.NormalizedResourceOffer,double)" class="member-name-link">wouldFit</a><wbr>(<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a> ws, |
| <a href="ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a> exec, |
| <a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> td, |
| <a href="resource/normalization/NormalizedResourceOffer.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceOffer</a> resourcesAvailable, |
| double maxHeap)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Would scheduling exec on ws fit?</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getTopologies()"> |
| <h3>getTopologies</h3> |
| <div class="member-signature"><span class="return-type"><a href="Topologies.html" title="class in org.apache.storm.scheduler">Topologies</a></span> <span class="element-name">getTopologies</span>()</div> |
| <div class="block">Get all of the topologies.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>all of the topologies that are a part of the cluster.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="needsSchedulingTopologies()"> |
| <h3>needsSchedulingTopologies</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a>></span> <span class="element-name">needsSchedulingTopologies</span>()</div> |
| <div class="block">Get all of the topologies that need scheduling.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>all of the topologies that are not fully scheduled.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="needsScheduling(org.apache.storm.scheduler.TopologyDetails)"> |
| <h3>needsScheduling</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">needsScheduling</span><wbr><span class="parameters">(<a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topology)</span></div> |
| <div class="block">Does the topology need scheduling. |
| |
| <p>A topology needs scheduling if one of the following conditions holds: |
| |
| <ul> |
| <li>Although the topology is assigned slots, but is squeezed. i.e. the topology is assigned |
| less slots than desired. |
| <li>There are unassigned executors in this topology |
| </ul></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="needsSchedulingRas(org.apache.storm.scheduler.TopologyDetails)"> |
| <h3>needsSchedulingRas</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">needsSchedulingRas</span><wbr><span class="parameters">(<a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topology)</span></div> |
| <div class="block">Like <a href="#needsScheduling(org.apache.storm.scheduler.TopologyDetails)"><code>needsScheduling(TopologyDetails)</code></a> but does not take into account the number of workers requested. This is because the |
| number of workers is ignored in RAS</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topology</code> - the topology to check</dd> |
| <dt>Returns:</dt> |
| <dd>true if the topology needs scheduling else false.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBlacklistedHosts()"> |
| <h3>getBlacklistedHosts</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<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> <span class="element-name">getBlacklistedHosts</span>()</div> |
| <div class="block">Get all of the hosts that are blacklisted.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>all of the hosts that are blacklisted</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isBlackListed(java.lang.String)"> |
| <h3>isBlackListed</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isBlackListed</span><wbr><span class="parameters">(<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> supervisorId)</span></div> |
| <div class="block">Check is a given supervisor is on a blacklisted host.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>supervisorId</code> - the id of the supervisor</dd> |
| <dt>Returns:</dt> |
| <dd>true if it is else false</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isBlacklistedHost(java.lang.String)"> |
| <h3>isBlacklistedHost</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isBlacklistedHost</span><wbr><span class="parameters">(<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> host)</span></div> |
| <div class="block">Check if a given host is blacklisted.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>host</code> - the name of the host</dd> |
| <dt>Returns:</dt> |
| <dd>true if it is else false.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHost(java.lang.String)"> |
| <h3>getHost</h3> |
| <div class="member-signature"><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> <span class="element-name">getHost</span><wbr><span class="parameters">(<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> supervisorId)</span></div> |
| <div class="block">Map a supervisor to a given host.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>supervisorId</code> - the id of the supervisor</dd> |
| <dt>Returns:</dt> |
| <dd>the actual host name the supervisor is on</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUnassignedExecutors(org.apache.storm.scheduler.TopologyDetails)"> |
| <h3>getUnassignedExecutors</h3> |
| <div class="member-signature"><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><<a href="ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a>></span> <span class="element-name">getUnassignedExecutors</span><wbr><span class="parameters">(<a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topology)</span></div> |
| <div class="block">get the unassigned executors of the topology.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topology</code> - the topology to check</dd> |
| <dt>Returns:</dt> |
| <dd>the unassigned executors of the topology.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNeedsSchedulingExecutorToComponents(org.apache.storm.scheduler.TopologyDetails)"> |
| <h3>getNeedsSchedulingExecutorToComponents</h3> |
| <div class="member-signature"><span class="return-type"><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><<a href="ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a>,<wbr><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> <span class="element-name">getNeedsSchedulingExecutorToComponents</span><wbr><span class="parameters">(<a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topology)</span></div> |
| <div class="block">Get the executor to component name map for executors that need to be scheduled.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topology</code> - the topology this is for</dd> |
| <dt>Returns:</dt> |
| <dd>a executor -> component-id map which needs scheduling in this topology.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNeedsSchedulingComponentToExecutors(org.apache.storm.scheduler.TopologyDetails)"> |
| <h3>getNeedsSchedulingComponentToExecutors</h3> |
| <div class="member-signature"><span class="return-type"><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><<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="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a>>></span> <span class="element-name">getNeedsSchedulingComponentToExecutors</span><wbr><span class="parameters">(<a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topology)</span></div> |
| <div class="block">Get the component name to executor list for executors that need to be scheduled.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topology</code> - the topology this is for</dd> |
| <dt>Returns:</dt> |
| <dd>a component-id -> executors map which needs scheduling in this topology.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUsedPorts(org.apache.storm.scheduler.SupervisorDetails)"> |
| <h3>getUsedPorts</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name">getUsedPorts</span><wbr><span class="parameters">(<a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a> supervisor)</span></div> |
| <div class="block">Get all the used ports of this supervisor.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAvailablePorts(org.apache.storm.scheduler.SupervisorDetails)"> |
| <h3>getAvailablePorts</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name">getAvailablePorts</span><wbr><span class="parameters">(<a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a> supervisor)</span></div> |
| <div class="block">Return the available ports of this supervisor.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAssignablePorts(org.apache.storm.scheduler.SupervisorDetails)"> |
| <h3>getAssignablePorts</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name">getAssignablePorts</span><wbr><span class="parameters">(<a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a> supervisor)</span></div> |
| <div class="block">Get the ports that are not blacklisted.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>supervisor</code> - the supervisor</dd> |
| <dt>Returns:</dt> |
| <dd>the ports that are not blacklisted</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAvailableSlots(org.apache.storm.scheduler.SupervisorDetails)"> |
| <h3>getAvailableSlots</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>></span> <span class="element-name">getAvailableSlots</span><wbr><span class="parameters">(<a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a> supervisor)</span></div> |
| <div class="block">Return all the available slots on this supervisor.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAvailableSlots()"> |
| <h3>getAvailableSlots</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>></span> <span class="element-name">getAvailableSlots</span>()</div> |
| <div class="block">Get all the available worker slots in the cluster.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNonBlacklistedAvailableSlots(java.util.List)"> |
| <h3>getNonBlacklistedAvailableSlots</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>></span> <span class="element-name">getNonBlacklistedAvailableSlots</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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>> blacklistedSupervisorIds)</span></div> |
| <div class="block">Get all the available worker slots in the cluster, that are not blacklisted.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>blacklistedSupervisorIds</code> - list of supervisor ids that should also be considered blacklisted.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAssignableSlots(org.apache.storm.scheduler.SupervisorDetails)"> |
| <h3>getAssignableSlots</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>></span> <span class="element-name">getAssignableSlots</span><wbr><span class="parameters">(<a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a> supervisor)</span></div> |
| <div class="block">Return all non-blacklisted slots on this supervisor.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>supervisor</code> - the supervisor</dd> |
| <dt>Returns:</dt> |
| <dd>the non-blacklisted slots</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAssignableSlots()"> |
| <h3>getAssignableSlots</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>></span> <span class="element-name">getAssignableSlots</span>()</div> |
| <div class="block">Get all non-blacklisted slots in the cluster.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUsedSlots()"> |
| <h3>getUsedSlots</h3> |
| <div class="member-signature"><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><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>></span> <span class="element-name">getUsedSlots</span>()</div> |
| <div class="block">Get all currently occupied slots.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSlotOccupied(org.apache.storm.scheduler.WorkerSlot)"> |
| <h3>isSlotOccupied</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isSlotOccupied</span><wbr><span class="parameters">(<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a> slot)</span></div> |
| <div class="block">Check if a slot is occupied or not.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>slot</code> - the slot be to checked.</dd> |
| <dt>Returns:</dt> |
| <dd>true if the specified slot is occupied.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAssignedNumWorkers(org.apache.storm.scheduler.TopologyDetails)"> |
| <h3>getAssignedNumWorkers</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getAssignedNumWorkers</span><wbr><span class="parameters">(<a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> topology)</span></div> |
| <div class="block">Get the number of workers assigned to a topology.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topology</code> - the topology this is for</dd> |
| <dt>Returns:</dt> |
| <dd>the number of workers assigned to this topology.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAvailableResources(org.apache.storm.scheduler.SupervisorDetails)"> |
| <h3>getAvailableResources</h3> |
| <div class="member-signature"><span class="return-type"><a href="resource/normalization/NormalizedResourceOffer.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceOffer</a></span> <span class="element-name">getAvailableResources</span><wbr><span class="parameters">(<a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a> sd)</span></div> |
| <div class="block">Get the resources on the supervisor that are available to be scheduled.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sd</code> - the supervisor.</dd> |
| <dt>Returns:</dt> |
| <dd>the resources available to be scheduled.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="wouldFit(org.apache.storm.scheduler.WorkerSlot,org.apache.storm.scheduler.ExecutorDetails,org.apache.storm.scheduler.TopologyDetails,org.apache.storm.scheduler.resource.normalization.NormalizedResourceOffer,double)"> |
| <h3>wouldFit</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">wouldFit</span><wbr><span class="parameters">(<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a> ws, |
| <a href="ExecutorDetails.html" title="class in org.apache.storm.scheduler">ExecutorDetails</a> exec, |
| <a href="TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a> td, |
| <a href="resource/normalization/NormalizedResourceOffer.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceOffer</a> resourcesAvailable, |
| double maxHeap)</span></div> |
| <div class="block">Would scheduling exec on ws fit? With a heap <= maxHeap total memory added <= memoryAvailable and cpu added <= cpuAvailable.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>ws</code> - the slot to put it in</dd> |
| <dd><code>exec</code> - the executor to investigate</dd> |
| <dd><code>td</code> - the topology detains for this executor</dd> |
| <dd><code>resourcesAvailable</code> - all the available resources</dd> |
| <dd><code>maxHeap</code> - the maximum heap size for ws</dd> |
| <dt>Returns:</dt> |
| <dd>true it fits else false</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAssignmentById(java.lang.String)"> |
| <h3>getAssignmentById</h3> |
| <div class="member-signature"><span class="return-type"><a href="SchedulerAssignment.html" title="interface in org.apache.storm.scheduler">SchedulerAssignment</a></span> <span class="element-name">getAssignmentById</span><wbr><span class="parameters">(<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> topologyId)</span></div> |
| <div class="block">get the current assignment for the topology.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUsedSlotsByTopologyId(java.lang.String)"> |
| <h3>getUsedSlotsByTopologyId</h3> |
| <div class="member-signature"><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><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>></span> <span class="element-name">getUsedSlotsByTopologyId</span><wbr><span class="parameters">(<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> topologyId)</span></div> |
| <div class="block">get slots used by a topology.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSupervisorById(java.lang.String)"> |
| <h3>getSupervisorById</h3> |
| <div class="member-signature"><span class="return-type"><a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a></span> <span class="element-name">getSupervisorById</span><wbr><span class="parameters">(<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> nodeId)</span></div> |
| <div class="block">Get a specific supervisor with the <code>nodeId</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSupervisorsByHost(java.lang.String)"> |
| <h3>getSupervisorsByHost</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a>></span> <span class="element-name">getSupervisorsByHost</span><wbr><span class="parameters">(<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> host)</span></div> |
| <div class="block">Get all the supervisors on the specified <code>host</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>host</code> - hostname of the supervisor</dd> |
| <dt>Returns:</dt> |
| <dd>the <code>SupervisorDetails</code> object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAssignments()"> |
| <h3>getAssignments</h3> |
| <div class="member-signature"><span class="return-type"><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><<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="SchedulerAssignment.html" title="interface in org.apache.storm.scheduler">SchedulerAssignment</a>></span> <span class="element-name">getAssignments</span>()</div> |
| <div class="block">Get all the assignments.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSupervisors()"> |
| <h3>getSupervisors</h3> |
| <div class="member-signature"><span class="return-type"><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><<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="SupervisorDetails.html" title="class in org.apache.storm.scheduler">SupervisorDetails</a>></span> <span class="element-name">getSupervisors</span>()</div> |
| <div class="block">Get all the supervisors.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAllScheduledResourcesForNode(java.lang.String)"> |
| <h3>getAllScheduledResourcesForNode</h3> |
| <div class="member-signature"><span class="return-type"><a href="resource/normalization/NormalizedResourceRequest.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceRequest</a></span> <span class="element-name">getAllScheduledResourcesForNode</span><wbr><span class="parameters">(<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> nodeId)</span></div> |
| <div class="block">Get all scheduled resources for node.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNonBlacklistedClusterAvailableResources(java.util.Collection)"> |
| <h3>getNonBlacklistedClusterAvailableResources</h3> |
| <div class="member-signature"><span class="return-type"><a href="resource/normalization/NormalizedResourceOffer.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceOffer</a></span> <span class="element-name">getNonBlacklistedClusterAvailableResources</span><wbr><span class="parameters">(<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><<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>> blacklistedSupervisorIds)</span></div> |
| <div class="block">Get the resources in the cluster that are available for scheduling.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>blacklistedSupervisorIds</code> - other ids that are tentatively blacklisted.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getClusterTotalCpuResource()"> |
| <h3>getClusterTotalCpuResource</h3> |
| <div class="member-signature"><span class="return-type">double</span> <span class="element-name">getClusterTotalCpuResource</span>()</div> |
| <div class="block">Get the total amount of CPU resources in cluster.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getClusterTotalMemoryResource()"> |
| <h3>getClusterTotalMemoryResource</h3> |
| <div class="member-signature"><span class="return-type">double</span> <span class="element-name">getClusterTotalMemoryResource</span>()</div> |
| <div class="block">Get the total amount of memory resources in cluster.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getClusterTotalGenericResources()"> |
| <h3>getClusterTotalGenericResources</h3> |
| <div class="member-signature"><span class="return-type"><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><<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="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">getClusterTotalGenericResources</span>()</div> |
| <div class="block">Get the total amount of generic resources (excluding CPU and memory) in cluster.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNetworkTopography()"> |
| <h3>getNetworkTopography</h3> |
| <div class="member-signature"><span class="return-type"><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><<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="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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> <span class="element-name">getNetworkTopography</span>()</div> |
| <div class="block">Get the network topography (rackId -> nodes in the rack).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHostToRack()"> |
| <h3>getHostToRack</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><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><<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="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> <span class="element-name">getHostToRack</span>()</div> |
| <div class="block">Get host -> rack map - the inverse of networkTopography.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStatusMap()"> |
| <h3>getStatusMap</h3> |
| <div class="member-signature"><span class="return-type"><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><<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="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> <span class="element-name">getStatusMap</span>()</div> |
| <div class="block">Get all topology scheduler statuses.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTopologyResourcesMap()"> |
| <h3>getTopologyResourcesMap</h3> |
| <div class="member-signature"><span class="return-type"><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><<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="../daemon/nimbus/TopologyResources.html" title="class in org.apache.storm.daemon.nimbus">TopologyResources</a>></span> <span class="element-name">getTopologyResourcesMap</span>()</div> |
| <div class="block">Get the amount of resources used by topologies. Used for displaying resource information on the UI.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a map that contains multiple topologies and the resources the topology requested and assigned. Key: topology id Value: an |
| array that describes the resources the topology requested and assigned in the following format: {requestedMemOnHeap, |
| requestedMemOffHeap, requestedCpu, assignedMemOnHeap, assignedMemOffHeap, assignedCpu}</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSupervisorsResourcesMap()"> |
| <h3>getSupervisorsResourcesMap</h3> |
| <div class="member-signature"><span class="return-type"><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><<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="SupervisorResources.html" title="class in org.apache.storm.scheduler">SupervisorResources</a>></span> <span class="element-name">getSupervisorsResourcesMap</span>()</div> |
| <div class="block">Get the amount of used and free resources on a supervisor. Used for displaying resource information on the UI</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a map where the key is the supervisor id and the value is a map that represents resource usage for a supervisor in the |
| following format: {totalMem, totalCpu, usedMem, usedCpu}</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWorkerResourcesMap()"> |
| <h3>getWorkerResourcesMap</h3> |
| <div class="member-signature"><span class="return-type"><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><<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="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><<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a>,<wbr><a href="../generated/WorkerResources.html" title="class in org.apache.storm.generated">WorkerResources</a>>></span> <span class="element-name">getWorkerResourcesMap</span>()</div> |
| <div class="block">Gets the reference to the full topology->worker resource map.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>map of topology -> map of worker slot ->resources for that worker</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWorkerResources(org.apache.storm.scheduler.WorkerSlot)"> |
| <h3>getWorkerResources</h3> |
| <div class="member-signature"><span class="return-type"><a href="../generated/WorkerResources.html" title="class in org.apache.storm.generated">WorkerResources</a></span> <span class="element-name">getWorkerResources</span><wbr><span class="parameters">(<a href="WorkerSlot.html" title="class in org.apache.storm.scheduler">WorkerSlot</a> ws)</span></div> |
| <div class="block">Get the resources for a given slot.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>ws</code> - the slot</dd> |
| <dt>Returns:</dt> |
| <dd>the resources currently assigned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScheduledMemoryForNode(java.lang.String)"> |
| <h3>getScheduledMemoryForNode</h3> |
| <div class="member-signature"><span class="return-type">double</span> <span class="element-name">getScheduledMemoryForNode</span><wbr><span class="parameters">(<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> nodeId)</span></div> |
| <div class="block">Get the total memory currently scheduled on a node.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>nodeId</code> - the id of the node</dd> |
| <dt>Returns:</dt> |
| <dd>the total memory currently scheduled on the node</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScheduledCpuForNode(java.lang.String)"> |
| <h3>getScheduledCpuForNode</h3> |
| <div class="member-signature"><span class="return-type">double</span> <span class="element-name">getScheduledCpuForNode</span><wbr><span class="parameters">(<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> nodeId)</span></div> |
| <div class="block">Get the total cpu currently scheduled on a node.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>nodeId</code> - the id of the node</dd> |
| <dt>Returns:</dt> |
| <dd>the total cpu currently scheduled on the node</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConf()"> |
| <h3>getConf</h3> |
| <div class="member-signature"><span class="return-type"><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><<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="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>></span> <span class="element-name">getConf</span>()</div> |
| <div class="block">Get the nimbus configuration.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAssignedRacks(java.lang.String...)"> |
| <h3>getAssignedRacks</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<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> <span class="element-name">getAssignedRacks</span><wbr><span class="parameters">(<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>... topologyIds)</span></div> |
| <div class="block">Determine the list of racks on which topologyIds have been assigned. Note that the returned set |
| may contain <a href="../networktopography/DNSToSwitchMapping.html#DEFAULT_RACK"><code>DNSToSwitchMapping.DEFAULT_RACK</code></a> if <a href="#getHostToRack()"><code>getHostToRack()</code></a> is null or |
| does not contain the assigned host.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topologyIds</code> - for which assignments are examined.</dd> |
| <dt>Returns:</dt> |
| <dd>set of racks on which assignments have been made.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
