Google Git
Sign in
apache / storm-site / refs/heads/asf-site / . / content / releases / current / javadocs / org / apache / storm / scheduler / SingleTopologyCluster.html
blob: f6dbe089c965f69db2ce9d4657101899e6f27431 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>SingleTopologyCluster (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, class: SingleTopologyCluster">
<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/SingleTopologyCluster.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="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</a></div>
<h1 title="Class SingleTopologyCluster" class="title">Class SingleTopologyCluster</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="Cluster.html" title="class in org.apache.storm.scheduler">org.apache.storm.scheduler.Cluster</a>
<div class="inheritance">org.apache.storm.scheduler.SingleTopologyCluster</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="ISchedulingState.html" title="interface in org.apache.storm.scheduler">ISchedulingState</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SingleTopologyCluster</span>
<span class="extends-implements">extends <a href="Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a></span></div>
<div class="block">A Cluster that only allows modification to a single topology.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== 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(org.apache.storm.scheduler.Cluster,java.lang.String)" class="member-name-link">SingleTopologyCluster</a><wbr>(<a href="Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a>&nbsp;other,
<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>&nbsp;topologyId)</code></div>
<div class="col-last even-row-color">
<div class="block">Create a new cluster that only allows modifications to a single topology.</div>
</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>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#assertValidTopologyForModification(java.lang.String)" class="member-name-link">assertValidTopologyForModification</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>&nbsp;topologyId)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Check if the given topology is allowed for modification right now.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.storm.scheduler.Cluster">Methods inherited from class&nbsp;org.apache.storm.scheduler.<a href="Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a></h3>
<code><a href="Cluster.html#assign(org.apache.storm.scheduler.SchedulerAssignment,boolean)">assign</a>, <a href="Cluster.html#assign(org.apache.storm.scheduler.WorkerSlot,java.lang.String,java.util.Collection)">assign</a>, <a href="Cluster.html#blacklistHost(java.lang.String)">blacklistHost</a>, <a href="Cluster.html#freeSlot(org.apache.storm.scheduler.WorkerSlot)">freeSlot</a>, <a href="Cluster.html#freeSlots(java.util.Collection)">freeSlots</a>, <a href="Cluster.html#getAllScheduledResourcesForNode(java.lang.String)">getAllScheduledResourcesForNode</a>, <a href="Cluster.html#getAssignablePorts(org.apache.storm.scheduler.SupervisorDetails)">getAssignablePorts</a>, <a href="Cluster.html#getAssignableSlots()">getAssignableSlots</a>, <a href="Cluster.html#getAssignableSlots(org.apache.storm.scheduler.SupervisorDetails)">getAssignableSlots</a>, <a href="Cluster.html#getAssignedMemoryForSlot(java.util.Map)">getAssignedMemoryForSlot</a>, <a href="Cluster.html#getAssignedNumWorkers(org.apache.storm.scheduler.TopologyDetails)">getAssignedNumWorkers</a>, <a href="Cluster.html#getAssignmentById(java.lang.String)">getAssignmentById</a>, <a href="Cluster.html#getAssignments()">getAssignments</a>, <a href="Cluster.html#getAvailablePorts(org.apache.storm.scheduler.SupervisorDetails)">getAvailablePorts</a>, <a href="Cluster.html#getAvailableResources(org.apache.storm.scheduler.SupervisorDetails)">getAvailableResources</a>, <a href="Cluster.html#getAvailableSlots()">getAvailableSlots</a>, <a href="Cluster.html#getAvailableSlots(org.apache.storm.scheduler.SupervisorDetails)">getAvailableSlots</a>, <a href="Cluster.html#getBlacklistedHosts()">getBlacklistedHosts</a>, <a href="Cluster.html#getClusterTotalCpuResource()">getClusterTotalCpuResource</a>, <a href="Cluster.html#getClusterTotalGenericResources()">getClusterTotalGenericResources</a>, <a href="Cluster.html#getClusterTotalMemoryResource()">getClusterTotalMemoryResource</a>, <a href="Cluster.html#getConf()">getConf</a>, <a href="Cluster.html#getGreyListedSupervisors()">getGreyListedSupervisors</a>, <a href="Cluster.html#getHost(java.lang.String)">getHost</a>, <a href="Cluster.html#getINimbus()">getINimbus</a>, <a href="Cluster.html#getMinWorkerCpu()">getMinWorkerCpu</a>, <a href="Cluster.html#getNeedsSchedulingComponentToExecutors(org.apache.storm.scheduler.TopologyDetails)">getNeedsSchedulingComponentToExecutors</a>, <a href="Cluster.html#getNeedsSchedulingExecutorToComponents(org.apache.storm.scheduler.TopologyDetails)">getNeedsSchedulingExecutorToComponents</a>, <a href="Cluster.html#getNetworkTopography()">getNetworkTopography</a>, <a href="Cluster.html#getNonBlacklistedAvailableSlots(java.util.List)">getNonBlacklistedAvailableSlots</a>, <a href="Cluster.html#getNonBlacklistedClusterAvailableResources(java.util.Collection)">getNonBlacklistedClusterAvailableResources</a>, <a href="Cluster.html#getResourceMetrics()">getResourceMetrics</a>, <a href="Cluster.html#getScheduledCpuForNode(java.lang.String)">getScheduledCpuForNode</a>, <a href="Cluster.html#getScheduledMemoryForNode(java.lang.String)">getScheduledMemoryForNode</a>, <a href="Cluster.html#getStatus(java.lang.String)">getStatus</a>, <a href="Cluster.html#getStatusMap()">getStatusMap</a>, <a href="Cluster.html#getSupervisorById(java.lang.String)">getSupervisorById</a>, <a href="Cluster.html#getSupervisors()">getSupervisors</a>, <a href="Cluster.html#getSupervisorsByHost(java.lang.String)">getSupervisorsByHost</a>, <a href="Cluster.html#getSupervisorsResourcesMap()">getSupervisorsResourcesMap</a>, <a href="Cluster.html#getTopologies()">getTopologies</a>, <a href="Cluster.html#getTopologyResourcesMap()">getTopologyResourcesMap</a>, <a href="Cluster.html#getUnassignedExecutors(org.apache.storm.scheduler.TopologyDetails)">getUnassignedExecutors</a>, <a href="Cluster.html#getUsedPorts(org.apache.storm.scheduler.SupervisorDetails)">getUsedPorts</a>, <a href="Cluster.html#getUsedSlots()">getUsedSlots</a>, <a href="Cluster.html#getUsedSlotsByTopologyId(java.lang.String)">getUsedSlotsByTopologyId</a>, <a href="Cluster.html#getWorkerResources(org.apache.storm.scheduler.WorkerSlot)">getWorkerResources</a>, <a href="Cluster.html#getWorkerResourcesMap()">getWorkerResourcesMap</a>, <a href="Cluster.html#isBlackListed(java.lang.String)">isBlackListed</a>, <a href="Cluster.html#isBlacklistedHost(java.lang.String)">isBlacklistedHost</a>, <a href="Cluster.html#isSlotOccupied(org.apache.storm.scheduler.WorkerSlot)">isSlotOccupied</a>, <a href="Cluster.html#needsScheduling(org.apache.storm.scheduler.TopologyDetails)">needsScheduling</a>, <a href="Cluster.html#needsSchedulingRas(org.apache.storm.scheduler.TopologyDetails)">needsSchedulingRas</a>, <a href="Cluster.html#needsSchedulingTopologies()">needsSchedulingTopologies</a>, <a href="Cluster.html#setAssignments(java.util.Map,boolean)">setAssignments</a>, <a href="Cluster.html#setBlacklistedHosts(java.util.Set)">setBlacklistedHosts</a>, <a href="Cluster.html#setGreyListedSupervisors(java.util.Set)">setGreyListedSupervisors</a>, <a href="Cluster.html#setNetworkTopography(java.util.Map)">setNetworkTopography</a>, <a href="Cluster.html#setStatus(java.lang.String,java.lang.String)">setStatus</a>, <a href="Cluster.html#setStatus(org.apache.storm.scheduler.TopologyDetails,java.lang.String)">setStatus</a>, <a href="Cluster.html#setStatusIfAbsent(java.lang.String,java.lang.String)">setStatusIfAbsent</a>, <a href="Cluster.html#setStatusMap(java.util.Map)">setStatusMap</a>, <a href="Cluster.html#unassign(java.lang.String)">unassign</a>, <a href="Cluster.html#updateFrom(org.apache.storm.scheduler.Cluster)">updateFrom</a>, <a href="Cluster.html#wouldFit(org.apache.storm.scheduler.WorkerSlot,org.apache.storm.scheduler.ExecutorDetails,org.apache.storm.scheduler.TopologyDetails,org.apache.storm.scheduler.resource.normalization.NormalizedResourceOffer,double)">wouldFit</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#toString()" title="class or interface in java.lang" class="external-link">toString</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>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.storm.scheduler.ISchedulingState">Methods inherited from interface&nbsp;org.apache.storm.scheduler.<a href="ISchedulingState.html" title="interface in org.apache.storm.scheduler">ISchedulingState</a></h3>
<code><a href="ISchedulingState.html#getAssignedRacks(java.lang.String...)">getAssignedRacks</a>, <a href="ISchedulingState.html#getHostToRack()">getHostToRack</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;(org.apache.storm.scheduler.Cluster,java.lang.String)">
<h3>SingleTopologyCluster</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SingleTopologyCluster</span><wbr><span class="parameters">(<a href="Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a>&nbsp;other,
<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>&nbsp;topologyId)</span></div>
<div class="block">Create a new cluster that only allows modifications to a single topology.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>other</code> - the current cluster to base this off of</dd>
<dd><code>topologyId</code> - the topology that is allowed to be modified.</dd>
</dl>
</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="assertValidTopologyForModification(java.lang.String)">
<h3>assertValidTopologyForModification</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">assertValidTopologyForModification</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>&nbsp;topologyId)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="Cluster.html#assertValidTopologyForModification(java.lang.String)">Cluster</a></code></span></div>
<div class="block">Check if the given topology is allowed for modification right now. If not throw an IllegalArgumentException else go on.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="Cluster.html#assertValidTopologyForModification(java.lang.String)">assertValidTopologyForModification</a></code>&nbsp;in class&nbsp;<code><a href="Cluster.html" title="class in org.apache.storm.scheduler">Cluster</a></code></dd>
<dt>Parameters:</dt>
<dd><code>topologyId</code> - the id of the topology to check</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>