| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ObjectResourcesItem (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.scheduling, class: ObjectResourcesItem"> |
| <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/ObjectResourcesItem.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><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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.resource.strategies.scheduling</a></div> |
| <h1 title="Class ObjectResourcesItem" class="title">Class ObjectResourcesItem</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">org.apache.storm.scheduler.resource.strategies.scheduling.ObjectResourcesItem</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ObjectResourcesItem</span> |
| <span class="extends-implements">extends <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></div> |
| <div class="block">class to keep track of resources on a rack or node.</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><a href="../../normalization/NormalizedResourceOffer.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceOffer</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#availableResources" class="member-name-link">availableResources</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>double</code></div> |
| <div class="col-second odd-row-color"><code><a href="#avgResourcePercent" class="member-name-link">avgResourcePercent</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Amongst all <a href="#availableResources"><code>availableResources</code></a>, this is the average ratio of resource to the total available in group.</div> |
| </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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#id" class="member-name-link">id</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>double</code></div> |
| <div class="col-second odd-row-color"><code><a href="#minResourcePercent" class="member-name-link">minResourcePercent</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Amongst all <a href="#availableResources"><code>availableResources</code></a>, this is the minimum ratio of resource to the total available in group.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../../normalization/NormalizedResourceOffer.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceOffer</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#totalResources" class="member-name-link">totalResources</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </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(java.lang.String)" class="member-name-link">ObjectResourcesItem</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> id)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.storm.scheduler.resource.normalization.NormalizedResourceOffer,org.apache.storm.scheduler.resource.normalization.NormalizedResourceOffer,double,double)" class="member-name-link">ObjectResourcesItem</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> id, |
| <a href="../../normalization/NormalizedResourceOffer.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceOffer</a> availableResources, |
| <a href="../../normalization/NormalizedResourceOffer.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceOffer</a> totalResources, |
| double minResourcePercent, |
| double avgResourcePercent)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.storm.scheduler.resource.strategies.scheduling.ObjectResourcesItem)" class="member-name-link">ObjectResourcesItem</a><wbr>(<a href="ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesItem</a> other)</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.apache.storm.scheduler.resource.strategies.scheduling.ObjectResourcesItem)" class="member-name-link">add</a><wbr>(<a href="ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesItem</a> other)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="id"> |
| <h3>id</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <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">id</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="availableResources"> |
| <h3>availableResources</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../normalization/NormalizedResourceOffer.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceOffer</a></span> <span class="element-name">availableResources</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="totalResources"> |
| <h3>totalResources</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../normalization/NormalizedResourceOffer.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceOffer</a></span> <span class="element-name">totalResources</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="minResourcePercent"> |
| <h3>minResourcePercent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">minResourcePercent</span></div> |
| <div class="block">Amongst all <a href="#availableResources"><code>availableResources</code></a>, this is the minimum ratio of resource to the total available in group. |
| Note that nodes are grouped into hosts. Hosts into racks. And racks are grouped under the cluster. |
| |
| <p> |
| An example of this calculation is in <a href="sorter/NodeSorter.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling.sorter"><code>NodeSorter</code></a> |
| where value is calculated by <a href="ObjectResourcesSummary.html#getAvailableResourcesOverall()"><code>ObjectResourcesSummary.getAvailableResourcesOverall()</code></a> |
| using <a href="../../normalization/NormalizedResourceOffer.html#calculateMinPercentageUsedBy(org.apache.storm.scheduler.resource.normalization.NormalizedResourceOffer)"><code>NormalizedResourceOffer.calculateMinPercentageUsedBy(NormalizedResourceOffer)</code></a>. |
| </p></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="avgResourcePercent"> |
| <h3>avgResourcePercent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">avgResourcePercent</span></div> |
| <div class="block">Amongst all <a href="#availableResources"><code>availableResources</code></a>, this is the average ratio of resource to the total available in group. |
| Note that nodes are grouped into hosts, hosts into racks, and racks are grouped under the cluster. |
| |
| <p> |
| An example of this calculation is in <a href="sorter/NodeSorter.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling.sorter"><code>NodeSorter</code></a> |
| where value is calculated by <a href="ObjectResourcesSummary.html#getAvailableResourcesOverall()"><code>ObjectResourcesSummary.getAvailableResourcesOverall()</code></a> |
| using <a href="../../normalization/NormalizedResourceOffer.html#calculateAveragePercentageUsedBy(org.apache.storm.scheduler.resource.normalization.NormalizedResourceOffer)"><code>NormalizedResourceOffer.calculateAveragePercentageUsedBy(NormalizedResourceOffer)</code></a>. |
| </p></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="<init>(java.lang.String)"> |
| <h3>ObjectResourcesItem</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ObjectResourcesItem</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> id)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.storm.scheduler.resource.strategies.scheduling.ObjectResourcesItem)"> |
| <h3>ObjectResourcesItem</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ObjectResourcesItem</span><wbr><span class="parameters">(<a href="ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesItem</a> other)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,org.apache.storm.scheduler.resource.normalization.NormalizedResourceOffer,org.apache.storm.scheduler.resource.normalization.NormalizedResourceOffer,double,double)"> |
| <h3>ObjectResourcesItem</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ObjectResourcesItem</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> id, |
| <a href="../../normalization/NormalizedResourceOffer.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceOffer</a> availableResources, |
| <a href="../../normalization/NormalizedResourceOffer.html" title="class in org.apache.storm.scheduler.resource.normalization">NormalizedResourceOffer</a> totalResources, |
| double minResourcePercent, |
| double avgResourcePercent)</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="add(org.apache.storm.scheduler.resource.strategies.scheduling.ObjectResourcesItem)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="ObjectResourcesItem.html" title="class in org.apache.storm.scheduler.resource.strategies.scheduling">ObjectResourcesItem</a> other)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |