| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>WatermarkTimeEvictionPolicy (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="WatermarkTimeEvictionPolicy (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All 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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="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 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.api.windowing.evictors</a></div> |
| <h2 title="Class WatermarkTimeEvictionPolicy" class="title">Class WatermarkTimeEvictionPolicy<T extends java.io.Serializable></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="TimeEvictionPolicy.html" title="class in org.apache.heron.api.windowing.evictors">org.apache.heron.api.windowing.evictors.TimeEvictionPolicy</a><T></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.api.windowing.evictors.WatermarkTimeEvictionPolicy<T></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a><T,​<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">WatermarkTimeEvictionPolicy<T extends java.io.Serializable></span> |
| extends <a href="TimeEvictionPolicy.html" title="class in org.apache.heron.api.windowing.evictors">TimeEvictionPolicy</a><T></pre> |
| <div class="block">An eviction policy that evicts events based on time duration taking |
| watermark time and event lag into account.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.heron.api.windowing.EvictionPolicy"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.heron.api.windowing.<a href="../EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a></h3> |
| <code><a href="../EvictionPolicy.Action.html" title="enum in org.apache.heron.api.windowing">EvictionPolicy.Action</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.heron.api.windowing.evictors.TimeEvictionPolicy"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.heron.api.windowing.evictors.<a href="TimeEvictionPolicy.html" title="class in org.apache.heron.api.windowing.evictors">TimeEvictionPolicy</a></h3> |
| <code><a href="TimeEvictionPolicy.html#evictionContext">evictionContext</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(long)">WatermarkTimeEvictionPolicy</a></span>​(long windowLength)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a WatermarkTimeEvictionPolicy that evicts events older |
| than the given window length in millis.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(long,long)">WatermarkTimeEvictionPolicy</a></span>​(long windowLength, |
| long lag)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a WatermarkTimeEvictionPolicy that evicts events older |
| than the given window length in millis.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../EvictionPolicy.Action.html" title="enum in org.apache.heron.api.windowing">EvictionPolicy.Action</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#evict(org.apache.heron.api.windowing.Event)">evict</a></span>​(<a href="../Event.html" title="interface in org.apache.heron.api.windowing">Event</a><<a href="WatermarkTimeEvictionPolicy.html" title="type parameter in WatermarkTimeEvictionPolicy">T</a>> event)</code></th> |
| <td class="colLast"> |
| <div class="block">Decides if an event should be expired from the window, processed in the current |
| window or kept for later processing.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.api.windowing.evictors.TimeEvictionPolicy"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.heron.api.windowing.evictors.<a href="TimeEvictionPolicy.html" title="class in org.apache.heron.api.windowing.evictors">TimeEvictionPolicy</a></h3> |
| <code><a href="TimeEvictionPolicy.html#getContext()">getContext</a>, <a href="TimeEvictionPolicy.html#getState()">getState</a>, <a href="TimeEvictionPolicy.html#reset()">reset</a>, <a href="TimeEvictionPolicy.html#restoreState(org.apache.heron.api.windowing.EvictionContext)">restoreState</a>, <a href="TimeEvictionPolicy.html#setContext(org.apache.heron.api.windowing.EvictionContext)">setContext</a>, <a href="TimeEvictionPolicy.html#track(org.apache.heron.api.windowing.Event)">track</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WatermarkTimeEvictionPolicy</h4> |
| <pre>public WatermarkTimeEvictionPolicy​(long windowLength)</pre> |
| <div class="block">Constructs a WatermarkTimeEvictionPolicy that evicts events older |
| than the given window length in millis.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowLength</code> - the window length in milliseconds</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(long,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WatermarkTimeEvictionPolicy</h4> |
| <pre>public WatermarkTimeEvictionPolicy​(long windowLength, |
| long lag)</pre> |
| <div class="block">Constructs a WatermarkTimeEvictionPolicy that evicts events older |
| than the given window length in millis. The lag parameter |
| can be used in the case of event based ts to break the queue |
| scan early.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowLength</code> - the window length in milliseconds</dd> |
| <dd><code>lag</code> - the max event lag in milliseconds</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="evict(org.apache.heron.api.windowing.Event)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evict</h4> |
| <pre class="methodSignature">public <a href="../EvictionPolicy.Action.html" title="enum in org.apache.heron.api.windowing">EvictionPolicy.Action</a> evict​(<a href="../Event.html" title="interface in org.apache.heron.api.windowing">Event</a><<a href="WatermarkTimeEvictionPolicy.html" title="type parameter in WatermarkTimeEvictionPolicy">T</a>> event)</pre> |
| <div class="block">Decides if an event should be expired from the window, processed in the current |
| window or kept for later processing. |
| <p> |
| Keeps events with future ts in the queue for processing in the next |
| window. If the ts difference is more than the lag, stops scanning |
| the queue for the current window.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../EvictionPolicy.html#evict(org.apache.heron.api.windowing.Event)">evict</a></code> in interface <code><a href="../EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a><<a href="WatermarkTimeEvictionPolicy.html" title="type parameter in WatermarkTimeEvictionPolicy">T</a> extends java.io.Serializable,​<a href="../EvictionContext.html" title="interface in org.apache.heron.api.windowing">EvictionContext</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="TimeEvictionPolicy.html#evict(org.apache.heron.api.windowing.Event)">evict</a></code> in class <code><a href="TimeEvictionPolicy.html" title="class in org.apache.heron.api.windowing.evictors">TimeEvictionPolicy</a><<a href="WatermarkTimeEvictionPolicy.html" title="type parameter in WatermarkTimeEvictionPolicy">T</a> extends java.io.Serializable></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the input event</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../EvictionPolicy.Action.html" title="enum in org.apache.heron.api.windowing"><code>EvictionPolicy.Action</code></a> to be taken based on the input event</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="TimeEvictionPolicy.html#toString()">toString</a></code> in class <code><a href="TimeEvictionPolicy.html" title="class in org.apache.heron.api.windowing.evictors">TimeEvictionPolicy</a><<a href="WatermarkTimeEvictionPolicy.html" title="type parameter in WatermarkTimeEvictionPolicy">T</a> extends java.io.Serializable></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.html">All 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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
