| <!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 (1.8.0_161-google-v7) on Thu Oct 18 16:14:30 PDT 2018 --> |
| <title>WatermarkManager (Apache Beam 2.8.0-SNAPSHOT)</title> |
| <meta name="date" content="2018-10-18"> |
| <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="WatermarkManager (Apache Beam 2.8.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="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/beam/runners/direct/TransformExecutor.html" title="interface in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.FiredTimers.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/runners/direct/WatermarkManager.html" target="_top">Frames</a></li> |
| <li><a href="WatermarkManager.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.class.summary">Nested</a> | </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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.runners.direct</div> |
| <h2 title="Class WatermarkManager" class="title">Class WatermarkManager<ExecutableT,CollectionT></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.runners.direct.WatermarkManager<ExecutableT,CollectionT></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a> |
| public class <span class="typeNameLabel">WatermarkManager<ExecutableT,CollectionT></span> |
| extends java.lang.Object</pre> |
| <div class="block">Manages watermarks of <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> and input and output watermarks of <code>AppliedPTransforms</code> to provide event-time and completion tracking for in-memory |
| execution. <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager</code></a> is designed to update and return a consistent view of |
| watermarks in the presence of concurrent updates. |
| |
| <p>An <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager</code></a> is provided with the collection of root <code>AppliedPTransforms</code> and a map of <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> to all the <code>AppliedPTransforms</code> that consume them at construction time. |
| |
| <p>Whenever a root <code>executable</code> produces elements, the <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager</code></a> is provided with the produced elements and the output watermark of the |
| producing <code>executable</code>. The <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>watermark manager</code></a> is |
| responsible for computing the watermarks of all <code>transforms</code> that consume |
| one or more <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a>. |
| |
| <p>Whenever a non-root <code>AppliedPTransform</code> finishes processing one or more in-flight |
| elements (referred to as the input <code>bundle</code>), the following occurs |
| atomically: |
| |
| <ul> |
| <li>All of the in-flight elements are removed from the collection of pending elements for the |
| <code>AppliedPTransform</code>. |
| <li>All of the elements produced by the <code>AppliedPTransform</code> are added to the collection |
| of pending elements for each <code>AppliedPTransform</code> that consumes them. |
| <li>The input watermark for the <code>AppliedPTransform</code> becomes the maximum value of |
| <ul> |
| <li>the previous input watermark |
| <li>the minimum of |
| <ul> |
| <li>the timestamps of all currently pending elements |
| <li>all input <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> watermarks |
| </ul> |
| </ul> |
| <li>The output watermark for the <code>AppliedPTransform</code> becomes the maximum of |
| <ul> |
| <li>the previous output watermark |
| <li>the minimum of |
| <ul> |
| <li>the current input watermark |
| <li>the current watermark holds |
| </ul> |
| </ul> |
| <li>The watermark of the output <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> can be advanced to the output watermark of |
| the <code>AppliedPTransform</code> |
| <li>The watermark of all downstream <code>AppliedPTransforms</code> can be |
| advanced. |
| </ul> |
| |
| <p>The watermark of a <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> is equal to the output watermark of the <code>AppliedPTransform</code> that produces it. |
| |
| <p>The watermarks for a <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> are updated as follows when output is committed: |
| |
| <pre> |
| Watermark_In' = MAX(Watermark_In, MIN(U(TS_Pending), U(Watermark_InputPCollection))) |
| Watermark_Out' = MAX(Watermark_Out, MIN(Watermark_In', U(StateHold))) |
| Watermark_PCollection = Watermark_Out_ProducingPTransform |
| </pre></div> |
| </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> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.FiredTimers.html" title="class in org.apache.beam.runners.direct">WatermarkManager.FiredTimers</a><<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.FiredTimers.html" title="type parameter in WatermarkManager.FiredTimers">ExecutableT</a>></span></code> |
| <div class="block">A pair of <code>TimerInternals.TimerData</code> and key which can be delivered to the appropriate <code>AppliedPTransform</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TimerUpdate</a></span></code> |
| <div class="block">A collection of newly set, deleted, and completed timers.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TransformWatermarks.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TransformWatermarks</a></span></code> |
| <div class="block">A reference to the input and output watermarks of an <code>AppliedPTransform</code>.</div> |
| </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="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="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>static <ExecutableT,CollectionT><br><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="class in org.apache.beam.runners.direct">WatermarkManager</a><ExecutableT,? super CollectionT></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html#create-org.apache.beam.runners.direct.Clock-org.apache.beam.runners.direct.ExecutableGraph-java.util.function.Function-">create</a></span>(<a href="../../../../../org/apache/beam/runners/direct/Clock.html" title="interface in org.apache.beam.runners.direct">Clock</a> clock, |
| <a href="../../../../../org/apache/beam/runners/direct/ExecutableGraph.html" title="interface in org.apache.beam.runners.direct">ExecutableGraph</a><ExecutableT,? super CollectionT> graph, |
| java.util.function.Function<ExecutableT,java.lang.String> getName)</code> |
| <div class="block">Creates a new <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.Collection<<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.FiredTimers.html" title="class in org.apache.beam.runners.direct">WatermarkManager.FiredTimers</a><<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">ExecutableT</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html#extractFiredTimers--">extractFiredTimers</a></span>()</code> |
| <div class="block">Returns a map of each <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that has pending timers to those timers.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TransformWatermarks.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TransformWatermarks</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html#getWatermarks-ExecutableT-">getWatermarks</a></span>(<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">ExecutableT</a> executable)</code> |
| <div class="block">Gets the input and output watermarks for an <code>AppliedPTransform</code>.</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/beam/runners/direct/WatermarkManager.html#initialize-java.util.Map-">initialize</a></span>(java.util.Map<<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">ExecutableT</a>,? extends java.lang.Iterable<<a href="../../../../../org/apache/beam/runners/local/Bundle.html" title="interface in org.apache.beam.runners.local">Bundle</a><?,<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">CollectionT</a>>>> initialBundles)</code> </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/beam/runners/direct/WatermarkManager.html#refreshAll--">refreshAll</a></span>()</code> |
| <div class="block">Refresh the watermarks contained within this <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager</code></a>, causing all watermarks |
| to be advanced as far as possible.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html#updateWatermarks-org.apache.beam.runners.local.Bundle-org.apache.beam.runners.direct.WatermarkManager.TimerUpdate-ExecutableT-org.apache.beam.runners.local.Bundle-java.lang.Iterable-org.joda.time.Instant-">updateWatermarks</a></span>(<a href="../../../../../org/apache/beam/runners/local/Bundle.html" title="interface in org.apache.beam.runners.local">Bundle</a><?,? extends <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">CollectionT</a>> completed, |
| <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TimerUpdate</a> timerUpdate, |
| <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">ExecutableT</a> executable, |
| <a href="../../../../../org/apache/beam/runners/local/Bundle.html" title="interface in org.apache.beam.runners.local">Bundle</a><?,? extends <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">CollectionT</a>> unprocessedInputs, |
| java.lang.Iterable<? extends <a href="../../../../../org/apache/beam/runners/local/Bundle.html" title="interface in org.apache.beam.runners.local">Bundle</a><?,? extends <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">CollectionT</a>>> outputs, |
| <a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a> earliestHold)</code> |
| <div class="block">Updates the watermarks of a executable with one or more inputs.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="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, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="create-org.apache.beam.runners.direct.Clock-org.apache.beam.runners.direct.ExecutableGraph-java.util.function.Function-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public static <ExecutableT,CollectionT> <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="class in org.apache.beam.runners.direct">WatermarkManager</a><ExecutableT,? super CollectionT> create(<a href="../../../../../org/apache/beam/runners/direct/Clock.html" title="interface in org.apache.beam.runners.direct">Clock</a> clock, |
| <a href="../../../../../org/apache/beam/runners/direct/ExecutableGraph.html" title="interface in org.apache.beam.runners.direct">ExecutableGraph</a><ExecutableT,? super CollectionT> graph, |
| java.util.function.Function<ExecutableT,java.lang.String> getName)</pre> |
| <div class="block">Creates a new <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager</code></a>. All watermarks within the newly created <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager</code></a> start at <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html#TIMESTAMP_MIN_VALUE"><code>BoundedWindow.TIMESTAMP_MIN_VALUE</code></a>, the minimum watermark, |
| with no watermark holds or pending elements.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clock</code> - the clock to use to determine processing time</dd> |
| <dd><code>graph</code> - the graph representing this pipeline</dd> |
| <dd><code>getName</code> - a function for producing a short identifier for the executable in watermark |
| tracing log messages.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWatermarks-java.lang.Object-"> |
| <!-- --> |
| </a><a name="getWatermarks-ExecutableT-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWatermarks</h4> |
| <pre>public <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TransformWatermarks.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TransformWatermarks</a> getWatermarks(<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">ExecutableT</a> executable)</pre> |
| <div class="block">Gets the input and output watermarks for an <code>AppliedPTransform</code>. If the <code>PTransform</code> has not processed any elements, return a watermark of <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html#TIMESTAMP_MIN_VALUE"><code>BoundedWindow.TIMESTAMP_MIN_VALUE</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a snapshot of the input watermark and output watermark for the provided executable</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initialize-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>public void initialize(java.util.Map<<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">ExecutableT</a>,? extends java.lang.Iterable<<a href="../../../../../org/apache/beam/runners/local/Bundle.html" title="interface in org.apache.beam.runners.local">Bundle</a><?,<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">CollectionT</a>>>> initialBundles)</pre> |
| </li> |
| </ul> |
| <a name="updateWatermarks-org.apache.beam.runners.local.Bundle-org.apache.beam.runners.direct.WatermarkManager.TimerUpdate-java.lang.Object-org.apache.beam.runners.local.Bundle-java.lang.Iterable-org.joda.time.Instant-"> |
| <!-- --> |
| </a><a name="updateWatermarks-org.apache.beam.runners.local.Bundle-org.apache.beam.runners.direct.WatermarkManager.TimerUpdate-ExecutableT-org.apache.beam.runners.local.Bundle-java.lang.Iterable-org.joda.time.Instant-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateWatermarks</h4> |
| <pre>public void updateWatermarks(@Nullable |
| <a href="../../../../../org/apache/beam/runners/local/Bundle.html" title="interface in org.apache.beam.runners.local">Bundle</a><?,? extends <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">CollectionT</a>> completed, |
| <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TimerUpdate</a> timerUpdate, |
| <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">ExecutableT</a> executable, |
| @Nullable |
| <a href="../../../../../org/apache/beam/runners/local/Bundle.html" title="interface in org.apache.beam.runners.local">Bundle</a><?,? extends <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">CollectionT</a>> unprocessedInputs, |
| java.lang.Iterable<? extends <a href="../../../../../org/apache/beam/runners/local/Bundle.html" title="interface in org.apache.beam.runners.local">Bundle</a><?,? extends <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">CollectionT</a>>> outputs, |
| <a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a> earliestHold)</pre> |
| <div class="block">Updates the watermarks of a executable with one or more inputs. |
| |
| <p>Each executable has two monotonically increasing watermarks: the input watermark, which can, |
| at any time, be updated to equal: |
| |
| <pre> |
| MAX(CurrentInputWatermark, MIN(PendingElements, InputPCollectionWatermarks)) |
| </pre> |
| |
| and the output watermark, which can, at any time, be updated to equal: |
| |
| <pre> |
| MAX(CurrentOutputWatermark, MIN(InputWatermark, WatermarkHolds)) |
| </pre> |
| |
| . |
| |
| <p>Updates to watermarks may not be immediately visible.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>completed</code> - the input that has completed</dd> |
| <dd><code>timerUpdate</code> - the timers that were added, removed, and completed as part of producing this |
| update</dd> |
| <dd><code>executable</code> - the executable applied to <code>completed</code> to produce the outputs</dd> |
| <dd><code>unprocessedInputs</code> - inputs that could not be processed</dd> |
| <dd><code>outputs</code> - outputs that were produced by the application of the <code>executable</code> to the |
| input</dd> |
| <dd><code>earliestHold</code> - the earliest watermark hold in the executable's state.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="refreshAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refreshAll</h4> |
| <pre>public void refreshAll()</pre> |
| <div class="block">Refresh the watermarks contained within this <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager</code></a>, causing all watermarks |
| to be advanced as far as possible.</div> |
| </li> |
| </ul> |
| <a name="extractFiredTimers--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>extractFiredTimers</h4> |
| <pre>public java.util.Collection<<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.FiredTimers.html" title="class in org.apache.beam.runners.direct">WatermarkManager.FiredTimers</a><<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">ExecutableT</a>>> extractFiredTimers()</pre> |
| <div class="block">Returns a map of each <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that has pending timers to those timers. All of the |
| pending timers will be removed from this <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager</code></a>.</div> |
| </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="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/beam/runners/direct/TransformExecutor.html" title="interface in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.FiredTimers.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/runners/direct/WatermarkManager.html" target="_top">Frames</a></li> |
| <li><a href="WatermarkManager.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.class.summary">Nested</a> | </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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |