http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html new file mode 100644 index 0000000..b52e819 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html @@ -0,0 +1,383 @@ +<!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_111) on Fri Jan 27 21:25:28 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GroupByKeyViaGroupByKeyOnly (Apache Beam SDK for Java, version 0.5.0)</title> +<meta name="date" content="2017-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="GroupByKeyViaGroupByKeyOnly (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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"; +</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="class-use/GroupByKeyViaGroupByKeyOnly.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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/GroupAlsoByWindowViaWindowSetDoFn.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.GroupAlsoByWindow.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" target="_top">Frames</a></li> +<li><a href="GroupByKeyViaGroupByKeyOnly.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><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">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 name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.core</div> +<h2 title="Class GroupByKeyViaGroupByKeyOnly" class="title">Class GroupByKeyViaGroupByKeyOnly<K,V></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.PTransform</a><<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,V>>,<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><V>>>></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.GroupByKeyViaGroupByKeyOnly<K,V></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">GroupByKeyViaGroupByKeyOnly<K,V></span> +extends <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,V>>,<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><V>>>></pre> +<div class="block">An implementation of <a href="../../../../../org/apache/beam/sdk/transforms/GroupByKey.html" title="class in org.apache.beam.sdk.transforms"><code>GroupByKey</code></a> built on top of a lower-level <a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.GroupByKeyOnly.html" title="class in org.apache.beam.runners.core"><code>GroupByKeyViaGroupByKeyOnly.GroupByKeyOnly</code></a> + primitive. + + <p>This implementation of <a href="../../../../../org/apache/beam/sdk/transforms/GroupByKey.html" title="class in org.apache.beam.sdk.transforms"><code>GroupByKey</code></a> proceeds via the following steps: + <ol> + <li><code>ReifyTimestampsAndWindowsDoFn ParDo(ReifyTimestampsAndWindows)</code>: This embeds + the previously-implicit timestamp and window into the elements themselves, so a + window-and-timestamp-unaware transform can operate on them.</li> + <li><code>GroupByKeyOnly</code>: This lower-level primitive groups by keys, ignoring windows + and timestamps. Many window-unaware runners have such a primitive already.</li> + <li><code>SortValuesByTimestamp ParDo(SortValuesByTimestamp)</code>: The values in the iterables + output by <a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.GroupByKeyOnly.html" title="class in org.apache.beam.runners.core"><code>GroupByKeyViaGroupByKeyOnly.GroupByKeyOnly</code></a> are sorted by timestamp.</li> + <li><code>GroupAlsoByWindow</code>: This primitive processes the sorted values. Today it is + implemented as a <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> that calls reserved internal methods.</li> + </ol> + + <p>This implementation of <a href="../../../../../org/apache/beam/sdk/transforms/GroupByKey.html" title="class in org.apache.beam.sdk.transforms"><code>GroupByKey</code></a> has severe limitations unless its component + transforms are replaced. As-is, it is only applicable for in-memory runners using a batch-style + execution strategy. Specifically: + + <ul> + <li>Every iterable output by <a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.GroupByKeyOnly.html" title="class in org.apache.beam.runners.core"><code>GroupByKeyViaGroupByKeyOnly.GroupByKeyOnly</code></a> must contain all elements for that key. + A streaming-style partition, with multiple elements for the same key, will not yield + correct results.</li> + <li>Sorting of values by timestamp is performed on an in-memory list. It will not succeed + for large iterables.</li> + <li>The implementation of <code>GroupAlsoByWindow</code> does not support timers. This is only + appropriate for runners which also do not support timers.</li> + </ul></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.core.GroupByKeyViaGroupByKeyOnly">Serialized Form</a></dd> +</dl> +</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/core/GroupByKeyViaGroupByKeyOnly.GroupAlsoByWindow.html" title="class in org.apache.beam.runners.core">GroupByKeyViaGroupByKeyOnly.GroupAlsoByWindow</a><<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.GroupAlsoByWindow.html" title="type parameter in GroupByKeyViaGroupByKeyOnly.GroupAlsoByWindow">K</a>,<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.GroupAlsoByWindow.html" title="type parameter in GroupByKeyViaGroupByKeyOnly.GroupAlsoByWindow">V</a>></span></code> +<div class="block">Runner-specific primitive that takes a collection of timestamp-ordered values associated with + each key, groups the values by window, merges windows as needed, and for each window in each + key, outputs a collection of key/value-list pairs implicitly assigned to the window and with + the timestamp derived from that window.</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/core/GroupByKeyViaGroupByKeyOnly.GroupByKeyOnly.html" title="class in org.apache.beam.runners.core">GroupByKeyViaGroupByKeyOnly.GroupByKeyOnly</a><<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.GroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly.GroupByKeyOnly">K</a>,<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.GroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly.GroupByKeyOnly">V</a>></span></code> +<div class="block">Runner-specific primitive that groups by key only, ignoring any window assignments.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#name">name</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html#GroupByKeyViaGroupByKeyOnly-org.apache.beam.sdk.transforms.GroupByKey-">GroupByKeyViaGroupByKeyOnly</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/GroupByKey.html" title="class in org.apache.beam.sdk.transforms">GroupByKey</a><<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">K</a>,<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">V</a>> originalTransform)</code> </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="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><a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">K</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">V</a>>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html#expand-org.apache.beam.sdk.values.PCollection-">expand</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">K</a>,<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">V</a>>> input)</code> +<div class="block">Applies this <code>PTransform</code> on the given <code>InputT</code>, and returns its + <code>Output</code>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder--">getDefaultOutputCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-">getDefaultOutputCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.TypedPValue-">getDefaultOutputCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getKindString--">getKindString</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--">getName</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#toString--">toString</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-InputT-">valida te</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="GroupByKeyViaGroupByKeyOnly-org.apache.beam.sdk.transforms.GroupByKey-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GroupByKeyViaGroupByKeyOnly</h4> +<pre>public GroupByKeyViaGroupByKeyOnly(<a href="../../../../../org/apache/beam/sdk/transforms/GroupByKey.html" title="class in org.apache.beam.sdk.transforms">GroupByKey</a><<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">K</a>,<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">V</a>> originalTransform)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="expand-org.apache.beam.sdk.values.PCollection-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>expand</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">K</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">V</a>>>> expand(<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../. ./org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">K</a>,<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">V</a>>> input)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">PTransform</a></code></span></div> +<div class="block">Applies this <code>PTransform</code> on the given <code>InputT</code>, and returns its + <code>Output</code>. + + <p>Composite transforms, which are defined in terms of other transforms, + should return the output of one of the composed transforms. Non-composite + transforms, which do not apply any transforms internally, should return + a new unbound output and register evaluators (via backend-specific + registration methods).</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">expand</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">K</a>,<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">V</a>>>,<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam /sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">K</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" title="type parameter in GroupByKeyViaGroupByKeyOnly">V</a>>>>></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="class-use/GroupByKeyViaGroupByKeyOnly.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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/GroupAlsoByWindowViaWindowSetDoFn.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.GroupAlsoByWindow.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.html" target="_top">Frames</a></li> +<li><a href="GroupByKeyViaGroupByKeyOnly.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><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">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 name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/InMemoryTimerInternals.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/InMemoryTimerInternals.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/InMemoryTimerInternals.html new file mode 100644 index 0000000..cb61419 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/InMemoryTimerInternals.html @@ -0,0 +1,722 @@ +<!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_111) on Fri Jan 27 21:25:28 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>InMemoryTimerInternals (Apache Beam SDK for Java, version 0.5.0)</title> +<meta name="date" content="2017-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="InMemoryTimerInternals (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":42,"i9":10,"i10":42,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":42,"i17":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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="class-use/InMemoryTimerInternals.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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.GroupByKeyOnly.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/InMemoryTimerInternals.html" target="_top">Frames</a></li> +<li><a href="InMemoryTimerInternals.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>Nested | </li> +<li>Field | </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 name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.core</div> +<h2 title="Class InMemoryTimerInternals" class="title">Class InMemoryTimerInternals</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.InMemoryTimerInternals</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">InMemoryTimerInternals</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a></pre> +<div class="block"><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util"><code>TimerInternals</code></a> with all watermarks and processing clock simulated in-memory.</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> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.util.TimerInternals"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.beam.sdk.util.<a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a>, <a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerDataCoder.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerDataCoder</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#InMemoryTimerInternals--">InMemoryTimerInternals</a></span>()</code> </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="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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#advanceInputWatermark-org.joda.time.Instant-">advanceInputWatermark</a></span>(org.joda.time.Instant newInputWatermark)</code> +<div class="block">Advances input watermark to the given value.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#advanceOutputWatermark-org.joda.time.Instant-">advanceOutputWatermark</a></span>(org.joda.time.Instant newOutputWatermark)</code> +<div class="block">Advances output watermark to the given value.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#advanceProcessingTime-org.joda.time.Instant-">advanceProcessingTime</a></span>(org.joda.time.Instant newProcessingTime)</code> +<div class="block">Advances processing time to the given value.</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/core/InMemoryTimerInternals.html#advanceSynchronizedProcessingTime-org.joda.time.Instant-">advanceSynchronizedProcessingTime</a></span>(org.joda.time.Instant newSynchronizedProcessingTime)</code> +<div class="block">Advances synchronized processing time to the given value.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>org.joda.time.Instant</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#currentInputWatermarkTime--">currentInputWatermarkTime</a></span>()</code> +<div class="block">Return the current, local input watermark timestamp for this computation + in the <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html#EVENT_TIME"><code>TimeDomain.EVENT_TIME</code></a> time domain.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>org.joda.time.Instant</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#currentOutputWatermarkTime--">currentOutputWatermarkTime</a></span>()</code> +<div class="block">Return the current, local output watermark timestamp for this computation + in the <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html#EVENT_TIME"><code>TimeDomain.EVENT_TIME</code></a> time domain.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>org.joda.time.Instant</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#currentProcessingTime--">currentProcessingTime</a></span>()</code> +<div class="block">Returns the current timestamp in the <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html#PROCESSING_TIME"><code>TimeDomain.PROCESSING_TIME</code></a> time domain.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>org.joda.time.Instant</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#currentSynchronizedProcessingTime--">currentSynchronizedProcessingTime</a></span>()</code> +<div class="block">Returns the current timestamp in the <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html#SYNCHRONIZED_PROCESSING_TIME"><code>TimeDomain.SYNCHRONIZED_PROCESSING_TIME</code></a> time + domain or <code>null</code> if unknown.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#deleteTimer-org.apache.beam.sdk.util.state.StateNamespace-java.lang.String-">deleteTimer</a></span>(<a href="../../../../../org/apache/beam/sdk/util/state/StateNamespace.html" title="interface in org.apache.beam.sdk.util.state">StateNamespace</a> namespace, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> timerId)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#deleteTimer-org.apache.beam.sdk.util.state.StateNamespace-java.lang.String-org.apache.beam.sdk.util.TimeDomain-">deleteTimer</a></span>(<a href="../../../../../org/apache/beam/sdk/util/state/StateNamespace.html" title="interface in org.apache.beam.sdk.util.state">StateNamespace</a> namespace, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> timerId, + <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html" title="enum in org.apache.beam.sdk.util">TimeDomain</a> timeDomain)</code> +<div class="block">Deletes the given timer.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#deleteTimer-org.apache.beam.sdk.util.TimerInternals.TimerData-">deleteTimer</a></span>(<a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a> timer)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>org.joda.time.Instant</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#getNextTimer-org.apache.beam.sdk.util.TimeDomain-">getNextTimer</a></span>(<a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html" title="enum in org.apache.beam.sdk.util">TimeDomain</a> domain)</code> +<div class="block">Returns when the next timer in the given time domain will fire, or <code>null</code> + if there are no timers scheduled in that time domain.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#removeNextEventTimer--">removeNextEventTimer</a></span>()</code> +<div class="block">Returns the next eligible event time timer, if none returns null.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#removeNextProcessingTimer--">removeNextProcessingTimer</a></span>()</code> +<div class="block">Returns the next eligible processing time timer, if none returns null.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#removeNextSynchronizedProcessingTimer--">removeNextSynchronizedProcessingTimer</a></span>()</code> +<div class="block">Returns the next eligible synchronized processing time timer, if none returns null.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#setTimer-org.apache.beam.sdk.util.state.StateNamespace-java.lang.String-org.joda.time.Instant-org.apache.beam.sdk.util.TimeDomain-">setTimer</a></span>(<a href="../../../../../org/apache/beam/sdk/util/state/StateNamespace.html" title="interface in org.apache.beam.sdk.util.state">StateNamespace</a> namespace, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> timerId, + org.joda.time.Instant target, + <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html" title="enum in org.apache.beam.sdk.util">TimeDomain</a> timeDomain)</code> +<div class="block">Sets a timer to be fired when the current time in the specified time domain reaches the + target timestamp.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#setTimer-org.apache.beam.sdk.util.TimerInternals.TimerData-">setTimer</a></span>(<a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a> timerData)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html#toString--">toString</a></span>()</code> </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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="InMemoryTimerInternals--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>InMemoryTimerInternals</h4> +<pre>public InMemoryTimerInternals()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="currentOutputWatermarkTime--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>currentOutputWatermarkTime</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/javax/annotation/Nullable.html?is-external=true"; title="class or interface in javax.annotation">@Nullable</a> +public org.joda.time.Instant currentOutputWatermarkTime()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#currentOutputWatermarkTime--">TimerInternals</a></code></span></div> +<div class="block">Return the current, local output watermark timestamp for this computation + in the <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html#EVENT_TIME"><code>TimeDomain.EVENT_TIME</code></a> time domain. Return <code>null</code> if unknown. + + <p>This value: + <ol> + <li>Is monotonically increasing. + <li>Will never be ahead of <a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#currentInputWatermarkTime--"><code>TimerInternals.currentInputWatermarkTime()</code></a> as returned above. + <li>May differ between workers due to network and other delays. + <li>However will never be behind the global input watermark for any following computation. + </ol> + + <p>In pictures: + <pre><code> + | | | | | + | | D | C | B | A + | | | | | + GIWM <= GOWM <= LOWM <= LIWM <= GIWM + (next stage) + -------------------------------------------------> event time + </code></pre> + + <p>where + + <ul> + <li> LOWM = local output water mark. + <li> GOWM = global output water mark. + <li> GIWM = global input water mark. + <li> LIWM = local input water mark. + <li> A = A globally on-time element. + <li> B = A globally late, but locally on-time element. + <li> C = A locally late element which may still contribute to the timestamp of a pane. + <li> D = A locally late element which cannot contribute to the timestamp of a pane. + </ul> + + <p>Note that if a computation emits an element which is not before the current output watermark + then that element will always appear locally on-time in all following computations. However, + it is possible for an element emitted before the current output watermark to appear locally + on-time in a following computation. Thus we must be careful to never assume locally late data + viewed on the output of a computation remains locally late on the input of a following + computation.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#currentOutputWatermarkTime--">currentOutputWatermarkTime</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a></code></dd> +</dl> +</li> +</ul> +<a name="getNextTimer-org.apache.beam.sdk.util.TimeDomain-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNextTimer</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/javax/annotation/Nullable.html?is-external=true"; title="class or interface in javax.annotation">@Nullable</a> +public org.joda.time.Instant getNextTimer(<a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html" title="enum in org.apache.beam.sdk.util">TimeDomain</a> domain)</pre> +<div class="block">Returns when the next timer in the given time domain will fire, or <code>null</code> + if there are no timers scheduled in that time domain.</div> +</li> +</ul> +<a name="setTimer-org.apache.beam.sdk.util.state.StateNamespace-java.lang.String-org.joda.time.Instant-org.apache.beam.sdk.util.TimeDomain-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTimer</h4> +<pre>public void setTimer(<a href="../../../../../org/apache/beam/sdk/util/state/StateNamespace.html" title="interface in org.apache.beam.sdk.util.state">StateNamespace</a> namespace, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> timerId, + org.joda.time.Instant target, + <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html" title="enum in org.apache.beam.sdk.util">TimeDomain</a> timeDomain)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#setTimer-org.apache.beam.sdk.util.state.StateNamespace-java.lang.String-org.joda.time.Instant-org.apache.beam.sdk.util.TimeDomain-">TimerInternals</a></code></span></div> +<div class="block">Sets a timer to be fired when the current time in the specified time domain reaches the + target timestamp. + + <p>The combination of <code>namespace</code> and <code>timerId</code> uniquely identify a timer. + + <p>If a timer is set and then set again before it fires, later settings should clear the prior + setting. + + <p>It is an error to set a timer for two different time domains.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#setTimer-org.apache.beam.sdk.util.state.StateNamespace-java.lang.String-org.joda.time.Instant-org.apache.beam.sdk.util.TimeDomain-">setTimer</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a></code></dd> +</dl> +</li> +</ul> +<a name="setTimer-org.apache.beam.sdk.util.TimerInternals.TimerData-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTimer</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public void setTimer(<a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a> timerData)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#setTimer-org.apache.beam.sdk.util.TimerInternals.TimerData-">setTimer</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a></code></dd> +</dl> +</li> +</ul> +<a name="deleteTimer-org.apache.beam.sdk.util.state.StateNamespace-java.lang.String-org.apache.beam.sdk.util.TimeDomain-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteTimer</h4> +<pre>public void deleteTimer(<a href="../../../../../org/apache/beam/sdk/util/state/StateNamespace.html" title="interface in org.apache.beam.sdk.util.state">StateNamespace</a> namespace, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> timerId, + <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html" title="enum in org.apache.beam.sdk.util">TimeDomain</a> timeDomain)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#deleteTimer-org.apache.beam.sdk.util.state.StateNamespace-java.lang.String-org.apache.beam.sdk.util.TimeDomain-">TimerInternals</a></code></span></div> +<div class="block">Deletes the given timer. + + <p>A timer's ID is enforced to be unique in validation of a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>, but runners + often manage timers for different time domains in very different ways, thus the + <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html" title="enum in org.apache.beam.sdk.util"><code>TimeDomain</code></a> is a required parameter.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#deleteTimer-org.apache.beam.sdk.util.state.StateNamespace-java.lang.String-org.apache.beam.sdk.util.TimeDomain-">deleteTimer</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a></code></dd> +</dl> +</li> +</ul> +<a name="deleteTimer-org.apache.beam.sdk.util.state.StateNamespace-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteTimer</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public void deleteTimer(<a href="../../../../../org/apache/beam/sdk/util/state/StateNamespace.html" title="interface in org.apache.beam.sdk.util.state">StateNamespace</a> namespace, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> timerId)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#deleteTimer-org.apache.beam.sdk.util.state.StateNamespace-java.lang.String-">deleteTimer</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a></code></dd> +</dl> +</li> +</ul> +<a name="deleteTimer-org.apache.beam.sdk.util.TimerInternals.TimerData-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteTimer</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public void deleteTimer(<a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a> timer)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#deleteTimer-org.apache.beam.sdk.util.TimerInternals.TimerData-">deleteTimer</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a></code></dd> +</dl> +</li> +</ul> +<a name="currentProcessingTime--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>currentProcessingTime</h4> +<pre>public org.joda.time.Instant currentProcessingTime()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#currentProcessingTime--">TimerInternals</a></code></span></div> +<div class="block">Returns the current timestamp in the <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html#PROCESSING_TIME"><code>TimeDomain.PROCESSING_TIME</code></a> time domain.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#currentProcessingTime--">currentProcessingTime</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a></code></dd> +</dl> +</li> +</ul> +<a name="currentSynchronizedProcessingTime--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>currentSynchronizedProcessingTime</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/javax/annotation/Nullable.html?is-external=true"; title="class or interface in javax.annotation">@Nullable</a> +public org.joda.time.Instant currentSynchronizedProcessingTime()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#currentSynchronizedProcessingTime--">TimerInternals</a></code></span></div> +<div class="block">Returns the current timestamp in the <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html#SYNCHRONIZED_PROCESSING_TIME"><code>TimeDomain.SYNCHRONIZED_PROCESSING_TIME</code></a> time + domain or <code>null</code> if unknown.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#currentSynchronizedProcessingTime--">currentSynchronizedProcessingTime</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a></code></dd> +</dl> +</li> +</ul> +<a name="currentInputWatermarkTime--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>currentInputWatermarkTime</h4> +<pre>public org.joda.time.Instant currentInputWatermarkTime()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#currentInputWatermarkTime--">TimerInternals</a></code></span></div> +<div class="block">Return the current, local input watermark timestamp for this computation + in the <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html#EVENT_TIME"><code>TimeDomain.EVENT_TIME</code></a> time domain. + + <p>This value: + <ol> + <li>Is never null, but may be <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html#TIMESTAMP_MIN_VALUE"><code>BoundedWindow.TIMESTAMP_MIN_VALUE</code></a>. + <li>Is monotonically increasing. + <li>May differ between workers due to network and other delays. + <li>Will never be ahead of the global input watermark for this computation. But it + may be arbitrarily behind the global input watermark. + <li>Any element with a timestamp before the local input watermark can be considered + 'locally late' and be subject to special processing or be dropped entirely. + </ol> + + <p>Note that because the local input watermark can be behind the global input watermark, + it is possible for an element to be considered locally on-time even though it is + globally late.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html#currentInputWatermarkTime--">currentInputWatermarkTime</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a></code></dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="advanceInputWatermark-org.joda.time.Instant-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>advanceInputWatermark</h4> +<pre>public void advanceInputWatermark(org.joda.time.Instant newInputWatermark) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Advances input watermark to the given value.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="advanceOutputWatermark-org.joda.time.Instant-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>advanceOutputWatermark</h4> +<pre>public void advanceOutputWatermark(org.joda.time.Instant newOutputWatermark)</pre> +<div class="block">Advances output watermark to the given value.</div> +</li> +</ul> +<a name="advanceProcessingTime-org.joda.time.Instant-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>advanceProcessingTime</h4> +<pre>public void advanceProcessingTime(org.joda.time.Instant newProcessingTime) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Advances processing time to the given value.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="advanceSynchronizedProcessingTime-org.joda.time.Instant-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>advanceSynchronizedProcessingTime</h4> +<pre>public void advanceSynchronizedProcessingTime(org.joda.time.Instant newSynchronizedProcessingTime) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Advances synchronized processing time to the given value.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="removeNextEventTimer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeNextEventTimer</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/javax/annotation/Nullable.html?is-external=true"; title="class or interface in javax.annotation">@Nullable</a> +public <a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a> removeNextEventTimer()</pre> +<div class="block">Returns the next eligible event time timer, if none returns null.</div> +</li> +</ul> +<a name="removeNextProcessingTimer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeNextProcessingTimer</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/javax/annotation/Nullable.html?is-external=true"; title="class or interface in javax.annotation">@Nullable</a> +public <a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a> removeNextProcessingTimer()</pre> +<div class="block">Returns the next eligible processing time timer, if none returns null.</div> +</li> +</ul> +<a name="removeNextSynchronizedProcessingTimer--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>removeNextSynchronizedProcessingTimer</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/javax/annotation/Nullable.html?is-external=true"; title="class or interface in javax.annotation">@Nullable</a> +public <a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a> removeNextSynchronizedProcessingTimer()</pre> +<div class="block">Returns the next eligible synchronized processing time timer, if none returns null.</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="class-use/InMemoryTimerInternals.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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/GroupByKeyViaGroupByKeyOnly.GroupByKeyOnly.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/InMemoryTimerInternals.html" target="_top">Frames</a></li> +<li><a href="InMemoryTimerInternals.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>Nested | </li> +<li>Field | </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 name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItem.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItem.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItem.html new file mode 100644 index 0000000..e01a29b --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItem.html @@ -0,0 +1,268 @@ +<!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_111) on Fri Jan 27 21:25:28 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KeyedWorkItem (Apache Beam SDK for Java, version 0.5.0)</title> +<meta name="date" content="2017-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="KeyedWorkItem (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/KeyedWorkItem.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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/KeyedWorkItem.html" target="_top">Frames</a></li> +<li><a href="KeyedWorkItem.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>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 name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.core</div> +<h2 title="Interface KeyedWorkItem" class="title">Interface KeyedWorkItem<K,ElemT></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>K</code> - the key type</dd> +<dd><code>ElemT</code> - the element type</dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html" title="class in org.apache.beam.runners.core">KeyedWorkItems.ComposedKeyedWorkItem</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">KeyedWorkItem<K,ElemT></span></pre> +<div class="block">Interface that contains all the timers and elements associated with a specific work item.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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="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="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="type parameter in KeyedWorkItem">ElemT</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html#elementsIterable--">elementsIterable</a></span>()</code> +<div class="block">Returns an iterable containing the elements.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="type parameter in KeyedWorkItem">K</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html#key--">key</a></span>()</code> +<div class="block">Returns the key.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html#timersIterable--">timersIterable</a></span>()</code> +<div class="block">Returns an iterable containing the timers.</div> +</td> +</tr> +</table> +</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="key--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>key</h4> +<pre><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="type parameter in KeyedWorkItem">K</a> key()</pre> +<div class="block">Returns the key.</div> +</li> +</ul> +<a name="timersIterable--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>timersIterable</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a>> timersIterable()</pre> +<div class="block">Returns an iterable containing the timers.</div> +</li> +</ul> +<a name="elementsIterable--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>elementsIterable</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="type parameter in KeyedWorkItem">ElemT</a>>> elementsIterable()</pre> +<div class="block">Returns an iterable containing the elements.</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="class-use/KeyedWorkItem.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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/InMemoryTimerInternals.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/KeyedWorkItemCoder.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/KeyedWorkItem.html" target="_top">Frames</a></li> +<li><a href="KeyedWorkItem.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>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 name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
