Google Git
Sign in
apache / storm-site / refs/heads/asf-site / . / content / releases / current / javadocs / org / apache / storm / scheduler / resource / strategies / priority / GenericResourceAwareSchedulingPriorityStrategy.GrasSimulatedUser.html
blob: 8d85a4ece7f43de820865b5086e2083dad19109a [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>GenericResourceAwareSchedulingPriorityStrategy.GrasSimulatedUser (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.resource.strategies.priority, class: GenericResourceAwareSchedulingPriorityStrategy, class: GrasSimulatedUser">
<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/GenericResourceAwareSchedulingPriorityStrategy.GrasSimulatedUser.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><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&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.resource.strategies.priority</a></div>
<h1 title="Class GenericResourceAwareSchedulingPriorityStrategy.GrasSimulatedUser" class="title">Class GenericResourceAwareSchedulingPriorityStrategy.GrasSimulatedUser</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="DefaultSchedulingPriorityStrategy.SimulatedUser.html" title="class in org.apache.storm.scheduler.resource.strategies.priority">org.apache.storm.scheduler.resource.strategies.priority.DefaultSchedulingPriorityStrategy.SimulatedUser</a>
<div class="inheritance">org.apache.storm.scheduler.resource.strategies.priority.GenericResourceAwareSchedulingPriorityStrategy.GrasSimulatedUser</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><a href="GenericResourceAwareSchedulingPriorityStrategy.html" title="class in org.apache.storm.scheduler.resource.strategies.priority">GenericResourceAwareSchedulingPriorityStrategy</a></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">protected static class </span><span class="element-name type-name-label">GenericResourceAwareSchedulingPriorityStrategy.GrasSimulatedUser</span>
<span class="extends-implements">extends <a href="DefaultSchedulingPriorityStrategy.SimulatedUser.html" title="class in org.apache.storm.scheduler.resource.strategies.priority">DefaultSchedulingPriorityStrategy.SimulatedUser</a></span></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="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>&gt;</code></div>
<div class="col-second even-row-color"><code><a href="#guaranteedGenericResources" class="member-name-link">guaranteedGenericResources</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.storm.scheduler.resource.strategies.priority.DefaultSchedulingPriorityStrategy.SimulatedUser">Fields inherited from class&nbsp;org.apache.storm.scheduler.resource.strategies.priority.<a href="DefaultSchedulingPriorityStrategy.SimulatedUser.html" title="class in org.apache.storm.scheduler.resource.strategies.priority">DefaultSchedulingPriorityStrategy.SimulatedUser</a></h3>
<code><a href="DefaultSchedulingPriorityStrategy.SimulatedUser.html#assignedCpu">assignedCpu</a>, <a href="DefaultSchedulingPriorityStrategy.SimulatedUser.html#assignedMemory">assignedMemory</a>, <a href="DefaultSchedulingPriorityStrategy.SimulatedUser.html#guaranteedCpu">guaranteedCpu</a>, <a href="DefaultSchedulingPriorityStrategy.SimulatedUser.html#guaranteedMemory">guaranteedMemory</a>, <a href="DefaultSchedulingPriorityStrategy.SimulatedUser.html#tds">tds</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.storm.scheduler.resource.User,org.apache.storm.scheduler.ISchedulingState)" class="member-name-link">GrasSimulatedUser</a><wbr>(<a href="../../User.html" title="class in org.apache.storm.scheduler.resource">User</a>&nbsp;other,
<a href="../../../ISchedulingState.html" title="interface in org.apache.storm.scheduler">ISchedulingState</a>&nbsp;cluster)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScore(double,double,java.util.Map)" class="member-name-link">getScore</a><wbr>(double&nbsp;availableCpu,
double&nbsp;availableMemory,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="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>&gt;&nbsp;availableGenericResources)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScore(double,double,java.util.Map,org.apache.storm.scheduler.TopologyDetails)" class="member-name-link">getScore</a><wbr>(double&nbsp;availableCpu,
double&nbsp;availableMemory,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="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>&gt;&nbsp;availableGenericResources,
<a href="../../../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a>&nbsp;td)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get a score for the simulated user.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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-tab4"><code><a href="#simScheduleNextHighest()" class="member-name-link">simScheduleNextHighest</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.storm.scheduler.resource.strategies.priority.DefaultSchedulingPriorityStrategy.SimulatedUser">Methods inherited from class&nbsp;org.apache.storm.scheduler.resource.strategies.priority.<a href="DefaultSchedulingPriorityStrategy.SimulatedUser.html" title="class in org.apache.storm.scheduler.resource.strategies.priority">DefaultSchedulingPriorityStrategy.SimulatedUser</a></h3>
<code><a href="DefaultSchedulingPriorityStrategy.SimulatedUser.html#getNextHighest()">getNextHighest</a>, <a href="DefaultSchedulingPriorityStrategy.SimulatedUser.html#getScore(double,double)">getScore</a>, <a href="DefaultSchedulingPriorityStrategy.SimulatedUser.html#getScore(double,double,org.apache.storm.scheduler.TopologyDetails)">getScore</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>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="guaranteedGenericResources">
<h3>guaranteedGenericResources</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<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>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="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>&gt;</span>&nbsp;<span class="element-name">guaranteedGenericResources</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= 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.resource.User,org.apache.storm.scheduler.ISchedulingState)">
<h3>GrasSimulatedUser</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">GrasSimulatedUser</span><wbr><span class="parameters">(<a href="../../User.html" title="class in org.apache.storm.scheduler.resource">User</a>&nbsp;other,
<a href="../../../ISchedulingState.html" title="interface in org.apache.storm.scheduler">ISchedulingState</a>&nbsp;cluster)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="simScheduleNextHighest()">
<h3>simScheduleNextHighest</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a></span>&nbsp;<span class="element-name">simScheduleNextHighest</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="DefaultSchedulingPriorityStrategy.SimulatedUser.html#simScheduleNextHighest()">simScheduleNextHighest</a></code>&nbsp;in class&nbsp;<code><a href="DefaultSchedulingPriorityStrategy.SimulatedUser.html" title="class in org.apache.storm.scheduler.resource.strategies.priority">DefaultSchedulingPriorityStrategy.SimulatedUser</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getScore(double,double,java.util.Map,org.apache.storm.scheduler.TopologyDetails)">
<h3>getScore</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getScore</span><wbr><span class="parameters">(double&nbsp;availableCpu,
double&nbsp;availableMemory,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="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>&gt;&nbsp;availableGenericResources,
<a href="../../../TopologyDetails.html" title="class in org.apache.storm.scheduler">TopologyDetails</a>&nbsp;td)</span></div>
<div class="block">Get a score for the simulated user. This is used to sort the users, by their highest priority topology.
Only give user guarantees that will not exceed cluster capacity.
Score of each resource type is calculated as: (Requested + Assigned - Guaranteed)/clusterAvailable
The final score is a max over all resource types.
Topology score will fall into the following intervals if:
User is under quota (guarantee): [(-guarantee)/available : 0]
User is over quota: (0, infinity)
Unfortunately, score below 0 does not guarantee that the topology will be scheduled due to resources fragmentation.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>availableCpu</code> - available CPU on the cluster.</dd>
<dd><code>availableMemory</code> - available memory on the cluster.</dd>
<dd><code>availableGenericResources</code> - available generic resources (other that cpu and memory) in cluster</dd>
<dd><code>td</code> - the topology we are looking at.</dd>
<dt>Returns:</dt>
<dd>the score.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getScore(double,double,java.util.Map)">
<h3>getScore</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getScore</span><wbr><span class="parameters">(double&nbsp;availableCpu,
double&nbsp;availableMemory,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="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>&gt;&nbsp;availableGenericResources)</span></div>
</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>