blob: 391f4f8b94f6d35a06850c7efb816aa5d05f318e [file] [log] [blame]
<!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_181-google-v7) on Mon Jan 27 16:42:28 PST 2020 -->
<title>WatermarkManager.TimerUpdate (Apache Beam 2.20.0-SNAPSHOT)</title>
<meta name="date" content="2020-01-27">
<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.TimerUpdate (Apache Beam 2.20.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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/WatermarkManager.FiredTimers.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.TimerUpdateBuilder.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" target="_top">Frames</a></li>
<li><a href="WatermarkManager.TimerUpdate.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.TimerUpdate" class="title">Class WatermarkManager.TimerUpdate</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.runners.direct.WatermarkManager.TimerUpdate</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="class in org.apache.beam.runners.direct">WatermarkManager</a>&lt;<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">ExecutableT</a>,<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="type parameter in WatermarkManager">CollectionT</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public static class <span class="typeNameLabel">WatermarkManager.TimerUpdate</span>
extends java.lang.Object</pre>
<div class="block">A collection of newly set, deleted, and completed timers.
<p>setTimers and deletedTimers are collections of <code>TimerInternals.TimerData</code> that have been added to the
<code>TimerInternals</code> of an executed step. completedTimers are timers that were delivered as
the input to the executed step. pushedBackTimers are timers that were in completedTimers at the
input, but were pushed back due to processing constraints.</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">&nbsp;</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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.TimerUpdateBuilder.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TimerUpdate.TimerUpdateBuilder</a></span></code>
<div class="block">A <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager.TimerUpdate</code></a> builder that needs to be provided with set timers and deleted timers.</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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 <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.TimerUpdateBuilder.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TimerUpdate.TimerUpdateBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html#builder-org.apache.beam.runners.local.StructuralKey-">builder</a></span>(<a href="../../../../../org/apache/beam/runners/local/StructuralKey.html" title="class in org.apache.beam.runners.local">StructuralKey</a>&lt;?&gt;&nbsp;key)</code>
<div class="block">Creates a new <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager.TimerUpdate</code></a> builder with the provided completed timers that needs the
set and deleted timers to be added to it.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TimerUpdate</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html#empty--">empty</a></span>()</code>
<div class="block">Returns a TimerUpdate for a null key with no timers.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;other)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.Iterable&lt;? extends org.apache.beam.runners.core.TimerInternals.TimerData&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html#getCompletedTimers--">getCompletedTimers</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Iterable&lt;? extends org.apache.beam.runners.core.TimerInternals.TimerData&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html#getDeletedTimers--">getDeletedTimers</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Iterable&lt;? extends org.apache.beam.runners.core.TimerInternals.TimerData&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html#getSetTimers--">getSetTimers</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TimerUpdate</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html#withCompletedTimers-java.lang.Iterable-">withCompletedTimers</a></span>(java.lang.Iterable&lt;org.apache.beam.runners.core.TimerInternals.TimerData&gt;&nbsp;completedTimers)</code>
<div class="block">Returns a <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager.TimerUpdate</code></a> that is like this one, but with the specified completed timers.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TimerUpdate</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html#withPushedBackTimers-java.lang.Iterable-">withPushedBackTimers</a></span>(java.lang.Iterable&lt;org.apache.beam.runners.core.TimerInternals.TimerData&gt;&nbsp;pushedBackTimers)</code>
<div class="block">Returns a <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager.TimerUpdate</code></a> that is like this one, but with the pushedBackTimersare removed
set by provided pushedBackTimers.</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&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, 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="empty--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>empty</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TimerUpdate</a>&nbsp;empty()</pre>
<div class="block">Returns a TimerUpdate for a null key with no timers.</div>
</li>
</ul>
<a name="builder-org.apache.beam.runners.local.StructuralKey-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>builder</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.TimerUpdateBuilder.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TimerUpdate.TimerUpdateBuilder</a>&nbsp;builder(<a href="../../../../../org/apache/beam/runners/local/StructuralKey.html" title="class in org.apache.beam.runners.local">StructuralKey</a>&lt;?&gt;&nbsp;key)</pre>
<div class="block">Creates a new <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager.TimerUpdate</code></a> builder with the provided completed timers that needs the
set and deleted timers to be added to it.</div>
</li>
</ul>
<a name="getCompletedTimers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompletedTimers</h4>
<pre>public&nbsp;java.lang.Iterable&lt;? extends org.apache.beam.runners.core.TimerInternals.TimerData&gt;&nbsp;getCompletedTimers()</pre>
</li>
</ul>
<a name="getSetTimers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSetTimers</h4>
<pre>public&nbsp;java.lang.Iterable&lt;? extends org.apache.beam.runners.core.TimerInternals.TimerData&gt;&nbsp;getSetTimers()</pre>
</li>
</ul>
<a name="getDeletedTimers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeletedTimers</h4>
<pre>public&nbsp;java.lang.Iterable&lt;? extends org.apache.beam.runners.core.TimerInternals.TimerData&gt;&nbsp;getDeletedTimers()</pre>
</li>
</ul>
<a name="withCompletedTimers-java.lang.Iterable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withCompletedTimers</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TimerUpdate</a>&nbsp;withCompletedTimers(java.lang.Iterable&lt;org.apache.beam.runners.core.TimerInternals.TimerData&gt;&nbsp;completedTimers)</pre>
<div class="block">Returns a <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager.TimerUpdate</code></a> that is like this one, but with the specified completed timers.
Note that if any of the completed timers is in pushedBackTimers, then it is set instead. The
pushedBackTimers are cleared afterwards.</div>
</li>
</ul>
<a name="withPushedBackTimers-java.lang.Iterable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withPushedBackTimers</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TimerUpdate</a>&nbsp;withPushedBackTimers(java.lang.Iterable&lt;org.apache.beam.runners.core.TimerInternals.TimerData&gt;&nbsp;pushedBackTimers)</pre>
<div class="block">Returns a <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager.TimerUpdate</code></a> that is like this one, but with the pushedBackTimersare removed
set by provided pushedBackTimers.</div>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;other)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="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/WatermarkManager.FiredTimers.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.TimerUpdateBuilder.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" target="_top">Frames</a></li>
<li><a href="WatermarkManager.TimerUpdate.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>