| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SlidingWindows (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.streams.windowing, class: SlidingWindows"> |
| <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/SlidingWindows.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.streams.windowing</a></div> |
| <h1 title="Class SlidingWindows" class="title">Class SlidingWindows<L,<wbr>I></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"><a href="BaseWindow.html" title="class in org.apache.storm.streams.windowing">org.apache.storm.streams.windowing.BaseWindow</a><L,<wbr>I> |
| <div class="inheritance">org.apache.storm.streams.windowing.SlidingWindows<L,<wbr>I></div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>L</code> - The type of the window length (e.g. Duration or Count)</dd> |
| <dd><code>I</code> - The type of the sliding interval (e.g. Duration or Count)</dd> |
| </dl> |
| <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="Window.html" title="interface in org.apache.storm.streams.windowing">Window</a><L,<wbr>I></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SlidingWindows<L,<wbr>I></span> |
| <span class="extends-implements">extends <a href="BaseWindow.html" title="class in org.apache.storm.streams.windowing">BaseWindow</a><L,<wbr>I></span></div> |
| <div class="block">A sliding window specification based on a window length and sliding interval.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../serialized-form.html#org.apache.storm.streams.windowing.SlidingWindows">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.storm.streams.windowing.BaseWindow">Fields inherited from class org.apache.storm.streams.windowing.<a href="BaseWindow.html" title="class in org.apache.storm.streams.windowing">BaseWindow</a></h3> |
| <code><a href="BaseWindow.html#lag">lag</a>, <a href="BaseWindow.html#lateTupleStream">lateTupleStream</a>, <a href="BaseWindow.html#timestampField">timestampField</a></code></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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</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> o)</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><a href="SlidingWindows.html" title="type parameter in SlidingWindows">I</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSlidingInterval()" class="member-name-link">getSlidingInterval</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The sliding interval of the window.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SlidingWindows.html" title="type parameter in SlidingWindows">L</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWindowLength()" class="member-name-link">getWindowLength</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The length of the window.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SlidingWindows.html" title="class in org.apache.storm.streams.windowing">SlidingWindows</a><<a href="../../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>,<wbr><a href="../../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#of(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Count)" class="member-name-link">of</a><wbr>(<a href="../../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../../topology/base/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-tab1 method-summary-table-tab4"> |
| <div class="block">Count based sliding window configuration.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SlidingWindows.html" title="class in org.apache.storm.streams.windowing">SlidingWindows</a><<a href="../../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>,<wbr><a href="../../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#of(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">of</a><wbr>(<a href="../../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../../topology/base/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-tab1 method-summary-table-tab4"> |
| <div class="block">Tuple count and time duration based sliding window configuration.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SlidingWindows.html" title="class in org.apache.storm.streams.windowing">SlidingWindows</a><<a href="../../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>,<wbr><a href="../../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#of(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Count)" class="member-name-link">of</a><wbr>(<a href="../../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../../topology/base/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-tab1 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-tab1 method-summary-table-tab4"><code>static <a href="SlidingWindows.html" title="class in org.apache.storm.streams.windowing">SlidingWindows</a><<a href="../../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>,<wbr><a href="../../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#of(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Duration)" class="member-name-link">of</a><wbr>(<a href="../../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../../topology/base/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-tab1 method-summary-table-tab4"> |
| <div class="block">Time duration 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="SlidingWindows.html" title="class in org.apache.storm.streams.windowing">SlidingWindows</a><<a href="SlidingWindows.html" title="type parameter in SlidingWindows">L</a>,<wbr><a href="SlidingWindows.html" title="type parameter in SlidingWindows">I</a>></code></div> |
| <div class="col-second even-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="../../topology/base/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">Specify the maximum time lag of the tuple timestamp in milliseconds.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SlidingWindows.html" title="class in org.apache.storm.streams.windowing">SlidingWindows</a><<a href="SlidingWindows.html" title="type parameter in SlidingWindows">L</a>,<wbr><a href="SlidingWindows.html" title="type parameter in SlidingWindows">I</a>></code></div> |
| <div class="col-second odd-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 odd-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SlidingWindows.html" title="class in org.apache.storm.streams.windowing">SlidingWindows</a><<a href="SlidingWindows.html" title="type parameter in SlidingWindows">L</a>,<wbr><a href="SlidingWindows.html" title="type parameter in SlidingWindows">I</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">The name of the field in the tuple that contains the timestamp when the event occurred as a long value.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.streams.windowing.BaseWindow">Methods inherited from class org.apache.storm.streams.windowing.<a href="BaseWindow.html" title="class in org.apache.storm.streams.windowing">BaseWindow</a></h3> |
| <code><a href="BaseWindow.html#getLag()">getLag</a>, <a href="BaseWindow.html#getLateTupleStream()">getLateTupleStream</a>, <a href="BaseWindow.html#getTimestampField()">getTimestampField</a></code></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#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#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="of(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Count)"> |
| <h3>of</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SlidingWindows.html" title="class in org.apache.storm.streams.windowing">SlidingWindows</a><<a href="../../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>,<wbr><a href="../../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>></span> <span class="element-name">of</span><wbr><span class="parameters">(<a href="../../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> slidingInterval)</span></div> |
| <div class="block">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="of(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Duration)"> |
| <h3>of</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SlidingWindows.html" title="class in org.apache.storm.streams.windowing">SlidingWindows</a><<a href="../../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>,<wbr><a href="../../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>></span> <span class="element-name">of</span><wbr><span class="parameters">(<a href="../../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../../topology/base/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="of(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration)"> |
| <h3>of</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SlidingWindows.html" title="class in org.apache.storm.streams.windowing">SlidingWindows</a><<a href="../../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>,<wbr><a href="../../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>></span> <span class="element-name">of</span><wbr><span class="parameters">(<a href="../../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a> windowLength, |
| <a href="../../topology/base/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="of(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Count)"> |
| <h3>of</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SlidingWindows.html" title="class in org.apache.storm.streams.windowing">SlidingWindows</a><<a href="../../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>,<wbr><a href="../../topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>></span> <span class="element-name">of</span><wbr><span class="parameters">(<a href="../../topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a> windowLength, |
| <a href="../../topology/base/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="getWindowLength()"> |
| <h3>getWindowLength</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SlidingWindows.html" title="type parameter in SlidingWindows">L</a></span> <span class="element-name">getWindowLength</span>()</div> |
| <div class="block">The length of the window.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the window length</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSlidingInterval()"> |
| <h3>getSlidingInterval</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SlidingWindows.html" title="type parameter in SlidingWindows">I</a></span> <span class="element-name">getSlidingInterval</span>()</div> |
| <div class="block">The sliding interval of the window.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the sliding interval</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="SlidingWindows.html" title="class in org.apache.storm.streams.windowing">SlidingWindows</a><<a href="SlidingWindows.html" title="type parameter in SlidingWindows">L</a>,<wbr><a href="SlidingWindows.html" title="type parameter in SlidingWindows">I</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">The name of the field in the tuple that contains the timestamp when the event occurred as a long value. This is used of event-time |
| based processing. If this config is set and the 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.</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="withLateTupleStream(java.lang.String)"> |
| <h3>withLateTupleStream</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SlidingWindows.html" title="class in org.apache.storm.streams.windowing">SlidingWindows</a><<a href="SlidingWindows.html" title="type parameter in SlidingWindows">L</a>,<wbr><a href="SlidingWindows.html" title="type parameter in SlidingWindows">I</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="../../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="../../topology/base/BaseWindowedBolt.html#withTimestampField(java.lang.String)"><code>BaseWindowedBolt.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="SlidingWindows.html" title="class in org.apache.storm.streams.windowing">SlidingWindows</a><<a href="SlidingWindows.html" title="type parameter in SlidingWindows">L</a>,<wbr><a href="SlidingWindows.html" title="type parameter in SlidingWindows">I</a>></span> <span class="element-name">withLag</span><wbr><span class="parameters">(<a href="../../topology/base/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="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<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> o)</span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="BaseWindow.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="BaseWindow.html" title="class in org.apache.storm.streams.windowing">BaseWindow</a><<a href="SlidingWindows.html" title="type parameter in SlidingWindows">L</a>,<wbr><a href="SlidingWindows.html" title="type parameter in SlidingWindows">I</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="BaseWindow.html#hashCode()">hashCode</a></code> in class <code><a href="BaseWindow.html" title="class in org.apache.storm.streams.windowing">BaseWindow</a><<a href="SlidingWindows.html" title="type parameter in SlidingWindows">L</a>,<wbr><a href="SlidingWindows.html" title="type parameter in SlidingWindows">I</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> |
