| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>BaseStatefulWindowedBolt (Storm 2.4.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="BaseStatefulWindowedBolt (Storm 2.4.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":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"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BaseStatefulWindowedBolt.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/storm/topology/base/BaseStatefulBolt.html" title="class in org.apache.storm.topology.base"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/storm/topology/base/BaseTickTupleAwareRichBolt.html" title="class in org.apache.storm.topology.base"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" target="_top">Frames</a></li> |
| <li><a href="BaseStatefulWindowedBolt.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.apache.storm.topology.base.BaseWindowedBolt">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.storm.topology.base.BaseWindowedBolt">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.storm.topology.base</div> |
| <h2 title="Class BaseStatefulWindowedBolt" class="title">Class BaseStatefulWindowedBolt<T extends <a href="../../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a>></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseWindowedBolt</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.storm.topology.base.BaseStatefulWindowedBolt<T></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/storm/topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a>, <a href="../../../../../org/apache/storm/topology/IStatefulComponent.html" title="interface in org.apache.storm.topology">IStatefulComponent</a><T>, <a href="../../../../../org/apache/storm/topology/IStatefulWindowedBolt.html" title="interface in org.apache.storm.topology">IStatefulWindowedBolt</a><T>, <a href="../../../../../org/apache/storm/topology/IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">BaseStatefulWindowedBolt<T extends <a href="../../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a>></span> |
| extends <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a> |
| implements <a href="../../../../../org/apache/storm/topology/IStatefulWindowedBolt.html" title="interface in org.apache.storm.topology">IStatefulWindowedBolt</a><T></pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.storm.topology.base.BaseStatefulWindowedBolt">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.storm.topology.base.BaseWindowedBolt"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.storm.topology.base.<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></h3> |
| <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>, <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.storm.topology.base.BaseWindowedBolt"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.storm.topology.base.<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></h3> |
| <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#timestampExtractor">timestampExtractor</a>, <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#windowConfiguration">windowConfiguration</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#BaseStatefulWindowedBolt--">BaseStatefulWindowedBolt</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#isPersistent--">isPersistent</a></span>()</code> |
| <div class="block">If the stateful windowed bolt should have its windows persisted in state and maintain a subset of events in memory.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#maxEventsInMemory--">maxEventsInMemory</a></span>()</code> |
| <div class="block">The maximum number of window events to keep in memory.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#preCommit-long-">preCommit</a></span>(long txid)</code> |
| <div class="block">This is a hook for the component to perform some actions just before the framework commits its state.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#prePrepare-long-">prePrepare</a></span>(long txid)</code> |
| <div class="block">This is a hook for the component to perform some actions just before the framework prepares its state.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#preRollback--">preRollback</a></span>()</code> |
| <div class="block">This is a hook for the component to perform some actions just before the framework rolls back the prepared state.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withLag-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withLag</a></span>(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</code> |
| <div class="block">Specify the maximum time lag of the tuple timestamp in milliseconds.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withLateTupleStream-java.lang.String-">withLateTupleStream</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamName)</code> |
| <div class="block">Specify a stream id on which late tuples are going to be emitted.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withMaxEventsInMemory-long-">withMaxEventsInMemory</a></span>(long maxEventsInMemory)</code> |
| <div class="block">The maximum number of window events to keep in memory.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withMessageIdField-java.lang.String-">withMessageIdField</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName)</code> |
| <div class="block">Specify the name of the field in the tuple that holds the message id.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withPersistence--">withPersistence</a></span>()</code> |
| <div class="block">If set, the stateful windowed bolt would use the backend state for window persistence and only keep a sub-set of events in memory as specified by <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withMaxEventsInMemory-long-"><code>withMaxEventsInMemory(long)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withTimestampExtractor-org.apache.storm.windowing.TimestampExtractor-">withTimestampExtractor</a></span>(<a href="../../../../../org/apache/storm/windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a> timestampExtractor)</code> |
| <div class="block">Specify the timestamp extractor implementation.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withTimestampField-java.lang.String-">withTimestampField</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName)</code> |
| <div class="block">Specify a field in the tuple that represents the timestamp as a long value.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withTumblingWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withTumblingWindow</a></span>(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> count)</code> |
| <div class="block">A count based tumbling window.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withTumblingWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withTumblingWindow</a></span>(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</code> |
| <div class="block">A time duration based tumbling window.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withWatermarkInterval-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWatermarkInterval</a></span>(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> interval)</code> |
| <div class="block">Specify the watermark event generation interval.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withWindow</a></span>(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength)</code> |
| <div class="block">A tuple count based window that slides with every incoming tuple.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withWindow</a></span>(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</code> |
| <div class="block">Tuple count based sliding window configuration.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWindow</a></span>(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</code> |
| <div class="block">Tuple count and time duration based sliding window configuration.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWindow</a></span>(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength)</code> |
| <div class="block">A time duration based window that slides with every incoming tuple.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withWindow</a></span>(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</code> |
| <div class="block">Time duration and count based sliding window configuration.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWindow</a></span>(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</code> |
| <div class="block">Time duration based sliding window configuration.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.topology.base.BaseWindowedBolt"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.storm.topology.base.<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></h3> |
| <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#cleanup--">cleanup</a>, <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#declareOutputFields-org.apache.storm.topology.OutputFieldsDeclarer-">declareOutputFields</a>, <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#getComponentConfiguration--">getComponentConfiguration</a>, <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#getTimestampExtractor--">getTimestampExtractor</a>, <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#prepare-java.util.Map-org.apache.storm.task.TopologyContext-org.apache.storm.task.OutputCollector-">prepare</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.topology.IStatefulComponent"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.storm.topology.<a href="../../../../../org/apache/storm/topology/IStatefulComponent.html" title="interface in org.apache.storm.topology">IStatefulComponent</a></h3> |
| <code><a href="../../../../../org/apache/storm/topology/IStatefulComponent.html#initState-T-">initState</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.topology.IWindowedBolt"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.storm.topology.<a href="../../../../../org/apache/storm/topology/IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></h3> |
| <code><a href="../../../../../org/apache/storm/topology/IWindowedBolt.html#cleanup--">cleanup</a>, <a href="../../../../../org/apache/storm/topology/IWindowedBolt.html#execute-org.apache.storm.windowing.TupleWindow-">execute</a>, <a href="../../../../../org/apache/storm/topology/IWindowedBolt.html#getTimestampExtractor--">getTimestampExtractor</a>, <a href="../../../../../org/apache/storm/topology/IWindowedBolt.html#prepare-java.util.Map-org.apache.storm.task.TopologyContext-org.apache.storm.task.OutputCollector-">prepare</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.topology.IComponent"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.storm.topology.<a href="../../../../../org/apache/storm/topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></h3> |
| <code><a href="../../../../../org/apache/storm/topology/IComponent.html#declareOutputFields-org.apache.storm.topology.OutputFieldsDeclarer-">declareOutputFields</a>, <a href="../../../../../org/apache/storm/topology/IComponent.html#getComponentConfiguration--">getComponentConfiguration</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="BaseStatefulWindowedBolt--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BaseStatefulWindowedBolt</h4> |
| <pre>public BaseStatefulWindowedBolt()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-org.apache.storm.topology.base.BaseWindowedBolt.Count-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWindow</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withWindow(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</pre> |
| <div class="block"><p><p>Tuple count based sliding window configuration.</p></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withWindow</a></code> in class <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a name="withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-org.apache.storm.topology.base.BaseWindowedBolt.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWindow</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withWindow(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</pre> |
| <div class="block"><p><p>Tuple count and time duration based sliding window configuration.</p></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWindow</a></code> in class <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a name="withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-org.apache.storm.topology.base.BaseWindowedBolt.Count-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWindow</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withWindow(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</pre> |
| <div class="block"><p><p>Time duration and count based sliding window configuration.</p></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withWindow</a></code> in class <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a name="withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-org.apache.storm.topology.base.BaseWindowedBolt.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWindow</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withWindow(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> slidingInterval)</pre> |
| <div class="block"><p><p>Time duration based sliding window configuration.</p></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWindow</a></code> in class <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></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> |
| </li> |
| </ul> |
| <a name="withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWindow</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withWindow(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength)</pre> |
| <div class="block"><p><p>A tuple count based window that slides with every incoming tuple.</p></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withWindow</a></code> in class <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowLength</code> - the number of tuples in the window</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWindow</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withWindow(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength)</pre> |
| <div class="block"><p><p>A time duration based window that slides with every incoming tuple.</p></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWindow</a></code> in class <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowLength</code> - the time duration of the window</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withTumblingWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTumblingWindow</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withTumblingWindow(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> count)</pre> |
| <div class="block"><p><p>A count based tumbling window.</p></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withTumblingWindow-org.apache.storm.topology.base.BaseWindowedBolt.Count-">withTumblingWindow</a></code> in class <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>count</code> - the number of tuples after which the window tumbles</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withTumblingWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTumblingWindow</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withTumblingWindow(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</pre> |
| <div class="block"><p><p>A time duration based tumbling window.</p></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withTumblingWindow-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withTumblingWindow</a></code> in class <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>duration</code> - the time duration after which the window tumbles</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withTimestampField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTimestampField</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withTimestampField(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName)</pre> |
| <div class="block"><p><p>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/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> will be thrown. The field MUST contain a timestamp in milliseconds</p></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withTimestampField-java.lang.String-">withTimestampField</a></code> in class <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field that contains the timestamp</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withTimestampExtractor-org.apache.storm.windowing.TimestampExtractor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTimestampExtractor</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withTimestampExtractor(<a href="../../../../../org/apache/storm/windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a> timestampExtractor)</pre> |
| <div class="block"><p><p>Specify the timestamp extractor implementation.</p></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withTimestampExtractor-org.apache.storm.windowing.TimestampExtractor-">withTimestampExtractor</a></code> in class <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timestampExtractor</code> - the <a href="../../../../../org/apache/storm/windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing"><code>TimestampExtractor</code></a> implementation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withLateTupleStream-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withLateTupleStream</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withLateTupleStream(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamName)</pre> |
| <div class="block"><p><p>Specify a stream id on which late tuples are going to be emitted. They are going to be accessible via the <a href="../../../../../org/apache/storm/topology/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="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withTimestampField-java.lang.String-"><code>BaseWindowedBolt.withTimestampField(java.lang.String)</code></a>, otherwise <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> will be thrown.</p></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withLateTupleStream-java.lang.String-">withLateTupleStream</a></code> in class <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>streamName</code> - the name of the stream used to emit late tuples on</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withLag-org.apache.storm.topology.base.BaseWindowedBolt.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withLag</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withLag(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> duration)</pre> |
| <div class="block"><p><p>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.</p></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withLag-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withLag</a></code> in class <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>duration</code> - the max lag duration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withWatermarkInterval-org.apache.storm.topology.base.BaseWindowedBolt.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWatermarkInterval</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withWatermarkInterval(<a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> interval)</pre> |
| <div class="block"><p><p>Specify the watermark event generation interval. For tuple based timestamps, watermark events are used to track the progress of time</p></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html#withWatermarkInterval-org.apache.storm.topology.base.BaseWindowedBolt.Duration-">withWatermarkInterval</a></code> in class <code><a href="../../../../../org/apache/storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>interval</code> - the interval at which watermark events are generated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withMessageIdField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withMessageIdField</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withMessageIdField(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName)</pre> |
| <div class="block"><p>Specify the name of the field in the tuple that holds the message id. This is used to track the windowing boundaries and re-evaluating the windowing operation during recovery of IStatefulWindowedBolt</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field that contains the message id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withPersistence--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withPersistence</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withPersistence()</pre> |
| <div class="block"><p>If set, the stateful windowed bolt would use the backend state for window persistence and only keep a sub-set of events in memory as specified by <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withMaxEventsInMemory-long-"><code>withMaxEventsInMemory(long)</code></a>.</p></div> |
| </li> |
| </ul> |
| <a name="withMaxEventsInMemory-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withMaxEventsInMemory</h4> |
| <pre>public <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a>> withMaxEventsInMemory(long maxEventsInMemory)</pre> |
| <div class="block"><p>The maximum number of window events to keep in memory. This is meaningful only if <a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html#withPersistence--"><code>withPersistence()</code></a> is also set. As the number of events in memory grows close to the maximum, the events that are less likely to be used again are evicted and persisted. The default value for this is <code>1,000,000</code>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxEventsInMemory</code> - the maximum number of window events to keep in memory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isPersistent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPersistent</h4> |
| <pre>public boolean isPersistent()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/topology/IStatefulWindowedBolt.html#isPersistent--">IStatefulWindowedBolt</a></code></span></div> |
| <div class="block"><p>If the stateful windowed bolt should have its windows persisted in state and maintain a subset of events in memory. <p> The default is to keep all the window events in memory. </p></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/IStatefulWindowedBolt.html#isPersistent--">isPersistent</a></code> in interface <code><a href="../../../../../org/apache/storm/topology/IStatefulWindowedBolt.html" title="interface in org.apache.storm.topology">IStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a> extends <a href="../../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the windows should be persisted</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="maxEventsInMemory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>maxEventsInMemory</h4> |
| <pre>public long maxEventsInMemory()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/topology/IStatefulWindowedBolt.html#maxEventsInMemory--">IStatefulWindowedBolt</a></code></span></div> |
| <div class="block"><p>The maximum number of window events to keep in memory.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/IStatefulWindowedBolt.html#maxEventsInMemory--">maxEventsInMemory</a></code> in interface <code><a href="../../../../../org/apache/storm/topology/IStatefulWindowedBolt.html" title="interface in org.apache.storm.topology">IStatefulWindowedBolt</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a> extends <a href="../../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="preCommit-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>preCommit</h4> |
| <pre>public void preCommit(long txid)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/topology/IStatefulComponent.html#preCommit-long-">IStatefulComponent</a></code></span></div> |
| <div class="block"><p>This is a hook for the component to perform some actions just before the framework commits its state.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/IStatefulComponent.html#preCommit-long-">preCommit</a></code> in interface <code><a href="../../../../../org/apache/storm/topology/IStatefulComponent.html" title="interface in org.apache.storm.topology">IStatefulComponent</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a> extends <a href="../../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prePrepare-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prePrepare</h4> |
| <pre>public void prePrepare(long txid)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/topology/IStatefulComponent.html#prePrepare-long-">IStatefulComponent</a></code></span></div> |
| <div class="block"><p>This is a hook for the component to perform some actions just before the framework prepares its state.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/IStatefulComponent.html#prePrepare-long-">prePrepare</a></code> in interface <code><a href="../../../../../org/apache/storm/topology/IStatefulComponent.html" title="interface in org.apache.storm.topology">IStatefulComponent</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a> extends <a href="../../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="preRollback--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>preRollback</h4> |
| <pre>public void preRollback()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/topology/IStatefulComponent.html#preRollback--">IStatefulComponent</a></code></span></div> |
| <div class="block"><p>This is a hook for the component to perform some actions just before the framework rolls back the prepared state.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/topology/IStatefulComponent.html#preRollback--">preRollback</a></code> in interface <code><a href="../../../../../org/apache/storm/topology/IStatefulComponent.html" title="interface in org.apache.storm.topology">IStatefulComponent</a><<a href="../../../../../org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" title="type parameter in BaseStatefulWindowedBolt">T</a> extends <a href="../../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BaseStatefulWindowedBolt.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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><script type="text/javascript" src="../../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/storm/topology/base/BaseStatefulBolt.html" title="class in org.apache.storm.topology.base"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/storm/topology/base/BaseTickTupleAwareRichBolt.html" title="class in org.apache.storm.topology.base"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/topology/base/BaseStatefulWindowedBolt.html" target="_top">Frames</a></li> |
| <li><a href="BaseStatefulWindowedBolt.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.apache.storm.topology.base.BaseWindowedBolt">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.storm.topology.base.BaseWindowedBolt">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
