Google Git
Sign in
apache / storm-site / refs/heads/asf-site / . / content / releases / current / javadocs / org / apache / storm / trident / operation / DefaultResourceDeclarer.html
blob: b27fd37285e2b5a4490f0d125deea928bacf6dc9 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>DefaultResourceDeclarer (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.trident.operation, class: DefaultResourceDeclarer">
<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/DefaultResourceDeclarer.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.trident.operation</a></div>
<h1 title="Class DefaultResourceDeclarer" class="title">Class DefaultResourceDeclarer&lt;T extends DefaultResourceDeclarer&gt;</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.trident.operation.DefaultResourceDeclarer&lt;T&gt;</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>T</code> - Must always be the type of the extending class. i.e. <code>public class SubResourceDeclarer extends
DefaultResourceDeclarer&lt;SubResourceDeclarer&gt; {...}</code></dd>
</dl>
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../topology/ResourceDeclarer.html" title="interface in org.apache.storm.topology">ResourceDeclarer</a>&lt;T&gt;</code>, <code><a href="ITridentResource.html" title="interface in org.apache.storm.trident.operation">ITridentResource</a></code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../planner/Node.html" title="class in org.apache.storm.trident.planner">Node</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DefaultResourceDeclarer&lt;T extends DefaultResourceDeclarer&gt;</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>
implements <a href="../../topology/ResourceDeclarer.html" title="interface in org.apache.storm.topology">ResourceDeclarer</a>&lt;T&gt;, <a href="ITridentResource.html" title="interface in org.apache.storm.trident.operation">ITridentResource</a></span></div>
<div class="block">Default implementation of resources declarer.</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()" class="member-name-link">DefaultResourceDeclarer</a>()</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><a href="DefaultResourceDeclarer.html" title="type parameter in DefaultResourceDeclarer">T</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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>&nbsp;request)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<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-tab4"><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>&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/Number.html" title="class or interface in java.lang" class="external-link">Number</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResources()" class="member-name-link">getResources</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get resource.</div>
</div>
<div class="col-first even-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/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../../generated/SharedMemory.html" title="class in org.apache.storm.generated">SharedMemory</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSharedMemory()" class="member-name-link">getSharedMemory</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get shared memory.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DefaultResourceDeclarer.html" title="type parameter in DefaultResourceDeclarer">T</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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>&nbsp;amount)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<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-tab4"><code><a href="DefaultResourceDeclarer.html" title="type parameter in DefaultResourceDeclarer">T</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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>&nbsp;onHeap)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<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-tab4"><code><a href="DefaultResourceDeclarer.html" title="type parameter in DefaultResourceDeclarer">T</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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>&nbsp;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>&nbsp;offHeap)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the amount of memory for this component on and off heap.</div>
</div>
</div>
</div>
</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">
<!-- ========= 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;()">
<h3>DefaultResourceDeclarer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DefaultResourceDeclarer</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="setMemoryLoad(java.lang.Number)">
<h3>setMemoryLoad</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DefaultResourceDeclarer.html" title="type parameter in DefaultResourceDeclarer">T</a></span>&nbsp;<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>&nbsp;onHeap)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../../topology/ResourceDeclarer.html#setMemoryLoad(java.lang.Number)">ResourceDeclarer</a></code></span></div>
<div class="block">Set the amount of on heap memory for this component.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../topology/ResourceDeclarer.html#setMemoryLoad(java.lang.Number)">setMemoryLoad</a></code>&nbsp;in interface&nbsp;<code><a href="../../topology/ResourceDeclarer.html" title="interface in org.apache.storm.topology">ResourceDeclarer</a>&lt;<a href="DefaultResourceDeclarer.html" title="type parameter in DefaultResourceDeclarer">T</a> extends <a href="DefaultResourceDeclarer.html" title="class in org.apache.storm.trident.operation">DefaultResourceDeclarer</a>&gt;</code></dd>
<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="modifiers">public</span>&nbsp;<span class="return-type"><a href="DefaultResourceDeclarer.html" title="type parameter in DefaultResourceDeclarer">T</a></span>&nbsp;<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>&nbsp;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>&nbsp;offHeap)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../../topology/ResourceDeclarer.html#setMemoryLoad(java.lang.Number,java.lang.Number)">ResourceDeclarer</a></code></span></div>
<div class="block">Set the amount of memory for this component on and off heap.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../topology/ResourceDeclarer.html#setMemoryLoad(java.lang.Number,java.lang.Number)">setMemoryLoad</a></code>&nbsp;in interface&nbsp;<code><a href="../../topology/ResourceDeclarer.html" title="interface in org.apache.storm.topology">ResourceDeclarer</a>&lt;<a href="DefaultResourceDeclarer.html" title="type parameter in DefaultResourceDeclarer">T</a> extends <a href="DefaultResourceDeclarer.html" title="class in org.apache.storm.trident.operation">DefaultResourceDeclarer</a>&gt;</code></dd>
<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="modifiers">public</span>&nbsp;<span class="return-type"><a href="DefaultResourceDeclarer.html" title="type parameter in DefaultResourceDeclarer">T</a></span>&nbsp;<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>&nbsp;amount)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../../topology/ResourceDeclarer.html#setCPULoad(java.lang.Number)">ResourceDeclarer</a></code></span></div>
<div class="block">Set the amount of CPU load for this component.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../topology/ResourceDeclarer.html#setCPULoad(java.lang.Number)">setCPULoad</a></code>&nbsp;in interface&nbsp;<code><a href="../../topology/ResourceDeclarer.html" title="interface in org.apache.storm.topology">ResourceDeclarer</a>&lt;<a href="DefaultResourceDeclarer.html" title="type parameter in DefaultResourceDeclarer">T</a> extends <a href="DefaultResourceDeclarer.html" title="class in org.apache.storm.trident.operation">DefaultResourceDeclarer</a>&gt;</code></dd>
<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="getResources()">
<h3>getResources</h3>
<div class="member-signature"><span class="modifiers">public</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/Number.html" title="class or interface in java.lang" class="external-link">Number</a>&gt;</span>&nbsp;<span class="element-name">getResources</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ITridentResource.html#getResources()">ITridentResource</a></code></span></div>
<div class="block">Get resource.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="ITridentResource.html#getResources()">getResources</a></code>&nbsp;in interface&nbsp;<code><a href="ITridentResource.html" title="interface in org.apache.storm.trident.operation">ITridentResource</a></code></dd>
<dt>Returns:</dt>
<dd>a name of resource name -> amount of that resource. *Return should never be null!*</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSharedMemory()">
<h3>getSharedMemory</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&lt;<a href="../../generated/SharedMemory.html" title="class in org.apache.storm.generated">SharedMemory</a>&gt;</span>&nbsp;<span class="element-name">getSharedMemory</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ITridentResource.html#getSharedMemory()">ITridentResource</a></code></span></div>
<div class="block">Get shared memory.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="ITridentResource.html#getSharedMemory()">getSharedMemory</a></code>&nbsp;in interface&nbsp;<code><a href="ITridentResource.html" title="interface in org.apache.storm.trident.operation">ITridentResource</a></code></dd>
<dt>Returns:</dt>
<dd>the shared memory region requests</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addSharedMemory(org.apache.storm.generated.SharedMemory)">
<h3>addSharedMemory</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DefaultResourceDeclarer.html" title="type parameter in DefaultResourceDeclarer">T</a></span>&nbsp;<span class="element-name">addSharedMemory</span><wbr><span class="parameters">(<a href="../../generated/SharedMemory.html" title="class in org.apache.storm.generated">SharedMemory</a>&nbsp;request)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../../topology/ResourceDeclarer.html#addSharedMemory(org.apache.storm.generated.SharedMemory)">ResourceDeclarer</a></code></span></div>
<div class="block">Add in request for shared memory that this component will use. See <a href="../../topology/SharedOnHeap.html" title="class in org.apache.storm.topology"><code>SharedOnHeap</code></a>, <a href="../../topology/SharedOffHeapWithinNode.html" title="class in org.apache.storm.topology"><code>SharedOffHeapWithinNode</code></a>, and <a href="../../topology/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>Specified by:</dt>
<dd><code><a href="../../topology/ResourceDeclarer.html#addSharedMemory(org.apache.storm.generated.SharedMemory)">addSharedMemory</a></code>&nbsp;in interface&nbsp;<code><a href="../../topology/ResourceDeclarer.html" title="interface in org.apache.storm.topology">ResourceDeclarer</a>&lt;<a href="DefaultResourceDeclarer.html" title="type parameter in DefaultResourceDeclarer">T</a> extends <a href="DefaultResourceDeclarer.html" title="class in org.apache.storm.trident.operation">DefaultResourceDeclarer</a>&gt;</code></dd>
<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 &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>