http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/SideInputHandler.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/SideInputHandler.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/SideInputHandler.html new file mode 100644 index 0000000..414f423 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/SideInputHandler.html @@ -0,0 +1,437 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_111) on Fri Jan 27 21:25:28 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SideInputHandler (Apache Beam SDK for Java, version 0.5.0)</title> +<meta name="date" content="2017-01-27"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SideInputHandler (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/SideInputHandler.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/ReduceFnRunner.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/SideInputHandler.html" target="_top">Frames</a></li> +<li><a href="SideInputHandler.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><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.core</div> +<h2 title="Class SideInputHandler" class="title">Class SideInputHandler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.SideInputHandler</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/ReadyCheckingSideInputReader.html" title="interface in org.apache.beam.sdk.util">ReadyCheckingSideInputReader</a>, <a href="../../../../../org/apache/beam/sdk/util/SideInputReader.html" title="interface in org.apache.beam.sdk.util">SideInputReader</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SideInputHandler</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/ReadyCheckingSideInputReader.html" title="interface in org.apache.beam.sdk.util">ReadyCheckingSideInputReader</a></pre> +<div class="block">Generic side input handler that uses <a href="../../../../../org/apache/beam/sdk/util/state/StateInternals.html" title="interface in org.apache.beam.sdk.util.state"><code>StateInternals</code></a> to store all data. Both the actual + side-input data and data about the windows for which we have side inputs available are stored + using <code>StateInternals</code>. + + <p>The given <code>StateInternals</code> must not be scoped to an element key. The state + must instead be scoped to one key group for which the side input is being managed. + + <p>This is useful for runners that transmit the side-input elements in band, as opposed + to how Dataflow has an external service for managing side inputs. + + <p>Note: storing the available windows in an extra state is redundant for now but in the + future we might want to know which windows we have available so that we can garbage collect + side input data. For now, this will never clean up side-input data because we have no way + of knowing when we reach the GC horizon.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <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/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SideInputHandler.html#sideInputs">sideInputs</a></span></code> +<div class="block">The list of side inputs that we're handling.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SideInputHandler.html#SideInputHandler-java.util.Collection-org.apache.beam.sdk.util.state.StateInternals-">SideInputHandler</a></span>(<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/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?>> sideInputs, + <a href="../../../../../org/apache/beam/sdk/util/state/StateInternals.html" title="interface in org.apache.beam.sdk.util.state">StateInternals</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>> stateInternals)</code> +<div class="block">Creates a new <code>SideInputHandler</code> for the given side inputs that uses + the given <code>StateInternals</code> to store side input data and side-input meta data.</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="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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SideInputHandler.html#addSideInputValue-org.apache.beam.sdk.values.PCollectionView-org.apache.beam.sdk.util.WindowedValue-">addSideInputValue</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?> sideInput, + <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><?>> value)</code> +<div class="block">Add the given value to the internal side-input store of the given side input.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><T> boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SideInputHandler.html#contains-org.apache.beam.sdk.values.PCollectionView-">contains</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><T> view)</code> +<div class="block">Returns true if the given <a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values"><code>PCollectionView</code></a> is valid for this reader.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><T> T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SideInputHandler.html#get-org.apache.beam.sdk.values.PCollectionView-org.apache.beam.sdk.transforms.windowing.BoundedWindow-">get</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><T> sideInput, + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a> window)</code> +<div class="block">Returns the value of the given <a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values"><code>PCollectionView</code></a> for the given <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>BoundedWindow</code></a>.</div> +</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/core/SideInputHandler.html#isEmpty--">isEmpty</a></span>()</code> +<div class="block">Returns true if there are no side inputs in this reader.</div> +</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/core/SideInputHandler.html#isReady-org.apache.beam.sdk.values.PCollectionView-org.apache.beam.sdk.transforms.windowing.BoundedWindow-">isReady</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?> sideInput, + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a> window)</code> +<div class="block">Returns true if the <a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values"><code>PCollectionView</code></a> is ready in the provided <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>BoundedWindow</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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="sideInputs"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>sideInputs</h4> +<pre>protected final <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/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?>> sideInputs</pre> +<div class="block">The list of side inputs that we're handling.</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="SideInputHandler-java.util.Collection-org.apache.beam.sdk.util.state.StateInternals-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SideInputHandler</h4> +<pre>public SideInputHandler(<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/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?>> sideInputs, + <a href="../../../../../org/apache/beam/sdk/util/state/StateInternals.html" title="interface in org.apache.beam.sdk.util.state">StateInternals</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>> stateInternals)</pre> +<div class="block">Creates a new <code>SideInputHandler</code> for the given side inputs that uses + the given <code>StateInternals</code> to store side input data and side-input meta data.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addSideInputValue-org.apache.beam.sdk.values.PCollectionView-org.apache.beam.sdk.util.WindowedValue-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSideInputValue</h4> +<pre>public void addSideInputValue(<a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?> sideInput, + <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><?>> value)</pre> +<div class="block">Add the given value to the internal side-input store of the given side input. This + might change the result of <a href="../../../../../org/apache/beam/runners/core/SideInputHandler.html#isReady-org.apache.beam.sdk.values.PCollectionView-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"><code>isReady(PCollectionView, BoundedWindow)</code></a> for that side + input.</div> +</li> +</ul> +<a name="get-org.apache.beam.sdk.values.PCollectionView-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</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 <T> T get(<a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><T> sideInput, + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a> window)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/util/SideInputReader.html#get-org.apache.beam.sdk.values.PCollectionView-org.apache.beam.sdk.transforms.windowing.BoundedWindow-">SideInputReader</a></code></span></div> +<div class="block">Returns the value of the given <a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values"><code>PCollectionView</code></a> for the given <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>BoundedWindow</code></a>. + + <p>It is valid for a side input to be <code>null</code>. It is <i>not</i> valid for this to + return <code>null</code> for any other reason.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/util/SideInputReader.html#get-org.apache.beam.sdk.values.PCollectionView-org.apache.beam.sdk.transforms.windowing.BoundedWindow-">get</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/util/SideInputReader.html" title="interface in org.apache.beam.sdk.util">SideInputReader</a></code></dd> +</dl> +</li> +</ul> +<a name="isReady-org.apache.beam.sdk.values.PCollectionView-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isReady</h4> +<pre>public boolean isReady(<a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?> sideInput, + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a> window)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/util/ReadyCheckingSideInputReader.html#isReady-org.apache.beam.sdk.values.PCollectionView-org.apache.beam.sdk.transforms.windowing.BoundedWindow-">ReadyCheckingSideInputReader</a></code></span></div> +<div class="block">Returns true if the <a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values"><code>PCollectionView</code></a> is ready in the provided <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>BoundedWindow</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/util/ReadyCheckingSideInputReader.html#isReady-org.apache.beam.sdk.values.PCollectionView-org.apache.beam.sdk.transforms.windowing.BoundedWindow-">isReady</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/util/ReadyCheckingSideInputReader.html" title="interface in org.apache.beam.sdk.util">ReadyCheckingSideInputReader</a></code></dd> +</dl> +</li> +</ul> +<a name="contains-org.apache.beam.sdk.values.PCollectionView-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contains</h4> +<pre>public <T> boolean contains(<a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><T> view)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/util/SideInputReader.html#contains-org.apache.beam.sdk.values.PCollectionView-">SideInputReader</a></code></span></div> +<div class="block">Returns true if the given <a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values"><code>PCollectionView</code></a> is valid for this reader.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/util/SideInputReader.html#contains-org.apache.beam.sdk.values.PCollectionView-">contains</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/util/SideInputReader.html" title="interface in org.apache.beam.sdk.util">SideInputReader</a></code></dd> +</dl> +</li> +</ul> +<a name="isEmpty--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public boolean isEmpty()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/util/SideInputReader.html#isEmpty--">SideInputReader</a></code></span></div> +<div class="block">Returns true if there are no side inputs in this reader.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/util/SideInputReader.html#isEmpty--">isEmpty</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/util/SideInputReader.html" title="interface in org.apache.beam.sdk.util">SideInputReader</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/SideInputHandler.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/ReduceFnRunner.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/SideInputHandler.html" target="_top">Frames</a></li> +<li><a href="SideInputHandler.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><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/SimpleDoFnRunner.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/SimpleDoFnRunner.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/SimpleDoFnRunner.html new file mode 100644 index 0000000..35aa972 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/SimpleDoFnRunner.html @@ -0,0 +1,387 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_111) on Fri Jan 27 21:25:28 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SimpleDoFnRunner (Apache Beam SDK for Java, version 0.5.0)</title> +<meta name="date" content="2017-01-27"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SimpleDoFnRunner (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/SimpleDoFnRunner.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/SideInputHandler.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/SimpleDoFnRunner.html" target="_top">Frames</a></li> +<li><a href="SimpleDoFnRunner.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.core</div> +<h2 title="Class SimpleDoFnRunner" class="title">Class SimpleDoFnRunner<InputT,OutputT></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.SimpleDoFnRunner<InputT,OutputT></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>InputT</code> - the type of the <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> (main) input elements</dd> +<dd><code>OutputT</code> - the type of the <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> (main) output elements</dd> +</dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/beam/runners/core/DoFnRunner.html" title="interface in org.apache.beam.runners.core">DoFnRunner</a><InputT,OutputT></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SimpleDoFnRunner<InputT,OutputT></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/runners/core/DoFnRunner.html" title="interface in org.apache.beam.runners.core">DoFnRunner</a><InputT,OutputT></pre> +<div class="block">Runs a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> by constructing the appropriate contexts and passing them in. + + <p>Also, if the <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> observes the window of the element, then <a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="class in org.apache.beam.runners.core"><code>SimpleDoFnRunner</code></a> + explodes windows of the input <a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util"><code>WindowedValue</code></a> and calls <code>DoFn.ProcessElement</code> for + each window individually.</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/core/SimpleDoFnRunner.html#SimpleDoFnRunner-org.apache.beam.sdk.options.PipelineOptions-org.apache.beam.sdk.transforms.DoFn-org.apache.beam.sdk.util.SideInputReader-org.apache.beam.runners.core.DoFnRunners.OutputManager-org.apache.beam.sdk.values.TupleTag-java.util.List-org.apache.beam.runners.core.ExecutionContext.StepContext-org.apache.beam.runners.core.AggregatorFactory-org.apache.beam.sdk.util.WindowingStrategy-">SimpleDoFnRunner</a></span>(<a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options, + <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a><<a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">OutputT</a>> fn, + <a href="../../../../../org/apache/beam/sdk/util/SideInputReader.html" title="interface in org.apache.beam.sdk.util">SideInputReader</a> sideInputReader, + <a href="../../../../../org/apache/beam/runners/core/DoFnRunners.OutputManager.html" title="interface in org.apache.beam.runners.core">DoFnRunners.OutputManager</a> outputManager, + <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/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">OutputT</a>> mainOutputTag, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>> sideOutputTags, + <a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core">ExecutionContext.StepContext</a> stepContext, + <a href="../../../../../org/apache/beam/runners/core/AggregatorFactory.html" title="interface in org.apache.beam.runners.core">AggregatorFactory</a> aggregatorFactory, + <a href="../../../../../org/apache/beam/sdk/util/WindowingStrategy.html" title="class in org.apache.beam.sdk.util">WindowingStrategy</a><?,?> windowingStrategy)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html#finishBundle--">finishBundle</a></span>()</code> +<div class="block">Calls a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn's</code></a> <code>@FinishBundle</code> method and performs + additional tasks, such as flushing in-memory states.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html#onTimer-java.lang.String-org.apache.beam.sdk.transforms.windowing.BoundedWindow-org.joda.time.Instant-org.apache.beam.sdk.util.TimeDomain-">onTimer</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> timerId, + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a> window, + org.joda.time.Instant timestamp, + <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html" title="enum in org.apache.beam.sdk.util">TimeDomain</a> timeDomain)</code> +<div class="block">Calls a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn's</code></a> <code>@OnTimer</code> method for the given timer + in the given window.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html#processElement-org.apache.beam.sdk.util.WindowedValue-">processElement</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/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">InputT</a>> compressedElem)</code> +<div class="block">Calls a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn's</code></a> <code>@ProcessElement</code> method with a + <code>DoFn.ProcessContext</code> containing the provided element.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html#startBundle--">startBundle</a></span>()</code> +<div class="block">Prepares and calls a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn's</code></a> <code>@StartBundle</code> method.</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="SimpleDoFnRunner-org.apache.beam.sdk.options.PipelineOptions-org.apache.beam.sdk.transforms.DoFn-org.apache.beam.sdk.util.SideInputReader-org.apache.beam.runners.core.DoFnRunners.OutputManager-org.apache.beam.sdk.values.TupleTag-java.util.List-org.apache.beam.runners.core.ExecutionContext.StepContext-org.apache.beam.runners.core.AggregatorFactory-org.apache.beam.sdk.util.WindowingStrategy-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SimpleDoFnRunner</h4> +<pre>public SimpleDoFnRunner(<a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options, + <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a><<a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">OutputT</a>> fn, + <a href="../../../../../org/apache/beam/sdk/util/SideInputReader.html" title="interface in org.apache.beam.sdk.util">SideInputReader</a> sideInputReader, + <a href="../../../../../org/apache/beam/runners/core/DoFnRunners.OutputManager.html" title="interface in org.apache.beam.runners.core">DoFnRunners.OutputManager</a> outputManager, + <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/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">OutputT</a>> mainOutputTag, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><?>> sideOutputTags, + <a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core">ExecutionContext.StepContext</a> stepContext, + <a href="../../../../../org/apache/beam/runners/core/AggregatorFactory.html" title="interface in org.apache.beam.runners.core">AggregatorFactory</a> aggregatorFactory, + <a href="../../../../../org/apache/beam/sdk/util/WindowingStrategy.html" title="class in org.apache.beam.sdk.util">WindowingStrategy</a><?,?> windowingStrategy)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="startBundle--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startBundle</h4> +<pre>public void startBundle()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/runners/core/DoFnRunner.html#startBundle--">DoFnRunner</a></code></span></div> +<div class="block">Prepares and calls a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn's</code></a> <code>@StartBundle</code> method.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/runners/core/DoFnRunner.html#startBundle--">startBundle</a></code> in interface <code><a href="../../../../../org/apache/beam/runners/core/DoFnRunner.html" title="interface in org.apache.beam.runners.core">DoFnRunner</a><<a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">OutputT</a>></code></dd> +</dl> +</li> +</ul> +<a name="processElement-org.apache.beam.sdk.util.WindowedValue-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processElement</h4> +<pre>public void processElement(<a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><<a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">InputT</a>> compressedElem)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/runners/core/DoFnRunner.html#processElement-org.apache.beam.sdk.util.WindowedValue-">DoFnRunner</a></code></span></div> +<div class="block">Calls a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn's</code></a> <code>@ProcessElement</code> method with a + <code>DoFn.ProcessContext</code> containing the provided element.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/runners/core/DoFnRunner.html#processElement-org.apache.beam.sdk.util.WindowedValue-">processElement</a></code> in interface <code><a href="../../../../../org/apache/beam/runners/core/DoFnRunner.html" title="interface in org.apache.beam.runners.core">DoFnRunner</a><<a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">OutputT</a>></code></dd> +</dl> +</li> +</ul> +<a name="onTimer-java.lang.String-org.apache.beam.sdk.transforms.windowing.BoundedWindow-org.joda.time.Instant-org.apache.beam.sdk.util.TimeDomain-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onTimer</h4> +<pre>public void onTimer(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> timerId, + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a> window, + org.joda.time.Instant timestamp, + <a href="../../../../../org/apache/beam/sdk/util/TimeDomain.html" title="enum in org.apache.beam.sdk.util">TimeDomain</a> timeDomain)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/runners/core/DoFnRunner.html#onTimer-java.lang.String-org.apache.beam.sdk.transforms.windowing.BoundedWindow-org.joda.time.Instant-org.apache.beam.sdk.util.TimeDomain-">DoFnRunner</a></code></span></div> +<div class="block">Calls a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn's</code></a> <code>@OnTimer</code> method for the given timer + in the given window.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/runners/core/DoFnRunner.html#onTimer-java.lang.String-org.apache.beam.sdk.transforms.windowing.BoundedWindow-org.joda.time.Instant-org.apache.beam.sdk.util.TimeDomain-">onTimer</a></code> in interface <code><a href="../../../../../org/apache/beam/runners/core/DoFnRunner.html" title="interface in org.apache.beam.runners.core">DoFnRunner</a><<a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">OutputT</a>></code></dd> +</dl> +</li> +</ul> +<a name="finishBundle--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>finishBundle</h4> +<pre>public void finishBundle()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/runners/core/DoFnRunner.html#finishBundle--">DoFnRunner</a></code></span></div> +<div class="block">Calls a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn's</code></a> <code>@FinishBundle</code> method and performs + additional tasks, such as flushing in-memory states.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/runners/core/DoFnRunner.html#finishBundle--">finishBundle</a></code> in interface <code><a href="../../../../../org/apache/beam/runners/core/DoFnRunner.html" title="interface in org.apache.beam.runners.core">DoFnRunner</a><<a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SimpleDoFnRunner.html" title="type parameter in SimpleDoFnRunner">OutputT</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/SimpleDoFnRunner.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/SideInputHandler.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/SimpleDoFnRunner.html" target="_top">Frames</a></li> +<li><a href="SimpleDoFnRunner.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html new file mode 100644 index 0000000..8af71b9 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html @@ -0,0 +1,333 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_111) on Fri Jan 27 21:25:28 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SplittableParDo.GBKIntoKeyedWorkItems (Apache Beam SDK for Java, version 0.5.0)</title> +<meta name="date" content="2017-01-27"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SplittableParDo.GBKIntoKeyedWorkItems (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/SplittableParDo.GBKIntoKeyedWorkItems.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/SplittableParDo.ProcessElements.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html" target="_top">Frames</a></li> +<li><a href="SplittableParDo.GBKIntoKeyedWorkItems.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><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.core</div> +<h2 title="Class SplittableParDo.GBKIntoKeyedWorkItems" class="title">Class SplittableParDo.GBKIntoKeyedWorkItems<KeyT,InputT></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.PTransform</a><<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><KeyT,InputT>>,<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><KeyT,InputT>>></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.SplittableParDo.GBKIntoKeyedWorkItems<KeyT,InputT></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="class in org.apache.beam.runners.core">SplittableParDo</a><<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="type parameter in SplittableParDo">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="type parameter in SplittableParDo">OutputT</a>,<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="type parameter in SplittableParDo">RestrictionT</a>></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">SplittableParDo.GBKIntoKeyedWorkItems<KeyT,InputT></span> +extends <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><KeyT,InputT>>,<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><KeyT,InputT>>></pre> +<div class="block">Runner-specific primitive <a href="../../../../../org/apache/beam/sdk/transforms/GroupByKey.html" title="class in org.apache.beam.sdk.transforms"><code>GroupByKey-like</code></a> <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> that produces + <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><code>KeyedWorkItems</code></a> so that downstream transforms can access state and timers. + + <p>Unlike a real <a href="../../../../../org/apache/beam/sdk/transforms/GroupByKey.html" title="class in org.apache.beam.sdk.transforms"><code>GroupByKey</code></a>, ignores the input's windowing and triggering strategy and + emits output immediately.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.core.SplittableParDo.GBKIntoKeyedWorkItems">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#name">name</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html#GBKIntoKeyedWorkItems--">GBKIntoKeyedWorkItems</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html" title="type parameter in SplittableParDo.GBKIntoKeyedWorkItems">KeyT</a>,<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html" title="type parameter in SplittableParDo.GBKIntoKeyedWorkItems">InputT</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html#expand-org.apache.beam.sdk.values.PCollection-">expand</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html" title="type parameter in SplittableParDo.GBKIntoKeyedWorkItems">KeyT</a>,<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html" title="type parameter in SplittableParDo.GBKIntoKeyedWorkItems">InputT</a>>> input)</code> +<div class="block">Applies this <code>PTransform</code> on the given <code>InputT</code>, and returns its + <code>Output</code>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder--">getDefaultOutputCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-">getDefaultOutputCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.TypedPValue-">getDefaultOutputCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getKindString--">getKindString</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--">getName</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#toString--">toString</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-InputT-">valida te</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="GBKIntoKeyedWorkItems--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GBKIntoKeyedWorkItems</h4> +<pre>public GBKIntoKeyedWorkItems()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="expand-org.apache.beam.sdk.values.PCollection-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>expand</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html" title="type parameter in SplittableParDo.GBKIntoKeyedWorkItems">KeyT</a>,<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html" title="type parameter in SplittableParDo.GBKIntoKeyedWorkItems">InputT</a>>> expand(<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html" title="type parameter in SplittableParDo.GBKIntoKeyedWorkItems">KeyT</a>,<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html" title="type parameter in SplittableParDo.GBKIntoKeyedWorkItems">InputT</a>>> input)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">PTransform</a></code></span></div> +<div class="block">Applies this <code>PTransform</code> on the given <code>InputT</code>, and returns its + <code>Output</code>. + + <p>Composite transforms, which are defined in terms of other transforms, + should return the output of one of the composed transforms. Non-composite + transforms, which do not apply any transforms internally, should return + a new unbound output and register evaluators (via backend-specific + registration methods).</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">expand</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html" title="type parameter in SplittableParDo.GBKIntoKeyedWorkItems">KeyT</a>,<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html" title="type parameter in SplittableParDo.GBKIntoKeyedWorkItems">InputT</a>>>,<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollectio n</a><<a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core">KeyedWorkItem</a><<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html" title="type parameter in SplittableParDo.GBKIntoKeyedWorkItems">KeyT</a>,<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html" title="type parameter in SplittableParDo.GBKIntoKeyedWorkItems">InputT</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/SplittableParDo.GBKIntoKeyedWorkItems.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/SplittableParDo.ProcessElements.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/SplittableParDo.GBKIntoKeyedWorkItems.html" target="_top">Frames</a></li> +<li><a href="SplittableParDo.GBKIntoKeyedWorkItems.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><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
