| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>BaseWindowedBolt (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.base, class: BaseWindowedBolt"> |
| <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/BaseWindowedBolt.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><a href="#nested-class-summary">Nested</a> | </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.topology.base</a></div> |
| <h1 title="Class BaseWindowedBolt" class="title">Class BaseWindowedBolt</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.topology.base.BaseWindowedBolt</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="../IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code>, <code><a href="../IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a></code>, <code><a href="../../bolt/JoinBolt.html" title="class in org.apache.storm.bolt">JoinBolt</a></code>, <code><a href="../../starter/bolt/SlidingWindowSumBolt.html" title="class in org.apache.storm.starter.bolt">SlidingWindowSumBolt</a></code>, <code><a href="../../flux/examples/TestWindowBolt.html" title="class in org.apache.storm.flux.examples">TestWindowBolt</a></code>, <code><a href="../../st/topology/window/TimeDataVerificationBolt.html" title="class in org.apache.storm.st.topology.window">TimeDataVerificationBolt</a></code>, <code><a href="../../st/topology/window/VerificationBolt.html" title="class in org.apache.storm.st.topology.window">VerificationBolt</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">BaseWindowedBolt</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="../IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../serialized-form.html#org.apache.storm.topology.base.BaseWindowedBolt">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</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">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="BaseWindowedBolt.Count.html" class="type-name-link" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Holds a count value for count based windows and sliding intervals.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="BaseWindowedBolt.Duration.html" class="type-name-link" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Holds a Time duration for time based windows and sliding intervals.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== 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>protected <a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#timestampExtractor" class="member-name-link">timestampExtractor</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected 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><<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#windowConfiguration" class="member-name-link">windowConfiguration</a></code></div> |
| <div class="col-last odd-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 three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">BaseWindowedBolt</a>()</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="#cleanup()" class="member-name-link">cleanup</a>()</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)" class="member-name-link">declareOutputFields</a><wbr>(<a href="../OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a> declarer)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Declare the output schema for all the streams of this topology.</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/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getComponentConfiguration()" class="member-name-link">getComponentConfiguration</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Declare configuration specific to 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="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTimestampExtractor()" class="member-name-link">getTimestampExtractor</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return a <a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing"><code>TimestampExtractor</code></a> for extracting timestamps from a tuple for event time based processing, or null for processing |
| time.</div> |
| </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="#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)" class="member-name-link">prepare</a><wbr>(<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><<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> topoConf, |
| <a href="../../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> context, |
| <a href="../../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a> collector)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This is similar to the <a href="../../task/IBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)"><code>IBolt.prepare(Map, TopologyContext, OutputCollector)</code></a> except that while emitting, |
| the tuples are automatically anchored to the tuples in the inputWindow.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withLag(org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">withLag</a><wbr>(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specify the maximum time lag of the tuple timestamp in milliseconds.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withLateTupleStream(java.lang.String)" class="member-name-link">withLateTupleStream</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> streamId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specify a stream id on which late tuples are going to be emitted.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withTimestampExtractor(org.apache.storm.windowing.TimestampExtractor)" class="member-name-link">withTimestampExtractor</a><wbr>(<a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a> timestampExtractor)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specify the timestamp extractor implementation.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withTimestampField(java.lang.String)" class="member-name-link">withTimestampField</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> fieldName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specify a field in the tuple that represents the timestamp as a long value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)" class="member-name-link">withTumblingWindow</a><wbr>(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> count)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A count based tumbling window.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">withTumblingWindow</a><wbr>(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A time duration based tumbling window.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withWatermarkInterval(org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">withWatermarkInterval</a><wbr>(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> interval)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specify the watermark event generation interval.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)" class="member-name-link">withWindow</a><wbr>(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A tuple count based window that slides with every incoming tuple.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Count)" class="member-name-link">withWindow</a><wbr>(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Tuple count based sliding window configuration.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">withWindow</a><wbr>(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Tuple count and time duration based sliding window configuration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">withWindow</a><wbr>(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A time duration based window that slides with every incoming tuple.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Count)" class="member-name-link">withWindow</a><wbr>(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Time duration and count based sliding window configuration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">withWindow</a><wbr>(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Time duration based sliding window configuration.</div> |
| </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#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> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.topology.IWindowedBolt">Methods inherited from interface org.apache.storm.topology.<a href="../IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></h3> |
| <code><a href="../IWindowedBolt.html#execute(org.apache.storm.windowing.TupleWindow)">execute</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="windowConfiguration"> |
| <h3>windowConfiguration</h3> |
| <div class="member-signature"><span class="modifiers">protected final transient</span> <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><<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">windowConfiguration</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="timestampExtractor"> |
| <h3>timestampExtractor</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a></span> <span class="element-name">timestampExtractor</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="<init>()"> |
| <h3>BaseWindowedBolt</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">BaseWindowedBolt</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="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Count)"> |
| <h3>withWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withWindow</span><wbr><span class="parameters">(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</span></div> |
| <div class="block">Tuple count based sliding window configuration.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>windowLength</code> - the number of tuples in the window</dd> |
| <dd><code>slidingInterval</code> - the number of tuples after which the window slides</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration)"> |
| <h3>withWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withWindow</span><wbr><span class="parameters">(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</span></div> |
| <div class="block">Tuple count and time duration based sliding window configuration.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>windowLength</code> - the number of tuples in the window</dd> |
| <dd><code>slidingInterval</code> - the time duration after which the window slides</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Count)"> |
| <h3>withWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withWindow</span><wbr><span class="parameters">(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</span></div> |
| <div class="block">Time duration and count based sliding window configuration.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>windowLength</code> - the time duration of the window</dd> |
| <dd><code>slidingInterval</code> - the number of tuples after which the window slides</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Duration)"> |
| <h3>withWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withWindow</span><wbr><span class="parameters">(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</span></div> |
| <div class="block">Time duration based sliding window configuration.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>windowLength</code> - the time duration of the window</dd> |
| <dd><code>slidingInterval</code> - the time duration after which the window slides</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)"> |
| <h3>withWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withWindow</span><wbr><span class="parameters">(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength)</span></div> |
| <div class="block">A tuple count based window that slides with every incoming tuple.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>windowLength</code> - the number of tuples in the window</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)"> |
| <h3>withWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withWindow</span><wbr><span class="parameters">(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength)</span></div> |
| <div class="block">A time duration based window that slides with every incoming tuple.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>windowLength</code> - the time duration of the window</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)"> |
| <h3>withTumblingWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withTumblingWindow</span><wbr><span class="parameters">(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> count)</span></div> |
| <div class="block">A count based tumbling window.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>count</code> - the number of tuples after which the window tumbles</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)"> |
| <h3>withTumblingWindow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withTumblingWindow</span><wbr><span class="parameters">(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</span></div> |
| <div class="block">A time duration based tumbling window.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>duration</code> - the time duration after which the window tumbles</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withTimestampField(java.lang.String)"> |
| <h3>withTimestampField</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withTimestampField</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> fieldName)</span></div> |
| <div class="block">Specify a field in the tuple that represents the timestamp as a long value. If this field is not present in the incoming tuple, an |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> will be thrown. The field MUST contain a timestamp in milliseconds</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fieldName</code> - the name of the field that contains the timestamp</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withTimestampExtractor(org.apache.storm.windowing.TimestampExtractor)"> |
| <h3>withTimestampExtractor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withTimestampExtractor</span><wbr><span class="parameters">(<a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a> timestampExtractor)</span></div> |
| <div class="block">Specify the timestamp extractor implementation.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>timestampExtractor</code> - the <a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing"><code>TimestampExtractor</code></a> implementation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTimestampExtractor()"> |
| <h3>getTimestampExtractor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a></span> <span class="element-name">getTimestampExtractor</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../IWindowedBolt.html#getTimestampExtractor()">IWindowedBolt</a></code></span></div> |
| <div class="block">Return a <a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing"><code>TimestampExtractor</code></a> for extracting timestamps from a tuple for event time based processing, or null for processing |
| time.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../IWindowedBolt.html#getTimestampExtractor()">getTimestampExtractor</a></code> in interface <code><a href="../IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the timestamp extractor</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withLateTupleStream(java.lang.String)"> |
| <h3>withLateTupleStream</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withLateTupleStream</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> streamId)</span></div> |
| <div class="block">Specify a stream id on which late tuples are going to be emitted. They are going to be accessible via the <a href="../WindowedBoltExecutor.html#LATE_TUPLE_FIELD"><code>WindowedBoltExecutor.LATE_TUPLE_FIELD</code></a> field. It must be defined on a per-component basis, and in |
| conjunction with the <a href="#withTimestampField(java.lang.String)"><code>withTimestampField(java.lang.String)</code></a>, otherwise <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> will be thrown.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>streamId</code> - the name of the stream used to emit late tuples on</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withLag(org.apache.storm.topology.base.BaseWindowedBolt.Duration)"> |
| <h3>withLag</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withLag</span><wbr><span class="parameters">(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</span></div> |
| <div class="block">Specify the maximum time lag of the tuple timestamp in milliseconds. It means that the tuple timestamps cannot be out of order by |
| more than this amount.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>duration</code> - the max lag duration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withWatermarkInterval(org.apache.storm.topology.base.BaseWindowedBolt.Duration)"> |
| <h3>withWatermarkInterval</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></span> <span class="element-name">withWatermarkInterval</span><wbr><span class="parameters">(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> interval)</span></div> |
| <div class="block">Specify the watermark event generation interval. For tuple based timestamps, watermark events are used to track the progress of time</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>interval</code> - the interval at which watermark events are generated</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)"> |
| <h3>prepare</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">prepare</span><wbr><span class="parameters">(<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><<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> topoConf, |
| <a href="../../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> context, |
| <a href="../../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a> collector)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../IWindowedBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)">IWindowedBolt</a></code></span></div> |
| <div class="block">This is similar to the <a href="../../task/IBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)"><code>IBolt.prepare(Map, TopologyContext, OutputCollector)</code></a> except that while emitting, |
| the tuples are automatically anchored to the tuples in the inputWindow.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../IWindowedBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)">prepare</a></code> in interface <code><a href="../IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cleanup()"> |
| <h3>cleanup</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">cleanup</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../IWindowedBolt.html#cleanup()">cleanup</a></code> in interface <code><a href="../IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)"> |
| <h3>declareOutputFields</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">declareOutputFields</span><wbr><span class="parameters">(<a href="../OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a> declarer)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../IComponent.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">IComponent</a></code></span></div> |
| <div class="block">Declare the output schema for all the streams of this topology.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../IComponent.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">declareOutputFields</a></code> in interface <code><a href="../IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code></dd> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getComponentConfiguration()"> |
| <h3>getComponentConfiguration</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/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">getComponentConfiguration</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../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="../TopologyBuilder.html" title="class in org.apache.storm.topology"><code>TopologyBuilder</code></a></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code> in interface <code><a href="../IComponent.html" title="interface in org.apache.storm.topology">IComponent</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> |