| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>WindowConfig (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-03-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="WindowConfig (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":1,"i2":6,"i3":1,"i4":1,"i5":1,"i6":1}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.heron.streamlet</a></div> |
| <h2 title="Interface WindowConfig" class="title">Interface WindowConfig</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/windowings/CountWindowConfig.html" title="class in org.apache.heron.streamlet.impl.windowings">CountWindowConfig</a></code>, <code><a href="impl/windowings/CustomWindowConfig.html" title="class in org.apache.heron.streamlet.impl.windowings">CustomWindowConfig</a></code>, <code><a href="impl/windowings/TimeWindowConfig.html" title="class in org.apache.heron.streamlet.impl.windowings">TimeWindowConfig</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">WindowConfig</span></pre> |
| <div class="block">WindowConfig allows Streamlet API users to program window configuration for operations |
| that rely on windowing. Currently we only support time/count based |
| sliding/tumbling windows.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyTo(org.apache.heron.api.bolt.BaseWindowedBolt)">applyTo</a></span>​(<a href="../api/bolt/BaseWindowedBolt.html" title="class in org.apache.heron.api.bolt">BaseWindowedBolt</a> bolt)</code></th> |
| <td class="colLast"> |
| <div class="block">Apply this WindowConfig object to a bolt object</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="WindowConfig.html" title="interface in org.apache.heron.streamlet">WindowConfig</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CustomWindow(org.apache.heron.api.windowing.TriggerPolicy,org.apache.heron.api.windowing.EvictionPolicy)">CustomWindow</a></span>​(<a href="../api/windowing/TriggerPolicy.html" title="interface in org.apache.heron.api.windowing">TriggerPolicy</a><<a href="../api/tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>,​?> triggerPolicy, |
| <a href="../api/windowing/EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a><<a href="../api/tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>,​?> evictionPolicy)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a window based on the provided custom trigger and eviction policies</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#Dummy()">Dummy</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This is just a dummy function to avoid WindowConfig objects to be matched with Java functional interface |
| and cause ambiguous reference compiling error.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="WindowConfig.html" title="interface in org.apache.heron.streamlet">WindowConfig</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SlidingCountWindow(int,int)">SlidingCountWindow</a></span>​(int windowSize, |
| int slideSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a count based sliding window with windowSize as the window countsize |
| and slideSize as slide size</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="WindowConfig.html" title="interface in org.apache.heron.streamlet">WindowConfig</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SlidingTimeWindow(java.time.Duration,java.time.Duration)">SlidingTimeWindow</a></span>​(java.time.Duration windowDuration, |
| java.time.Duration slideInterval)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a time based sliding window with windowDuration as the window duration |
| and slideInterval as slideInterval</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="WindowConfig.html" title="interface in org.apache.heron.streamlet">WindowConfig</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TumblingCountWindow(int)">TumblingCountWindow</a></span>​(int windowSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a count based tumbling window of size windowSize</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <a href="WindowConfig.html" title="interface in org.apache.heron.streamlet">WindowConfig</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TumblingTimeWindow(java.time.Duration)">TumblingTimeWindow</a></span>​(java.time.Duration windowDuration)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a time based tumbling window of windowDuration</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="applyTo(org.apache.heron.api.bolt.BaseWindowedBolt)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyTo</h4> |
| <pre class="methodSignature">void applyTo​(<a href="../api/bolt/BaseWindowedBolt.html" title="class in org.apache.heron.api.bolt">BaseWindowedBolt</a> bolt)</pre> |
| <div class="block">Apply this WindowConfig object to a bolt object</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bolt</code> - the target bolt object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="Dummy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Dummy</h4> |
| <pre class="methodSignature">void Dummy()</pre> |
| <div class="block">This is just a dummy function to avoid WindowConfig objects to be matched with Java functional interface |
| and cause ambiguous reference compiling error. In case new virtual functions are needed in WindowConfig, |
| this dummy function can be safely removed.</div> |
| </li> |
| </ul> |
| <a id="TumblingTimeWindow(java.time.Duration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TumblingTimeWindow</h4> |
| <pre class="methodSignature">static <a href="WindowConfig.html" title="interface in org.apache.heron.streamlet">WindowConfig</a> TumblingTimeWindow​(java.time.Duration windowDuration)</pre> |
| <div class="block">Creates a time based tumbling window of windowDuration</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowDuration</code> - the duration of the tumbling window</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>WindowConfig that can be passed to the transformation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="SlidingTimeWindow(java.time.Duration,java.time.Duration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SlidingTimeWindow</h4> |
| <pre class="methodSignature">static <a href="WindowConfig.html" title="interface in org.apache.heron.streamlet">WindowConfig</a> SlidingTimeWindow​(java.time.Duration windowDuration, |
| java.time.Duration slideInterval)</pre> |
| <div class="block">Creates a time based sliding window with windowDuration as the window duration |
| and slideInterval as slideInterval</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowDuration</code> - The Sliding Window duration</dd> |
| <dd><code>slideInterval</code> - The sliding duration</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>WindowConfig that can be passed to the transformation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="TumblingCountWindow(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TumblingCountWindow</h4> |
| <pre class="methodSignature">static <a href="WindowConfig.html" title="interface in org.apache.heron.streamlet">WindowConfig</a> TumblingCountWindow​(int windowSize)</pre> |
| <div class="block">Creates a count based tumbling window of size windowSize</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowSize</code> - the size of the tumbling window</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>WindowConfig that can be passed to the transformation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="SlidingCountWindow(int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SlidingCountWindow</h4> |
| <pre class="methodSignature">static <a href="WindowConfig.html" title="interface in org.apache.heron.streamlet">WindowConfig</a> SlidingCountWindow​(int windowSize, |
| int slideSize)</pre> |
| <div class="block">Creates a count based sliding window with windowSize as the window countsize |
| and slideSize as slide size</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowSize</code> - The Window Count Size</dd> |
| <dd><code>slideSize</code> - The slide size</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>WindowConfig that can be passed to the transformation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="CustomWindow(org.apache.heron.api.windowing.TriggerPolicy,org.apache.heron.api.windowing.EvictionPolicy)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CustomWindow</h4> |
| <pre class="methodSignature">static <a href="WindowConfig.html" title="interface in org.apache.heron.streamlet">WindowConfig</a> CustomWindow​(<a href="../api/windowing/TriggerPolicy.html" title="interface in org.apache.heron.api.windowing">TriggerPolicy</a><<a href="../api/tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>,​?> triggerPolicy, |
| <a href="../api/windowing/EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a><<a href="../api/tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>,​?> evictionPolicy)</pre> |
| <div class="block">Creates a window based on the provided custom trigger and eviction policies</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>triggerPolicy</code> - The trigger policy to use</dd> |
| <dd><code>evictionPolicy</code> - The eviction policy to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>WindowConfig that can be passed to the transformation</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
