| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ResourceDeclarer (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.topology, interface: ResourceDeclarer"> |
| <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/ResourceDeclarer.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.topology</a></div> |
| <h1 title="Interface ResourceDeclarer" class="title">Interface ResourceDeclarer<T extends ResourceDeclarer></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code>, <code><a href="ComponentConfigurationDeclarer.html" title="interface in org.apache.storm.topology">ComponentConfigurationDeclarer</a><T></code>, <code><a href="../drpc/LinearDRPCInputDeclarer.html" title="interface in org.apache.storm.drpc">LinearDRPCInputDeclarer</a></code>, <code><a href="SpoutDeclarer.html" title="interface in org.apache.storm.topology">SpoutDeclarer</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="BaseConfigurationDeclarer.html" title="class in org.apache.storm.topology">BaseConfigurationDeclarer</a></code>, <code><a href="../trident/operation/DefaultResourceDeclarer.html" title="class in org.apache.storm.trident.operation">DefaultResourceDeclarer</a></code>, <code><a href="../trident/planner/Node.html" title="class in org.apache.storm.trident.planner">Node</a></code>, <code><a href="../trident/planner/PartitionNode.html" title="class in org.apache.storm.trident.planner">PartitionNode</a></code>, <code><a href="../trident/planner/ProcessorNode.html" title="class in org.apache.storm.trident.planner">ProcessorNode</a></code>, <code><a href="../trident/planner/SpoutNode.html" title="class in org.apache.storm.trident.planner">SpoutNode</a></code>, <code><a href="../trident/Stream.html" title="class in org.apache.storm.trident">Stream</a></code>, <code><a href="TopologyBuilder.BoltGetter.html" title="class in org.apache.storm.topology">TopologyBuilder.BoltGetter</a></code>, <code><a href="TopologyBuilder.ConfigGetter.html" title="class in org.apache.storm.topology">TopologyBuilder.ConfigGetter</a></code>, <code><a href="TopologyBuilder.SpoutGetter.html" title="class in org.apache.storm.topology">TopologyBuilder.SpoutGetter</a></code>, <code><a href="../trident/TridentState.html" title="class in org.apache.storm.trident">TridentState</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ResourceDeclarer<T extends ResourceDeclarer></span></div> |
| <div class="block">This is a new base interface that can be used by anything that wants to mirror RAS's basic API. Trident uses this to allow setting |
| resources in the Stream API.</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></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="ResourceDeclarer.html" title="type parameter in ResourceDeclarer">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addSharedMemory(org.apache.storm.generated.SharedMemory)" class="member-name-link">addSharedMemory</a><wbr>(<a href="../generated/SharedMemory.html" title="class in org.apache.storm.generated">SharedMemory</a> request)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Add in request for shared memory that this component will use.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ResourceDeclarer.html" title="type parameter in ResourceDeclarer">T</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setCPULoad(java.lang.Number)" class="member-name-link">setCPULoad</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> amount)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Set the amount of CPU load for this component.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ResourceDeclarer.html" title="type parameter in ResourceDeclarer">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setMemoryLoad(java.lang.Number)" class="member-name-link">setMemoryLoad</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> onHeap)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Set the amount of on heap memory for this component.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ResourceDeclarer.html" title="type parameter in ResourceDeclarer">T</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setMemoryLoad(java.lang.Number,java.lang.Number)" class="member-name-link">setMemoryLoad</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> onHeap, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> offHeap)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Set the amount of memory for this component on and off heap.</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="setMemoryLoad(java.lang.Number)"> |
| <h3>setMemoryLoad</h3> |
| <div class="member-signature"><span class="return-type"><a href="ResourceDeclarer.html" title="type parameter in ResourceDeclarer">T</a></span> <span class="element-name">setMemoryLoad</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> onHeap)</span></div> |
| <div class="block">Set the amount of on heap memory for this component.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>onHeap</code> - the amount of on heap memory</dd> |
| <dt>Returns:</dt> |
| <dd>this for chaining</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMemoryLoad(java.lang.Number,java.lang.Number)"> |
| <h3>setMemoryLoad</h3> |
| <div class="member-signature"><span class="return-type"><a href="ResourceDeclarer.html" title="type parameter in ResourceDeclarer">T</a></span> <span class="element-name">setMemoryLoad</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> onHeap, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> offHeap)</span></div> |
| <div class="block">Set the amount of memory for this component on and off heap.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>onHeap</code> - the amount of on heap memory</dd> |
| <dd><code>offHeap</code> - the amount of off heap memory</dd> |
| <dt>Returns:</dt> |
| <dd>this for chaining</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCPULoad(java.lang.Number)"> |
| <h3>setCPULoad</h3> |
| <div class="member-signature"><span class="return-type"><a href="ResourceDeclarer.html" title="type parameter in ResourceDeclarer">T</a></span> <span class="element-name">setCPULoad</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> amount)</span></div> |
| <div class="block">Set the amount of CPU load for this component.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>amount</code> - the amount of CPU</dd> |
| <dt>Returns:</dt> |
| <dd>this for chaining</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addSharedMemory(org.apache.storm.generated.SharedMemory)"> |
| <h3>addSharedMemory</h3> |
| <div class="member-signature"><span class="return-type"><a href="ResourceDeclarer.html" title="type parameter in ResourceDeclarer">T</a></span> <span class="element-name">addSharedMemory</span><wbr><span class="parameters">(<a href="../generated/SharedMemory.html" title="class in org.apache.storm.generated">SharedMemory</a> request)</span></div> |
| <div class="block">Add in request for shared memory that this component will use. See <a href="SharedOnHeap.html" title="class in org.apache.storm.topology"><code>SharedOnHeap</code></a>, <a href="SharedOffHeapWithinNode.html" title="class in org.apache.storm.topology"><code>SharedOffHeapWithinNode</code></a>, and <a href="SharedOffHeapWithinWorker.html" title="class in org.apache.storm.topology"><code>SharedOffHeapWithinWorker</code></a> for convenient ways to create shared memory requests.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>request</code> - the shared memory request for this component</dd> |
| <dt>Returns:</dt> |
| <dd>this for chaining</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> |
