Google Git
Sign in
apache / incubator-heron / refs/heads/asf-site / . / content / api / java / backtype / storm / topology / IRichSpoutDelegate.html
blob: 8b64545fe89e2d59a2781439599a32e743fc3615 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>IRichSpoutDelegate (Heron Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-03-01">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/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="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IRichSpoutDelegate (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<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="subNavList">
<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>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">backtype.storm.topology</a></div>
<h2 title="Class IRichSpoutDelegate" class="title">Class IRichSpoutDelegate</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>backtype.storm.topology.IRichSpoutDelegate</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code>, <code><a href="../../../org/apache/heron/api/spout/IRichSpout.html" title="interface in org.apache.heron.api.spout">IRichSpout</a></code>, <code><a href="../../../org/apache/heron/api/spout/ISpout.html" title="interface in org.apache.heron.api.spout">ISpout</a></code>, <code><a href="../../../org/apache/heron/api/topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></code>, <code><a href="../../../org/apache/heron/api/topology/IUpdatable.html" title="interface in org.apache.heron.api.topology">IUpdatable</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">IRichSpoutDelegate</span>
extends java.lang.Object
implements <a href="../../../org/apache/heron/api/spout/IRichSpout.html" title="interface in org.apache.heron.api.spout">IRichSpout</a>, <a href="../../../org/apache/heron/api/topology/IUpdatable.html" title="interface in org.apache.heron.api.topology">IUpdatable</a></pre>
<div class="block">When writing topologies using Java, <a href="IRichBolt.html" title="interface in backtype.storm.topology"><code>IRichBolt</code></a> and <a href="IRichSpout.html" title="interface in backtype.storm.topology"><code>IRichSpout</code></a> are the main interfaces
to use to implement components of the topology.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../serialized-form.html#backtype.storm.topology.IRichSpoutDelegate">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(backtype.storm.topology.IRichSpout)">IRichSpoutDelegate</a></span>&#8203;(<a href="IRichSpout.html" title="interface in backtype.storm.topology">IRichSpout</a>&nbsp;delegate)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ack(java.lang.Object)">ack</a></span>&#8203;(java.lang.Object&nbsp;msgId)</code></th>
<td class="colLast">
<div class="block">Heron has determined that the tuple emitted by this spout with the msgId identifier
has been fully processed.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#activate()">activate</a></span>()</code></th>
<td class="colLast">
<div class="block">Called when a spout has been activated out of a deactivated mode.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Called when an ISpout is going to be shutdown.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deactivate()">deactivate</a></span>()</code></th>
<td class="colLast">
<div class="block">Called when a spout has been deactivated.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">declareOutputFields</a></span>&#8203;(<a href="../../../org/apache/heron/api/topology/OutputFieldsDeclarer.html" title="interface in org.apache.heron.api.topology">OutputFieldsDeclarer</a>&nbsp;declarer)</code></th>
<td class="colLast">
<div class="block">Declare the output schema for all the streams of this topology.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fail(java.lang.Object)">fail</a></span>&#8203;(java.lang.Object&nbsp;msgId)</code></th>
<td class="colLast">
<div class="block">The tuple emitted by this spout with the msgId identifier has failed to be
fully processed.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentConfiguration()">getComponentConfiguration</a></span>()</code></th>
<td class="colLast">
<div class="block">Declare configuration specific to this component.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextTuple()">nextTuple</a></span>()</code></th>
<td class="colLast">
<div class="block">When this method is called, Heron is requesting that the Spout emit tuples to the
output collector.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#open(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.spout.SpoutOutputCollector)">open</a></span>&#8203;(java.util.Map&nbsp;conf,
<a href="../../../org/apache/heron/api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a>&nbsp;context,
<a href="../../../org/apache/heron/api/spout/SpoutOutputCollector.html" title="class in org.apache.heron.api.spout">SpoutOutputCollector</a>&nbsp;collector)</code></th>
<td class="colLast">
<div class="block">Called when a task for this component is initialized within a worker on the cluster.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#update(org.apache.heron.api.topology.TopologyContext)">update</a></span>&#8203;(<a href="../../../org/apache/heron/api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a>&nbsp;topologyContext)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(backtype.storm.topology.IRichSpout)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IRichSpoutDelegate</h4>
<pre>public&nbsp;IRichSpoutDelegate&#8203;(<a href="IRichSpout.html" title="interface in backtype.storm.topology">IRichSpout</a>&nbsp;delegate)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="open(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.spout.SpoutOutputCollector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;open&#8203;(java.util.Map&nbsp;conf,
<a href="../../../org/apache/heron/api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a>&nbsp;context,
<a href="../../../org/apache/heron/api/spout/SpoutOutputCollector.html" title="class in org.apache.heron.api.spout">SpoutOutputCollector</a>&nbsp;collector)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/heron/api/spout/ISpout.html#open(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.spout.SpoutOutputCollector)">ISpout</a></code></span></div>
<div class="block">Called when a task for this component is initialized within a worker on the cluster.
It provides the spout with the environment in which the spout executes.
<p>
<p>This includes the:</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/heron/api/spout/ISpout.html#open(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.spout.SpoutOutputCollector)">open</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/heron/api/spout/ISpout.html" title="interface in org.apache.heron.api.spout">ISpout</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - The Heron configuration for this spout. This is the configuration provided to the topology merged in with cluster configuration on this machine.</dd>
<dd><code>context</code> - This object can be used to get information about this task's place within the topology, including the task id and component id of this task, input and output information, etc.</dd>
<dd><code>collector</code> - The collector is used to emit tuples from this spout. Tuples can be emitted at any time, including the open and close methods. The collector is thread-safe and should be saved as an instance variable of this spout object.</dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/heron/api/spout/ISpout.html#close()">ISpout</a></code></span></div>
<div class="block">Called when an ISpout is going to be shutdown. There is no guarentee that close
will be called, because the supervisor kill -9's worker processes on the cluster.
<p>
<p>The one context where close is guaranteed to be called is a topology is
killed when running Heron in simulator.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/heron/api/spout/ISpout.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/heron/api/spout/ISpout.html" title="interface in org.apache.heron.api.spout">ISpout</a></code></dd>
</dl>
</li>
</ul>
<a id="activate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>activate</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;activate()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/heron/api/spout/ISpout.html#activate()">ISpout</a></code></span></div>
<div class="block">Called when a spout has been activated out of a deactivated mode.
nextTuple will be called on this spout soon. A spout can become activated
after having been deactivated when the topology is manipulated using the
`heron` client.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/heron/api/spout/ISpout.html#activate()">activate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/heron/api/spout/ISpout.html" title="interface in org.apache.heron.api.spout">ISpout</a></code></dd>
</dl>
</li>
</ul>
<a id="deactivate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deactivate</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;deactivate()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/heron/api/spout/ISpout.html#deactivate()">ISpout</a></code></span></div>
<div class="block">Called when a spout has been deactivated. nextTuple will not be called while
a spout is deactivated. The spout may or may not be reactivated in the future.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/heron/api/spout/ISpout.html#deactivate()">deactivate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/heron/api/spout/ISpout.html" title="interface in org.apache.heron.api.spout">ISpout</a></code></dd>
</dl>
</li>
</ul>
<a id="nextTuple()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextTuple</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;nextTuple()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/heron/api/spout/ISpout.html#nextTuple()">ISpout</a></code></span></div>
<div class="block">When this method is called, Heron is requesting that the Spout emit tuples to the
output collector. This method should be non-blocking, so if the Spout has no tuples
to emit, this method should return. nextTuple, ack, and fail are all called in a tight
loop in a single thread in the spout task. When there are no tuples to emit, it is courteous
to have nextTuple sleep for a short amount of time (like a single millisecond)
so as not to waste too much CPU.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/heron/api/spout/ISpout.html#nextTuple()">nextTuple</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/heron/api/spout/ISpout.html" title="interface in org.apache.heron.api.spout">ISpout</a></code></dd>
</dl>
</li>
</ul>
<a id="ack(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ack</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;ack&#8203;(java.lang.Object&nbsp;msgId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/heron/api/spout/ISpout.html#ack(java.lang.Object)">ISpout</a></code></span></div>
<div class="block">Heron has determined that the tuple emitted by this spout with the msgId identifier
has been fully processed. Typically, an implementation of this method will take that
message off the queue and prevent it from being replayed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/heron/api/spout/ISpout.html#ack(java.lang.Object)">ack</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/heron/api/spout/ISpout.html" title="interface in org.apache.heron.api.spout">ISpout</a></code></dd>
</dl>
</li>
</ul>
<a id="fail(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fail</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;fail&#8203;(java.lang.Object&nbsp;msgId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/heron/api/spout/ISpout.html#fail(java.lang.Object)">ISpout</a></code></span></div>
<div class="block">The tuple emitted by this spout with the msgId identifier has failed to be
fully processed. Typically, an implementation of this method will put that
message back on the queue to be replayed at a later time.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/heron/api/spout/ISpout.html#fail(java.lang.Object)">fail</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/heron/api/spout/ISpout.html" title="interface in org.apache.heron.api.spout">ISpout</a></code></dd>
</dl>
</li>
</ul>
<a id="declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>declareOutputFields</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;declareOutputFields&#8203;(<a href="../../../org/apache/heron/api/topology/OutputFieldsDeclarer.html" title="interface in org.apache.heron.api.topology">OutputFieldsDeclarer</a>&nbsp;declarer)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/heron/api/topology/IComponent.html#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">IComponent</a></code></span></div>
<div class="block">Declare the output schema for all the streams of this topology.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/heron/api/topology/IComponent.html#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">declareOutputFields</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/heron/api/topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>declarer</code> - this is used to declare output stream ids, output fields, and whether or not each output stream is a direct stream</dd>
</dl>
</li>
</ul>
<a id="getComponentConfiguration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponentConfiguration</h4>
<pre class="methodSignature">public&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;getComponentConfiguration()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/heron/api/topology/IComponent.html#getComponentConfiguration()">IComponent</a></code></span></div>
<div class="block">Declare configuration specific to this component. Only a subset of the "topology.*" configs can
be overridden. The component configuration can be further overridden when constructing the
topology using <a href="../../../org/apache/heron/api/topology/TopologyBuilder.html" title="class in org.apache.heron.api.topology"><code>TopologyBuilder</code></a></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/heron/api/topology/IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/heron/api/topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></code></dd>
</dl>
</li>
</ul>
<a id="update(org.apache.heron.api.topology.TopologyContext)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>update</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;update&#8203;(<a href="../../../org/apache/heron/api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a>&nbsp;topologyContext)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/heron/api/topology/IUpdatable.html#update(org.apache.heron.api.topology.TopologyContext)">update</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/heron/api/topology/IUpdatable.html" title="interface in org.apache.heron.api.topology">IUpdatable</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<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="subNavList">
<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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>