http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/6fce44a2/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InMemoryWatermarkManager.html ---------------------------------------------------------------------- diff --git a/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InMemoryWatermarkManager.html b/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InMemoryWatermarkManager.html new file mode 100644 index 0000000..86a3c63 --- /dev/null +++ b/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InMemoryWatermarkManager.html @@ -0,0 +1,442 @@ +<!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-google-v7) on Tue Jun 14 18:28:14 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>InMemoryWatermarkManager (Apache Beam SDK for Java 0.1.0-incubating API)</title> +<meta name="date" content="2016-06-14"> +<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="InMemoryWatermarkManager (Apache Beam SDK for Java 0.1.0-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":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="class-use/InMemoryWatermarkManager.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/direct/ForwardingPTransform.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.FiredTimers.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/InMemoryWatermarkManager.html" target="_top">Frames</a></li> +<li><a href="InMemoryWatermarkManager.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.direct</div> +<h2 title="Class InMemoryWatermarkManager" class="title">Class InMemoryWatermarkManager</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.direct.InMemoryWatermarkManager</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">InMemoryWatermarkManager</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></pre> +<div class="block">Manages watermarks of <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> and input and output watermarks of + <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransforms</code></a> to provide event-time and completion tracking for + in-memory execution. <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>InMemoryWatermarkManager</code></a> is designed to update and return a + consistent view of watermarks in the presence of concurrent updates. + + <p>An <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>InMemoryWatermarkManager</code></a> is provided with the collection of root + <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransforms</code></a> and a map of <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> to + all the <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransforms</code></a> that consume them at construction time. + + <p>Whenever a root <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>transform</code></a> produces elements, the + <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>InMemoryWatermarkManager</code></a> is provided with the produced elements and the output watermark + of the producing <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>transform</code></a>. The + <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>watermark manager</code></a> is responsible for computing the watermarks + of all <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>transforms</code></a> that consume one or more + <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a>. + + <p>Whenever a non-root <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a> finishes processing one or more in-flight + elements (referred to as the input <a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.CommittedBundle.html" title="interface in org.apache.beam.runners.direct"><code>bundle</code></a>), the following occurs + atomically: + <ul> + <li>All of the in-flight elements are removed from the collection of pending elements for the + <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a>.</li> + <li>All of the elements produced by the <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a> are added to the collection + of pending elements for each <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a> that consumes them.</li> + <li>The input watermark for the <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a> becomes the maximum value of + <ul> + <li>the previous input watermark</li> + <li>the minimum of + <ul> + <li>the timestamps of all currently pending elements</li> + <li>all input <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> watermarks</li> + </ul> + </li> + </ul> + </li> + <li>The output watermark for the <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a> becomes the maximum of + <ul> + <li>the previous output watermark</li> + <li>the minimum of + <ul> + <li>the current input watermark</li> + <li>the current watermark holds</li> + </ul> + </li> + </ul> + </li> + <li>The watermark of the output <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> can be advanced to the output watermark of + the <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a></li> + <li>The watermark of all downstream <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransforms</code></a> can be + advanced.</li> + </ul> + + <p>The watermark of a <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> is equal to the output watermark of the + <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a> that produces it. + + <p>The watermarks for a <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> are updated as follows when output is committed:<pre> + Watermark_In' = MAX(Watermark_In, MIN(U(TS_Pending), U(Watermark_InputPCollection))) + Watermark_Out' = MAX(Watermark_Out, MIN(Watermark_In', U(StateHold))) + Watermark_PCollection = Watermark_Out_ProducingPTransform + </pre></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.FiredTimers.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.FiredTimers</a></span></code> +<div class="block">A pair of <a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util"><code>TimerInternals.TimerData</code></a> and key which can be delivered to the appropriate + <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.TimerUpdate</a></span></code> +<div class="block">A collection of newly set, deleted, and completed timers.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.TransformWatermarks.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.TransformWatermarks</a></span></code> +<div class="block">A reference to the input and output watermarks of an <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a>.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html#create-org.apache.beam.runners.direct.Clock-java.util.Collection-java.util.Map-">create</a></span>(<a href="../../../../../org/apache/beam/runners/direct/Clock.html" title="interface in org.apache.beam.runners.direct">Clock</a> clock, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms">AppliedPTransform</a><?,?,?>> rootTransforms, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms">AppliedPTransform</a><?,?,?>>> consumers)</code> +<div class="block">Creates a new <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>InMemoryWatermarkManager</code></a>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms">AppliedPTransform</a><?,?,?>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><org.apache.beam.runners.direct.StructuralKey<?>,<a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.FiredTimers.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.FiredTimers</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html#extractFiredTimers--">extractFiredTimers</a></span>()</code> +<div class="block">Returns a map of each <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that has pending timers to those timers.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms">AppliedPTransform</a><?,?,?>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html#getCompletedTransforms--">getCompletedTransforms</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.TransformWatermarks.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.TransformWatermarks</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html#getWatermarks-org.apache.beam.sdk.transforms.AppliedPTransform-">getWatermarks</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms">AppliedPTransform</a><?,?,?> transform)</code> +<div class="block">Gets the input and output watermarks for an <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html#updateWatermarks-org.apache.beam.runners.direct.InProcessPipelineRunner.CommittedBundle-org.apache.beam.runners.direct.InMemoryWatermarkManager.TimerUpdate-org.apache.beam.runners.direct.CommittedResult-org.joda.time.Instant-">updateWatermarks</a></span>(<a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.CommittedBundle.html" title="interface in org.apache.beam.runners.direct">InProcessPipelineRunner.CommittedBundle</a><?> completed, + <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.TimerUpdate</a> timerUpdate, + org.apache.beam.runners.direct.CommittedResult result, + org.joda.time.Instant earliestHold)</code> +<div class="block">Updates the watermarks of a transform with one or more inputs.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<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#toString--"; title="class or interface in java.lang">toString</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="create-org.apache.beam.runners.direct.Clock-java.util.Collection-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager</a> create(<a href="../../../../../org/apache/beam/runners/direct/Clock.html" title="interface in org.apache.beam.runners.direct">Clock</a> clock, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms">AppliedPTransform</a><?,?,?>> rootTransforms, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms">AppliedPTransform</a><?,?,?>>> consumers)</pre> +<div class="block">Creates a new <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>InMemoryWatermarkManager</code></a>. All watermarks within the newly created + <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>InMemoryWatermarkManager</code></a> start at <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html#TIMESTAMP_MIN_VALUE"><code>BoundedWindow.TIMESTAMP_MIN_VALUE</code></a>, the + minimum watermark, with no watermark holds or pending elements.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>rootTransforms</code> - the root-level transforms of the <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a></dd> +<dd><code>consumers</code> - a mapping between each <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> in the <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> to the + transforms that consume it as a part of their input</dd> +</dl> +</li> +</ul> +<a name="getWatermarks-org.apache.beam.sdk.transforms.AppliedPTransform-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWatermarks</h4> +<pre>public <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.TransformWatermarks.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.TransformWatermarks</a> getWatermarks(<a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms">AppliedPTransform</a><?,?,?> transform)</pre> +<div class="block">Gets the input and output watermarks for an <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a>. If the + <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> has not processed any elements, return a watermark of + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html#TIMESTAMP_MIN_VALUE"><code>BoundedWindow.TIMESTAMP_MIN_VALUE</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a snapshot of the input watermark and output watermark for the provided transform</dd> +</dl> +</li> +</ul> +<a name="updateWatermarks-org.apache.beam.runners.direct.InProcessPipelineRunner.CommittedBundle-org.apache.beam.runners.direct.InMemoryWatermarkManager.TimerUpdate-org.apache.beam.runners.direct.CommittedResult-org.joda.time.Instant-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>updateWatermarks</h4> +<pre>public void updateWatermarks(<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> + <a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.CommittedBundle.html" title="interface in org.apache.beam.runners.direct">InProcessPipelineRunner.CommittedBundle</a><?> completed, + <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.TimerUpdate</a> timerUpdate, + org.apache.beam.runners.direct.CommittedResult result, + org.joda.time.Instant earliestHold)</pre> +<div class="block">Updates the watermarks of a transform with one or more inputs. + + <p>Each transform has two monotonically increasing watermarks: the input watermark, which can, + at any time, be updated to equal: + <pre> + MAX(CurrentInputWatermark, MIN(PendingElements, InputPCollectionWatermarks)) + </pre> + and the output watermark, which can, at any time, be updated to equal: + <pre> + MAX(CurrentOutputWatermark, MIN(InputWatermark, WatermarkHolds)) + </pre>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>completed</code> - the input that has completed</dd> +<dd><code>timerUpdate</code> - the timers that were added, removed, and completed as part of producing + this update</dd> +<dd><code>result</code> - the result that was produced by processing the input</dd> +<dd><code>earliestHold</code> - the earliest watermark hold in the transform's state. <code>null</code> if there + is no hold</dd> +</dl> +</li> +</ul> +<a name="extractFiredTimers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>extractFiredTimers</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms">AppliedPTransform</a><?,?,?>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><org.apache.beam.runners.direct.StructuralKey<?>,<a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.FiredTimers.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.FiredTimers</a>>> extractFiredTimers()</pre> +<div class="block">Returns a map of each <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that has pending timers to those timers. All of the + pending timers will be removed from this <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.html" title="class in org.apache.beam.runners.direct"><code>InMemoryWatermarkManager</code></a>.</div> +</li> +</ul> +<a name="getCompletedTransforms--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getCompletedTransforms</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms">AppliedPTransform</a><?,?,?>> getCompletedTransforms()</pre> +</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/InMemoryWatermarkManager.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/direct/ForwardingPTransform.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.FiredTimers.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/InMemoryWatermarkManager.html" target="_top">Frames</a></li> +<li><a href="InMemoryWatermarkManager.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/6fce44a2/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessBundleOutputManager.html ---------------------------------------------------------------------- diff --git a/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessBundleOutputManager.html b/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessBundleOutputManager.html new file mode 100644 index 0000000..da149dc --- /dev/null +++ b/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessBundleOutputManager.html @@ -0,0 +1,303 @@ +<!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-google-v7) on Tue Jun 14 18:28:14 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>InProcessBundleOutputManager (Apache Beam SDK for Java 0.1.0-incubating API)</title> +<meta name="date" content="2016-06-14"> +<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="InProcessBundleOutputManager (Apache Beam SDK for Java 0.1.0-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":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="class-use/InProcessBundleOutputManager.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/direct/InMemoryWatermarkManager.TransformWatermarks.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineOptions.html" title="interface in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/InProcessBundleOutputManager.html" target="_top">Frames</a></li> +<li><a href="InProcessBundleOutputManager.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.direct</div> +<h2 title="Class InProcessBundleOutputManager" class="title">Class InProcessBundleOutputManager</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.direct.InProcessBundleOutputManager</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/DoFnRunners.OutputManager.html" title="interface in org.apache.beam.sdk.util">DoFnRunners.OutputManager</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">InProcessBundleOutputManager</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/DoFnRunners.OutputManager.html" title="interface in org.apache.beam.sdk.util">DoFnRunners.OutputManager</a></pre> +<div class="block">An <a href="../../../../../org/apache/beam/sdk/util/DoFnRunners.OutputManager.html" title="interface in org.apache.beam.sdk.util"><code>DoFnRunners.OutputManager</code></a> that outputs to <a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.CommittedBundle.html" title="interface in org.apache.beam.runners.direct"><code>Bundles</code></a> used by the + <a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.html" title="class in org.apache.beam.runners.direct"><code>InProcessPipelineRunner</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/direct/InProcessBundleOutputManager.html#InProcessBundleOutputManager-java.util.Map-">InProcessBundleOutputManager</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>,<a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.UncommittedBundle.html" title="interface in org.apache.beam.runners.direct">InProcessPipelineRunner.UncommittedBundle</a><?>> bundles)</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/beam/runners/direct/InProcessBundleOutputManager.html" title="class in org.apache.beam.runners.direct">InProcessBundleOutputManager</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessBundleOutputManager.html#create-java.util.Map-">create</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>,<a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.UncommittedBundle.html" title="interface in org.apache.beam.runners.direct">InProcessPipelineRunner.UncommittedBundle</a><?>> outputBundles)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><T> void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessBundleOutputManager.html#output-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.util.WindowedValue-">output</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><T> tag, + <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><T> output)</code> +<div class="block">Outputs a single element to the receiver indicated by the given <a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values"><code>TupleTag</code></a>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<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#toString--"; title="class or interface in java.lang">toString</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="InProcessBundleOutputManager-java.util.Map-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>InProcessBundleOutputManager</h4> +<pre>public InProcessBundleOutputManager(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>,<a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.UncommittedBundle.html" title="interface in org.apache.beam.runners.direct">InProcessPipelineRunner.UncommittedBundle</a><?>> bundles)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="create-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../../org/apache/beam/runners/direct/InProcessBundleOutputManager.html" title="class in org.apache.beam.runners.direct">InProcessBundleOutputManager</a> create(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>,<a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.UncommittedBundle.html" title="interface in org.apache.beam.runners.direct">InProcessPipelineRunner.UncommittedBundle</a><?>> outputBundles)</pre> +</li> +</ul> +<a name="output-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.util.WindowedValue-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>output</h4> +<pre>public <T> void output(<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><T> tag, + <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><T> output)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/util/DoFnRunners.OutputManager.html#output-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.util.WindowedValue-">DoFnRunners.OutputManager</a></code></span></div> +<div class="block">Outputs a single element to the receiver indicated by the given <a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values"><code>TupleTag</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/util/DoFnRunners.OutputManager.html#output-org.apache.beam.sdk.values.TupleTag-org.apache.beam.sdk.util.WindowedValue-">output</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/util/DoFnRunners.OutputManager.html" title="interface in org.apache.beam.sdk.util">DoFnRunners.OutputManager</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/InProcessBundleOutputManager.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/direct/InMemoryWatermarkManager.TransformWatermarks.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineOptions.html" title="interface in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/InProcessBundleOutputManager.html" target="_top">Frames</a></li> +<li><a href="InProcessBundleOutputManager.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 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/6fce44a2/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessPipelineOptions.html ---------------------------------------------------------------------- diff --git a/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessPipelineOptions.html b/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessPipelineOptions.html new file mode 100644 index 0000000..1fab964 --- /dev/null +++ b/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessPipelineOptions.html @@ -0,0 +1,407 @@ +<!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-google-v7) on Tue Jun 14 18:28:14 PDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>InProcessPipelineOptions (Apache Beam SDK for Java 0.1.0-incubating API)</title> +<meta name="date" content="2016-06-14"> +<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="InProcessPipelineOptions (Apache Beam SDK for Java 0.1.0-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":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/InProcessPipelineOptions.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/direct/InProcessBundleOutputManager.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/InProcessPipelineOptions.html" target="_top">Frames</a></li> +<li><a href="InProcessPipelineOptions.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.direct</div> +<h2 title="Interface InProcessPipelineOptions" class="title">Interface InProcessPipelineOptions</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html" title="interface in org.apache.beam.sdk.options">ApplicationNameOptions</a>, <a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">InProcessPipelineOptions</span> +extends <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>, <a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html" title="interface in org.apache.beam.sdk.options">ApplicationNameOptions</a></pre> +<div class="block">Options that can be used to configure the <a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.html" title="class in org.apache.beam.runners.direct"><code>InProcessPipelineRunner</code></a>.</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.options.PipelineOptions"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.<a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.CheckEnabled.html" title="enum in org.apache.beam.sdk.options">PipelineOptions.CheckEnabled</a></code></li> +</ul> +</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="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="../../../../../org/apache/beam/runners/direct/Clock.html" title="interface in org.apache.beam.runners.direct">Clock</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineOptions.html#getClock--">getClock</a></span>()</code> +<div class="block">Gets the <a href="../../../../../org/apache/beam/runners/direct/Clock.html" title="interface in org.apache.beam.runners.direct"><code>Clock</code></a> used by this pipeline.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/direct/ExecutorServiceFactory.html" title="interface in org.apache.beam.runners.direct">ExecutorServiceFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineOptions.html#getExecutorServiceFactory--">getExecutorServiceFactory</a></span>()</code> +<div class="block">Gets the <a href="../../../../../org/apache/beam/runners/direct/ExecutorServiceFactory.html" title="interface in org.apache.beam.runners.direct"><code>ExecutorServiceFactory</code></a> to use to create instances of <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true"; title="class or interface in java.util.concurrent"><code>ExecutorService</code></a> + to execute <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransforms</code></a>.</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/InProcessPipelineOptions.html#isBlockOnRun--">isBlockOnRun</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineOptions.html#isShutdownUnboundedProducersWithMaxWatermark--">isShutdownUnboundedProducersWithMaxWatermark</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineOptions.html#isTestImmutability--">isTestImmutability</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineOptions.html#setBlockOnRun-boolean-">setBlockOnRun</a></span>(boolean b)</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineOptions.html#setClock-org.apache.beam.runners.direct.Clock-">setClock</a></span>(<a href="../../../../../org/apache/beam/runners/direct/Clock.html" title="interface in org.apache.beam.runners.direct">Clock</a> clock)</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineOptions.html#setExecutorServiceFactory-org.apache.beam.runners.direct.ExecutorServiceFactory-">setExecutorServiceFactory</a></span>(<a href="../../../../../org/apache/beam/runners/direct/ExecutorServiceFactory.html" title="interface in org.apache.beam.runners.direct">ExecutorServiceFactory</a> executorService)</code> </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/direct/InProcessPipelineOptions.html#setShutdownUnboundedProducersWithMaxWatermark-boolean-">setShutdownUnboundedProducersWithMaxWatermark</a></span>(boolean shutdown)</code> </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/direct/InProcessPipelineOptions.html#setTestImmutability-boolean-">setTestImmutability</a></span>(boolean test)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.options.ApplicationNameOptions"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.beam.sdk.options.<a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html" title="interface in org.apache.beam.sdk.options">ApplicationNameOptions</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html#getAppName--">getAppName</a>, <a href="../../../../../org/apache/beam/sdk/options/ApplicationNameOptions.html#setAppName-java.lang.String-">setAppName</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.options.PipelineOptions"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.beam.sdk.options.<a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#as-java.lang.Class-">as</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#cloneAs-java.lang.Class-">cloneAs</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getRunner--">getRunner</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getStableUniqueNames--">getStableUniqueNames</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#getTempLocation--">getTempLocation</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setRunner-java.lang.Class-">setRunner</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setStableUniqueNames-org.apache.beam.sdk.options.PipelineOptions.CheckEnabled-">setStableUniqueNames</a>, <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html#setTempLocation-java.lang.String-">setTempLocation</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.display.HasDisplayData"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.beam.sdk.transforms.display.<a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></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="getExecutorServiceFactory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExecutorServiceFactory</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Validation.Required.html" title="annotation in org.apache.beam.sdk.options">@Validation.Required</a> + <a href="../../../../../org/apache/beam/sdk/options/Hidden.html" title="annotation in org.apache.beam.sdk.options">@Hidden</a> + <a href="../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html" title="annotation in org.apache.beam.sdk.options">@Default.InstanceFactory</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html#value--">value</a>=org.apache.beam.runners.direct.FixedThreadPoolExecutorServiceFactory.class) +<a href="../../../../../org/apache/beam/runners/direct/ExecutorServiceFactory.html" title="interface in org.apache.beam.runners.direct">ExecutorServiceFactory</a> getExecutorServiceFactory()</pre> +<div class="block">Gets the <a href="../../../../../org/apache/beam/runners/direct/ExecutorServiceFactory.html" title="interface in org.apache.beam.runners.direct"><code>ExecutorServiceFactory</code></a> to use to create instances of <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true"; title="class or interface in java.util.concurrent"><code>ExecutorService</code></a> + to execute <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransforms</code></a>. + + <p>Note that <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true"; title="class or interface in java.util.concurrent"><code>ExecutorServices</code></a> returned by the factory must ensure that + it cannot enter a state in which it will not schedule additional pending work unless currently + scheduled work completes, as this may cause the <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> to cease processing. + + <p>Defaults to a <code>FixedThreadPoolExecutorServiceFactory</code>, which produces instances of + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/Executors.html?is-external=true#newCachedThreadPool--"; title="class or interface in java.util.concurrent"><code>Executors.newCachedThreadPool()</code></a>.</div> +</li> +</ul> +<a name="setExecutorServiceFactory-org.apache.beam.runners.direct.ExecutorServiceFactory-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExecutorServiceFactory</h4> +<pre>void setExecutorServiceFactory(<a href="../../../../../org/apache/beam/runners/direct/ExecutorServiceFactory.html" title="interface in org.apache.beam.runners.direct">ExecutorServiceFactory</a> executorService)</pre> +</li> +</ul> +<a name="getClock--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClock</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html" title="annotation in org.apache.beam.sdk.options">@Default.InstanceFactory</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.InstanceFactory.html#value--">value</a>=<a href="../../../../../org/apache/beam/runners/direct/NanosOffsetClock.Factory.html" title="class in org.apache.beam.runners.direct">NanosOffsetClock.Factory.class</a>) + <a href="../../../../../org/apache/beam/sdk/options/Validation.Required.html" title="annotation in org.apache.beam.sdk.options">@Validation.Required</a> + <a href="../../../../../org/apache/beam/sdk/options/Hidden.html" title="annotation in org.apache.beam.sdk.options">@Hidden</a> +<a href="../../../../../org/apache/beam/runners/direct/Clock.html" title="interface in org.apache.beam.runners.direct">Clock</a> getClock()</pre> +<div class="block">Gets the <a href="../../../../../org/apache/beam/runners/direct/Clock.html" title="interface in org.apache.beam.runners.direct"><code>Clock</code></a> used by this pipeline. The clock is used in place of accessing the + system time when time values are required by the evaluator.</div> +</li> +</ul> +<a name="setClock-org.apache.beam.runners.direct.Clock-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setClock</h4> +<pre>void setClock(<a href="../../../../../org/apache/beam/runners/direct/Clock.html" title="interface in org.apache.beam.runners.direct">Clock</a> clock)</pre> +</li> +</ul> +<a name="isShutdownUnboundedProducersWithMaxWatermark--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isShutdownUnboundedProducersWithMaxWatermark</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html" title="annotation in org.apache.beam.sdk.options">@Default.Boolean</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html#value--">value</a>=false) +boolean isShutdownUnboundedProducersWithMaxWatermark()</pre> +</li> +</ul> +<a name="setShutdownUnboundedProducersWithMaxWatermark-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setShutdownUnboundedProducersWithMaxWatermark</h4> +<pre>void setShutdownUnboundedProducersWithMaxWatermark(boolean shutdown)</pre> +</li> +</ul> +<a name="isBlockOnRun--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBlockOnRun</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html" title="annotation in org.apache.beam.sdk.options">@Default.Boolean</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html#value--">value</a>=true) +boolean isBlockOnRun()</pre> +</li> +</ul> +<a name="setBlockOnRun-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlockOnRun</h4> +<pre>void setBlockOnRun(boolean b)</pre> +</li> +</ul> +<a name="isTestImmutability--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isTestImmutability</h4> +<pre><a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html" title="annotation in org.apache.beam.sdk.options">@Default.Boolean</a>(<a href="../../../../../org/apache/beam/sdk/options/Default.Boolean.html#value--">value</a>=true) +boolean isTestImmutability()</pre> +</li> +</ul> +<a name="setTestImmutability-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setTestImmutability</h4> +<pre>void setTestImmutability(boolean test)</pre> +</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/InProcessPipelineOptions.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/direct/InProcessBundleOutputManager.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/InProcessPipelineOptions.html" target="_top">Frames</a></li> +<li><a href="InProcessPipelineOptions.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 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
