http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/6fce44a2/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessTimerInternals.html ---------------------------------------------------------------------- diff --git a/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessTimerInternals.html b/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessTimerInternals.html new file mode 100644 index 0000000..bb54a04 --- /dev/null +++ b/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessTimerInternals.html @@ -0,0 +1,467 @@ +<!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>InProcessTimerInternals (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="InProcessTimerInternals (Apache Beam SDK for Java 0.1.0-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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/InProcessTimerInternals.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/InProcessRegistrar.InProcessRunner.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/InProcessTransformResult.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/InProcessTimerInternals.html" target="_top">Frames</a></li> +<li><a href="InProcessTimerInternals.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="Class InProcessTimerInternals" class="title">Class InProcessTimerInternals</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.InProcessTimerInternals</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">InProcessTimerInternals</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">An implementation of <a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util"><code>TimerInternals</code></a> where all relevant data exists 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> +<!-- ========== 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/InProcessTimerInternals.html" title="class in org.apache.beam.runners.direct">InProcessTimerInternals</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessTimerInternals.html#create-org.apache.beam.runners.direct.Clock-org.apache.beam.runners.direct.InMemoryWatermarkManager.TransformWatermarks-org.apache.beam.runners.direct.InMemoryWatermarkManager.TimerUpdate.TimerUpdateBuilder-">create</a></span>(<a href="../../../../../org/apache/beam/runners/direct/Clock.html" title="interface in org.apache.beam.runners.direct">Clock</a> clock, + <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.TransformWatermarks.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.TransformWatermarks</a> watermarks, + <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.TimerUpdate.TimerUpdateBuilder.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.TimerUpdate.TimerUpdateBuilder</a> timerUpdateBuilder)</code> </td> +</tr> +<tr id="i1" 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/direct/InProcessTimerInternals.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="i2" 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/direct/InProcessTimerInternals.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="i3" 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/direct/InProcessTimerInternals.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="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/direct/InProcessTimerInternals.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="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessTimerInternals.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> timerKey)</code> +<div class="block">Deletes the given timer.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.TimerUpdate</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessTimerInternals.html#getTimerUpdate--">getTimerUpdate</a></span>()</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/InProcessTimerInternals.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> timerKey)</code> +<div class="block">Writes out a timer to be fired when the watermark reaches the given + timestamp.</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-org.apache.beam.runners.direct.InMemoryWatermarkManager.TransformWatermarks-org.apache.beam.runners.direct.InMemoryWatermarkManager.TimerUpdate.TimerUpdateBuilder-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../../org/apache/beam/runners/direct/InProcessTimerInternals.html" title="class in org.apache.beam.runners.direct">InProcessTimerInternals</a> create(<a href="../../../../../org/apache/beam/runners/direct/Clock.html" title="interface in org.apache.beam.runners.direct">Clock</a> clock, + <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.TransformWatermarks.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.TransformWatermarks</a> watermarks, + <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.TimerUpdate.TimerUpdateBuilder.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.TimerUpdate.TimerUpdateBuilder</a> timerUpdateBuilder)</pre> +</li> +</ul> +<a name="setTimer-org.apache.beam.sdk.util.TimerInternals.TimerData-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTimer</h4> +<pre>public void setTimer(<a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a> timerKey)</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.TimerInternals.TimerData-">TimerInternals</a></code></span></div> +<div class="block">Writes out a timer to be fired when the watermark reaches the given + timestamp. + + <p>The combination of <code>namespace</code>, <code>timestamp</code> and <code>domain</code> uniquely + identify a timer. Multiple timers set for the same parameters can be safely deduplicated.</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.TimerInternals.TimerData-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteTimer</h4> +<pre>public void deleteTimer(<a href="../../../../../org/apache/beam/sdk/util/TimerInternals.TimerData.html" title="class in org.apache.beam.sdk.util">TimerInternals.TimerData</a> timerKey)</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.TimerInternals.TimerData-">TimerInternals</a></code></span></div> +<div class="block">Deletes the given timer.</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="getTimerUpdate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTimerUpdate</h4> +<pre>public <a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.TimerUpdate</a> getTimerUpdate()</pre> +</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="currentOutputWatermarkTime--"> +<!-- --> +</a> +<ul class="blockListLast"> +<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> + | | | | | + | | D | C | B | A + | | | | | + GIWM <= GOWM <= LOWM <= LIWM <= GIWM + (next stage) + -------------------------------------------------> event time + </pre> + 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> +</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/InProcessTimerInternals.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/InProcessRegistrar.InProcessRunner.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/InProcessTransformResult.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/InProcessTimerInternals.html" target="_top">Frames</a></li> +<li><a href="InProcessTimerInternals.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>
http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/6fce44a2/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessTransformResult.html ---------------------------------------------------------------------- diff --git a/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessTransformResult.html b/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessTransformResult.html new file mode 100644 index 0000000..4d41674 --- /dev/null +++ b/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/InProcessTransformResult.html @@ -0,0 +1,343 @@ +<!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>InProcessTransformResult (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="InProcessTransformResult (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}; +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/InProcessTransformResult.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/InProcessTimerInternals.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/ModelEnforcement.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/InProcessTransformResult.html" target="_top">Frames</a></li> +<li><a href="InProcessTransformResult.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 InProcessTransformResult" class="title">Interface InProcessTransformResult</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/beam/runners/direct/StepTransformResult.html" title="class in org.apache.beam.runners.direct">StepTransformResult</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">InProcessTransformResult</span></pre> +<div class="block">The result of evaluating an <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a> with a <a href="../../../../../org/apache/beam/runners/direct/TransformEvaluator.html" title="interface in org.apache.beam.runners.direct"><code>TransformEvaluator</code></a>.</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="../../../../../org/apache/beam/sdk/util/common/CounterSet.html" title="class in org.apache.beam.sdk.util.common">CounterSet</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessTransformResult.html#getCounters--">getCounters</a></span>()</code> +<div class="block">Returns the <a href="../../../../../org/apache/beam/sdk/util/common/CounterSet.html" title="class in org.apache.beam.sdk.util.common"><code>CounterSet</code></a> used by this <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>, or null if this transform did + not use a <a href="../../../../../org/apache/beam/sdk/util/common/CounterSet.html" title="class in org.apache.beam.sdk.util.common"><code>CounterSet</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/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><? extends <a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.UncommittedBundle.html" title="interface in org.apache.beam.runners.direct">InProcessPipelineRunner.UncommittedBundle</a><?>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessTransformResult.html#getOutputBundles--">getOutputBundles</a></span>()</code> +<div class="block">Returns the <a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.UncommittedBundle.html" title="interface in org.apache.beam.runners.direct"><code>(uncommitted) Bundles</code></a> output by this transform.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/util/state/CopyOnAccessInMemoryStateInternals.html" title="class in org.apache.beam.sdk.util.state">CopyOnAccessInMemoryStateInternals</a><?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessTransformResult.html#getState--">getState</a></span>()</code> +<div class="block">Returns the State used by the transform.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.TimerUpdate</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessTransformResult.html#getTimerUpdate--">getTimerUpdate</a></span>()</code> +<div class="block">Returns a TimerUpdateBuilder that was produced as a result of this evaluation.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><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/InProcessTransformResult.html#getTransform--">getTransform</a></span>()</code> +<div class="block">Returns the <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a> that produced this result.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<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><? extends <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><?>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/InProcessTransformResult.html#getUnprocessedElements--">getUnprocessedElements</a></span>()</code> +<div class="block">Returns elements that were provided to the <a href="../../../../../org/apache/beam/runners/direct/TransformEvaluator.html" title="interface in org.apache.beam.runners.direct"><code>TransformEvaluator</code></a> as input but were not + processed.</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/direct/InProcessTransformResult.html#getWatermarkHold--">getWatermarkHold</a></span>()</code> +<div class="block">Returns the Watermark Hold for the transform at the time this result was produced.</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="getTransform--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransform</h4> +<pre><a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms">AppliedPTransform</a><?,?,?> getTransform()</pre> +<div class="block">Returns the <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a> that produced this result.</div> +</li> +</ul> +<a name="getOutputBundles--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOutputBundles</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><? extends <a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.UncommittedBundle.html" title="interface in org.apache.beam.runners.direct">InProcessPipelineRunner.UncommittedBundle</a><?>> getOutputBundles()</pre> +<div class="block">Returns the <a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.UncommittedBundle.html" title="interface in org.apache.beam.runners.direct"><code>(uncommitted) Bundles</code></a> output by this transform. These + will be committed by the evaluation context as part of completing this result.</div> +</li> +</ul> +<a name="getUnprocessedElements--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUnprocessedElements</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><? extends <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><?>> getUnprocessedElements()</pre> +<div class="block">Returns elements that were provided to the <a href="../../../../../org/apache/beam/runners/direct/TransformEvaluator.html" title="interface in org.apache.beam.runners.direct"><code>TransformEvaluator</code></a> as input but were not + processed.</div> +</li> +</ul> +<a name="getCounters--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCounters</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> +<a href="../../../../../org/apache/beam/sdk/util/common/CounterSet.html" title="class in org.apache.beam.sdk.util.common">CounterSet</a> getCounters()</pre> +<div class="block">Returns the <a href="../../../../../org/apache/beam/sdk/util/common/CounterSet.html" title="class in org.apache.beam.sdk.util.common"><code>CounterSet</code></a> used by this <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>, or null if this transform did + not use a <a href="../../../../../org/apache/beam/sdk/util/common/CounterSet.html" title="class in org.apache.beam.sdk.util.common"><code>CounterSet</code></a>.</div> +</li> +</ul> +<a name="getWatermarkHold--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWatermarkHold</h4> +<pre>org.joda.time.Instant getWatermarkHold()</pre> +<div class="block">Returns the Watermark Hold for the transform at the time this result was produced. + + If the transform does not set any watermark hold, returns + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html#TIMESTAMP_MAX_VALUE"><code>BoundedWindow.TIMESTAMP_MAX_VALUE</code></a>.</div> +</li> +</ul> +<a name="getState--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getState</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> +<a href="../../../../../org/apache/beam/sdk/util/state/CopyOnAccessInMemoryStateInternals.html" title="class in org.apache.beam.sdk.util.state">CopyOnAccessInMemoryStateInternals</a><?> getState()</pre> +<div class="block">Returns the State used by the transform. + + If this evaluation did not access state, this may return null.</div> +</li> +</ul> +<a name="getTimerUpdate--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTimerUpdate</h4> +<pre><a href="../../../../../org/apache/beam/runners/direct/InMemoryWatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">InMemoryWatermarkManager.TimerUpdate</a> getTimerUpdate()</pre> +<div class="block">Returns a TimerUpdateBuilder that was produced as a result of this evaluation. If the + evaluation was triggered due to the delivery of one or more timers, those timers must be added + to the builder before it is complete. + + <p>If this evaluation did not add or remove any timers, returns an empty TimerUpdate.</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/InProcessTransformResult.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/InProcessTimerInternals.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/ModelEnforcement.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/InProcessTransformResult.html" target="_top">Frames</a></li> +<li><a href="InProcessTransformResult.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> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/6fce44a2/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/ModelEnforcement.html ---------------------------------------------------------------------- diff --git a/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/ModelEnforcement.html b/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/ModelEnforcement.html new file mode 100644 index 0000000..7f518e2 --- /dev/null +++ b/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/ModelEnforcement.html @@ -0,0 +1,283 @@ +<!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>ModelEnforcement (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="ModelEnforcement (Apache Beam SDK for Java 0.1.0-incubating API)"; + } + } + 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/ModelEnforcement.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/InProcessTransformResult.html" title="interface in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/ModelEnforcementFactory.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/ModelEnforcement.html" target="_top">Frames</a></li> +<li><a href="ModelEnforcement.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 ModelEnforcement" class="title">Interface ModelEnforcement<T></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ModelEnforcement<T></span></pre> +<div class="block">Enforcement tools that verify that executing code conforms to the model. + + <p>ModelEnforcement is performed on a per-element and per-bundle basis. The + <a href="../../../../../org/apache/beam/runners/direct/ModelEnforcement.html" title="interface in org.apache.beam.runners.direct"><code>ModelEnforcement</code></a> is provided with the input bundle as part of + <code>ModelEnforcementFactory#forBundle(CommittedBundle, AppliedPTransform)</code>, each element + before and after that element is provided to an underlying <a href="../../../../../org/apache/beam/runners/direct/TransformEvaluator.html" title="interface in org.apache.beam.runners.direct"><code>TransformEvaluator</code></a>, and the + output <a href="../../../../../org/apache/beam/runners/direct/InProcessTransformResult.html" title="interface in org.apache.beam.runners.direct"><code>InProcessTransformResult</code></a> and committed output bundles after the + <a href="../../../../../org/apache/beam/runners/direct/TransformEvaluator.html" title="interface in org.apache.beam.runners.direct"><code>TransformEvaluator</code></a> has completed. + + <p>Typically, <a href="../../../../../org/apache/beam/runners/direct/ModelEnforcement.html" title="interface in org.apache.beam.runners.direct"><code>ModelEnforcement</code></a> will obtain required metadata (such as the <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders"><code>Coder</code></a> + of the input <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> on construction, and then enforce per-element behavior + (such as the immutability of input elements). When the element is output or the bundle is + completed, the required conditions can be enforced across all elements.</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/ModelEnforcement.html#afterElement-org.apache.beam.sdk.util.WindowedValue-">afterElement</a></span>(<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/direct/ModelEnforcement.html" title="type parameter in ModelEnforcement">T</a>> element)</code> +<div class="block">Called after a call to <a href="../../../../../org/apache/beam/runners/direct/TransformEvaluator.html#processElement-org.apache.beam.sdk.util.WindowedValue-"><code>TransformEvaluator.processElement(WindowedValue)</code></a> on the + provided <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util"><code>WindowedValue</code></a>.</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/direct/ModelEnforcement.html#afterFinish-org.apache.beam.runners.direct.InProcessPipelineRunner.CommittedBundle-org.apache.beam.runners.direct.InProcessTransformResult-java.lang.Iterable-">afterFinish</a></span>(<a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.CommittedBundle.html" title="interface in org.apache.beam.runners.direct">InProcessPipelineRunner.CommittedBundle</a><<a href="../../../../../org/apache/beam/runners/direct/ModelEnforcement.html" title="type parameter in ModelEnforcement">T</a>> input, + <a href="../../../../../org/apache/beam/runners/direct/InProcessTransformResult.html" title="interface in org.apache.beam.runners.direct">InProcessTransformResult</a> result, + <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><? extends <a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.CommittedBundle.html" title="interface in org.apache.beam.runners.direct">InProcessPipelineRunner.CommittedBundle</a><?>> outputs)</code> +<div class="block">Called after a bundle has been completed and <a href="../../../../../org/apache/beam/runners/direct/TransformEvaluator.html#finishBundle--"><code>TransformEvaluator.finishBundle()</code></a> has been + called, producing the provided <a href="../../../../../org/apache/beam/runners/direct/InProcessTransformResult.html" title="interface in org.apache.beam.runners.direct"><code>InProcessTransformResult</code></a> and + <a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.CommittedBundle.html" title="interface in org.apache.beam.runners.direct"><code>output bundles</code></a>.</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/direct/ModelEnforcement.html#beforeElement-org.apache.beam.sdk.util.WindowedValue-">beforeElement</a></span>(<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/direct/ModelEnforcement.html" title="type parameter in ModelEnforcement">T</a>> element)</code> +<div class="block">Called before a call to <a href="../../../../../org/apache/beam/runners/direct/TransformEvaluator.html#processElement-org.apache.beam.sdk.util.WindowedValue-"><code>TransformEvaluator.processElement(WindowedValue)</code></a> on the + provided <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util"><code>WindowedValue</code></a>.</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="beforeElement-org.apache.beam.sdk.util.WindowedValue-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeElement</h4> +<pre>void beforeElement(<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/direct/ModelEnforcement.html" title="type parameter in ModelEnforcement">T</a>> element)</pre> +<div class="block">Called before a call to <a href="../../../../../org/apache/beam/runners/direct/TransformEvaluator.html#processElement-org.apache.beam.sdk.util.WindowedValue-"><code>TransformEvaluator.processElement(WindowedValue)</code></a> on the + provided <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util"><code>WindowedValue</code></a>.</div> +</li> +</ul> +<a name="afterElement-org.apache.beam.sdk.util.WindowedValue-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterElement</h4> +<pre>void afterElement(<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/direct/ModelEnforcement.html" title="type parameter in ModelEnforcement">T</a>> element)</pre> +<div class="block">Called after a call to <a href="../../../../../org/apache/beam/runners/direct/TransformEvaluator.html#processElement-org.apache.beam.sdk.util.WindowedValue-"><code>TransformEvaluator.processElement(WindowedValue)</code></a> on the + provided <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util"><code>WindowedValue</code></a>.</div> +</li> +</ul> +<a name="afterFinish-org.apache.beam.runners.direct.InProcessPipelineRunner.CommittedBundle-org.apache.beam.runners.direct.InProcessTransformResult-java.lang.Iterable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>afterFinish</h4> +<pre>void afterFinish(<a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.CommittedBundle.html" title="interface in org.apache.beam.runners.direct">InProcessPipelineRunner.CommittedBundle</a><<a href="../../../../../org/apache/beam/runners/direct/ModelEnforcement.html" title="type parameter in ModelEnforcement">T</a>> input, + <a href="../../../../../org/apache/beam/runners/direct/InProcessTransformResult.html" title="interface in org.apache.beam.runners.direct">InProcessTransformResult</a> result, + <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><? extends <a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.CommittedBundle.html" title="interface in org.apache.beam.runners.direct">InProcessPipelineRunner.CommittedBundle</a><?>> outputs)</pre> +<div class="block">Called after a bundle has been completed and <a href="../../../../../org/apache/beam/runners/direct/TransformEvaluator.html#finishBundle--"><code>TransformEvaluator.finishBundle()</code></a> has been + called, producing the provided <a href="../../../../../org/apache/beam/runners/direct/InProcessTransformResult.html" title="interface in org.apache.beam.runners.direct"><code>InProcessTransformResult</code></a> and + <a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.CommittedBundle.html" title="interface in org.apache.beam.runners.direct"><code>output bundles</code></a>.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ModelEnforcement.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/InProcessTransformResult.html" title="interface in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/ModelEnforcementFactory.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/ModelEnforcement.html" target="_top">Frames</a></li> +<li><a href="ModelEnforcement.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> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/6fce44a2/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/ModelEnforcementFactory.html ---------------------------------------------------------------------- diff --git a/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/ModelEnforcementFactory.html b/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/ModelEnforcementFactory.html new file mode 100644 index 0000000..d118ea3 --- /dev/null +++ b/content/javadoc/0.1.0-incubating/org/apache/beam/runners/direct/ModelEnforcementFactory.html @@ -0,0 +1,228 @@ +<!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>ModelEnforcementFactory (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="ModelEnforcementFactory (Apache Beam SDK for Java 0.1.0-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/ModelEnforcementFactory.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/ModelEnforcement.html" title="interface in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/NanosOffsetClock.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/ModelEnforcementFactory.html" target="_top">Frames</a></li> +<li><a href="ModelEnforcementFactory.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 ModelEnforcementFactory" class="title">Interface ModelEnforcementFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ModelEnforcementFactory</span></pre> +<div class="block">Creates <a href="../../../../../org/apache/beam/runners/direct/ModelEnforcement.html" title="interface in org.apache.beam.runners.direct"><code>ModelEnforcement</code></a> instances for an <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms"><code>AppliedPTransform</code></a> on an input + <a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.CommittedBundle.html" title="interface in org.apache.beam.runners.direct"><code>bundle</code></a>. <a href="../../../../../org/apache/beam/runners/direct/ModelEnforcement.html" title="interface in org.apache.beam.runners.direct"><code>ModelEnforcement</code></a> instances are created before the + <a href="../../../../../org/apache/beam/runners/direct/TransformEvaluator.html" title="interface in org.apache.beam.runners.direct"><code>TransformEvaluator</code></a> is created.</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><T> <a href="../../../../../org/apache/beam/runners/direct/ModelEnforcement.html" title="interface in org.apache.beam.runners.direct">ModelEnforcement</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/ModelEnforcementFactory.html#forBundle-org.apache.beam.runners.direct.InProcessPipelineRunner.CommittedBundle-org.apache.beam.sdk.transforms.AppliedPTransform-">forBundle</a></span>(<a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.CommittedBundle.html" title="interface in org.apache.beam.runners.direct">InProcessPipelineRunner.CommittedBundle</a><T> input, + <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms">AppliedPTransform</a><?,?,?> consumer)</code> </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="forBundle-org.apache.beam.runners.direct.InProcessPipelineRunner.CommittedBundle-org.apache.beam.sdk.transforms.AppliedPTransform-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>forBundle</h4> +<pre><T> <a href="../../../../../org/apache/beam/runners/direct/ModelEnforcement.html" title="interface in org.apache.beam.runners.direct">ModelEnforcement</a><T> forBundle(<a href="../../../../../org/apache/beam/runners/direct/InProcessPipelineRunner.CommittedBundle.html" title="interface in org.apache.beam.runners.direct">InProcessPipelineRunner.CommittedBundle</a><T> input, + <a href="../../../../../org/apache/beam/sdk/transforms/AppliedPTransform.html" title="class in org.apache.beam.sdk.transforms">AppliedPTransform</a><?,?,?> consumer)</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/ModelEnforcementFactory.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/ModelEnforcement.html" title="interface in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/NanosOffsetClock.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/ModelEnforcementFactory.html" target="_top">Frames</a></li> +<li><a href="ModelEnforcementFactory.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>
