http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/141627ec/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html ---------------------------------------------------------------------- diff --git a/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html new file mode 100644 index 0000000..01e98af --- /dev/null +++ b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html @@ -0,0 +1,540 @@ +<!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_102) on Mon Oct 31 14:28:39 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DataflowPipelineTranslator.TranslationContext (Apache Beam SDK for Java, version 0.3.0-incubating)</title> +<meta name="date" content="2016-10-31"> +<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="DataflowPipelineTranslator.TranslationContext (Apache Beam SDK for Java, version 0.3.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":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/DataflowPipelineTranslator.TranslationContext.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/dataflow/DataflowPipelineTranslator.TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html" target="_top">Frames</a></li> +<li><a href="DataflowPipelineTranslator.TranslationContext.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.dataflow</div> +<h2 title="Interface DataflowPipelineTranslator.TranslationContext" class="title">Interface DataflowPipelineTranslator.TranslationContext</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineTranslator</a></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="typeNameLabel">DataflowPipelineTranslator.TranslationContext</span></pre> +<div class="block">The interface provided to registered callbacks for interacting + with the <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowRunner</code></a>, including reading and writing the + values of <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>s and side inputs (<a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values"><code>PCollectionView</code></a>s).</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>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html#addCollectionToSingletonOutput-org.apache.beam.sdk.values.PValue-org.apache.beam.sdk.values.PValue-">addCollectionToSingletonOutput</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a> inputValue, + <a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a> outputValue)</code> +<div class="block">Adds an output to the previously added CollectionToSingleton Dataflow step, + consuming the specified input <code>PValue</code> and producing the specified output + <code>PValue</code>.</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/dataflow/DataflowPipelineTranslator.TranslationContext.html#addEncodingInput-org.apache.beam.sdk.coders.Coder-">addEncodingInput</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><?> value)</code> +<div class="block">Sets the encoding for the current Dataflow step.</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/dataflow/DataflowPipelineTranslator.TranslationContext.html#addInput-java.lang.String-java.lang.Boolean-">addInput</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> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> value)</code> +<div class="block">Adds an input with the given name and value to the current + Dataflow step.</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/dataflow/DataflowPipelineTranslator.TranslationContext.html#addInput-java.lang.String-java.util.List-">addInput</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> name, + <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><? extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>>> elements)</code> +<div class="block">Adds an input that is a list of objects.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html#addInput-java.lang.String-java.lang.Long-">addInput</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> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> value)</code> +<div class="block">Adds an input with the given name and value to the current + Dataflow step.</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/dataflow/DataflowPipelineTranslator.TranslationContext.html#addInput-java.lang.String-java.util.Map-">addInput</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> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>> elements)</code> +<div class="block">Adds an input that is a dictionary of strings to objects.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html#addInput-java.lang.String-org.apache.beam.sdk.values.PInput-">addInput</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> name, + <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a> value)</code> +<div class="block">Adds an input with the given name to the previously added Dataflow + step, coming from the specified input PValue.</div> +</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/dataflow/DataflowPipelineTranslator.TranslationContext.html#addInput-java.lang.String-java.lang.String-">addInput</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> name, + <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> value)</code> +<div class="block">Adds an input with the given name and value to the current + Dataflow step.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html#addOutput-org.apache.beam.sdk.values.PValue-">addOutput</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a> value)</code> +<div class="block">Adds an output to the previously added Dataflow step, + producing the specified output <code>PValue</code>, + including its <code>Coder</code> if a <code>TypedPValue</code>.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html#addStep-org.apache.beam.sdk.transforms.PTransform-java.lang.String-">addStep</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><?,?> transform, + <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> type)</code> +<div class="block">Adds a step to the Dataflow workflow for the given transform, with + the given Dataflow step type.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html#addStep-org.apache.beam.sdk.transforms.PTransform-com.google.api.services.dataflow.model.Step-">addStep</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><?,? extends <a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a>> transform, + com.google.api.services.dataflow.model.Step step)</code> +<div class="block">Adds a pre-defined step to the Dataflow workflow.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html#addValueOnlyOutput-org.apache.beam.sdk.values.PValue-">addValueOnlyOutput</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a> value)</code> +<div class="block">Adds an output to the previously added Dataflow step, + producing the specified output <code>PValue</code>, + including its <code>Coder</code> if a <code>TypedPValue</code>.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/dataflow/util/OutputReference.html" title="class in org.apache.beam.runners.dataflow.util">OutputReference</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html#asOutputReference-org.apache.beam.sdk.values.PValue-">asOutputReference</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a> value)</code> +<div class="block">Encode a PValue reference as an output reference.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html#getFullName-org.apache.beam.sdk.transforms.PTransform-">getFullName</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><?,?> transform)</code> +<div class="block">Returns the full name of the currently being translated transform.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><InputT extends <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>><br>InputT</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html#getInput-org.apache.beam.sdk.transforms.PTransform-">getInput</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><InputT,?> transform)</code> +<div class="block">Returns the input of the currently being translated transform.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code><OutputT extends <a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>><br>OutputT</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html#getOutput-org.apache.beam.sdk.transforms.PTransform-">getOutput</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><?,OutputT> transform)</code> +<div class="block">Returns the output of the currently being translated transform.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html#getPipelineOptions--">getPipelineOptions</a></span>()</code> +<div class="block">Returns the configured pipeline options.</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="getPipelineOptions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPipelineOptions</h4> +<pre><a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions</a> getPipelineOptions()</pre> +<div class="block">Returns the configured pipeline options.</div> +</li> +</ul> +<a name="getInput-org.apache.beam.sdk.transforms.PTransform-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInput</h4> +<pre><InputT extends <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>> InputT getInput(<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><InputT,?> transform)</pre> +<div class="block">Returns the input of the currently being translated transform.</div> +</li> +</ul> +<a name="getOutput-org.apache.beam.sdk.transforms.PTransform-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOutput</h4> +<pre><OutputT extends <a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>> OutputT getOutput(<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><?,OutputT> transform)</pre> +<div class="block">Returns the output of the currently being translated transform.</div> +</li> +</ul> +<a name="getFullName-org.apache.beam.sdk.transforms.PTransform-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFullName</h4> +<pre><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> getFullName(<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><?,?> transform)</pre> +<div class="block">Returns the full name of the currently being translated transform.</div> +</li> +</ul> +<a name="addStep-org.apache.beam.sdk.transforms.PTransform-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addStep</h4> +<pre>void addStep(<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><?,?> transform, + <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> type)</pre> +<div class="block">Adds a step to the Dataflow workflow for the given transform, with + the given Dataflow step type. + This step becomes "current" for the purpose of <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html#addInput-java.lang.String-java.lang.Boolean-"><code>addInput(java.lang.String, java.lang.Boolean)</code></a> and + <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html#addOutput-org.apache.beam.sdk.values.PValue-"><code>addOutput(org.apache.beam.sdk.values.PValue)</code></a>.</div> +</li> +</ul> +<a name="addStep-org.apache.beam.sdk.transforms.PTransform-com.google.api.services.dataflow.model.Step-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addStep</h4> +<pre>void addStep(<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><?,? extends <a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a>> transform, + com.google.api.services.dataflow.model.Step step)</pre> +<div class="block">Adds a pre-defined step to the Dataflow workflow. The given PTransform should be + consistent with the Step, in terms of input, output and coder types. + + <p>This is a low-level operation, when using this method it is up to + the caller to ensure that names do not collide.</div> +</li> +</ul> +<a name="addEncodingInput-org.apache.beam.sdk.coders.Coder-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addEncodingInput</h4> +<pre>void addEncodingInput(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><?> value)</pre> +<div class="block">Sets the encoding for the current Dataflow step.</div> +</li> +</ul> +<a name="addInput-java.lang.String-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addInput</h4> +<pre>void addInput(<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> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> value)</pre> +<div class="block">Adds an input with the given name and value to the current + Dataflow step.</div> +</li> +</ul> +<a name="addInput-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addInput</h4> +<pre>void addInput(<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> name, + <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> value)</pre> +<div class="block">Adds an input with the given name and value to the current + Dataflow step.</div> +</li> +</ul> +<a name="addInput-java.lang.String-java.lang.Long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addInput</h4> +<pre>void addInput(<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> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a> value)</pre> +<div class="block">Adds an input with the given name and value to the current + Dataflow step.</div> +</li> +</ul> +<a name="addInput-java.lang.String-org.apache.beam.sdk.values.PInput-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addInput</h4> +<pre>void addInput(<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> name, + <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a> value)</pre> +<div class="block">Adds an input with the given name to the previously added Dataflow + step, coming from the specified input PValue.</div> +</li> +</ul> +<a name="addInput-java.lang.String-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addInput</h4> +<pre>void addInput(<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> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>> elements)</pre> +<div class="block">Adds an input that is a dictionary of strings to objects.</div> +</li> +</ul> +<a name="addInput-java.lang.String-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addInput</h4> +<pre>void addInput(<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> name, + <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><? extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<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>>> elements)</pre> +<div class="block">Adds an input that is a list of objects.</div> +</li> +</ul> +<a name="addOutput-org.apache.beam.sdk.values.PValue-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addOutput</h4> +<pre>long addOutput(<a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a> value)</pre> +<div class="block">Adds an output to the previously added Dataflow step, + producing the specified output <code>PValue</code>, + including its <code>Coder</code> if a <code>TypedPValue</code>. If the + <code>PValue</code> is a <code>PCollection</code>, wraps its coder inside + a <code>WindowedValueCoder</code>. Returns a pipeline level unique id.</div> +</li> +</ul> +<a name="addValueOnlyOutput-org.apache.beam.sdk.values.PValue-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addValueOnlyOutput</h4> +<pre>long addValueOnlyOutput(<a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a> value)</pre> +<div class="block">Adds an output to the previously added Dataflow step, + producing the specified output <code>PValue</code>, + including its <code>Coder</code> if a <code>TypedPValue</code>. If the + <code>PValue</code> is a <code>PCollection</code>, wraps its coder inside + a <code>ValueOnlyCoder</code>. Returns a pipeline level unique id.</div> +</li> +</ul> +<a name="addCollectionToSingletonOutput-org.apache.beam.sdk.values.PValue-org.apache.beam.sdk.values.PValue-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addCollectionToSingletonOutput</h4> +<pre>long addCollectionToSingletonOutput(<a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a> inputValue, + <a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a> outputValue)</pre> +<div class="block">Adds an output to the previously added CollectionToSingleton Dataflow step, + consuming the specified input <code>PValue</code> and producing the specified output + <code>PValue</code>. This step requires special treatment for its + output encoding. Returns a pipeline level unique id.</div> +</li> +</ul> +<a name="asOutputReference-org.apache.beam.sdk.values.PValue-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>asOutputReference</h4> +<pre><a href="../../../../../org/apache/beam/runners/dataflow/util/OutputReference.html" title="class in org.apache.beam.runners.dataflow.util">OutputReference</a> asOutputReference(<a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values">PValue</a> value)</pre> +<div class="block">Encode a PValue reference as an output reference.</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/DataflowPipelineTranslator.TranslationContext.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/dataflow/DataflowPipelineTranslator.TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html" target="_top">Frames</a></li> +<li><a href="DataflowPipelineTranslator.TranslationContext.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/141627ec/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html ---------------------------------------------------------------------- diff --git a/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html new file mode 100644 index 0000000..37b900c --- /dev/null +++ b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html @@ -0,0 +1,380 @@ +<!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_102) on Mon Oct 31 14:28:39 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DataflowPipelineTranslator (Apache Beam SDK for Java, version 0.3.0-incubating)</title> +<meta name="date" content="2016-10-31"> +<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="DataflowPipelineTranslator (Apache Beam SDK for Java, version 0.3.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10,"i2":9,"i3":9,"i4":10,"i5":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/DataflowPipelineTranslator.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/dataflow/DataflowPipelineRegistrar.Runner.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.JobSpecification.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html" target="_top">Frames</a></li> +<li><a href="DataflowPipelineTranslator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.dataflow</div> +<h2 title="Class DataflowPipelineTranslator" class="title">Class DataflowPipelineTranslator</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.dataflow.DataflowPipelineTranslator</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">DataflowPipelineTranslator</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowPipelineTranslator</code></a> knows how to translate <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> objects + into Cloud Dataflow Service API <code>Job</code>s.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.JobSpecification.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineTranslator.JobSpecification</a></span></code> +<div class="block">The result of a job translation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow">DataflowPipelineTranslator.TransformTranslator</a><<a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TransformTranslator.html" title="type parameter in DataflowPipelineTranslator.TransformTranslator">TransformT</a> extends <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a>></span></code> +<div class="block">A <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow"><code>DataflowPipelineTranslator.TransformTranslator</code></a> knows how to translate + a particular subclass of <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> for the + Cloud Dataflow service.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TranslationContext.html" title="interface in org.apache.beam.runners.dataflow">DataflowPipelineTranslator.TranslationContext</a></span></code> +<div class="block">The interface provided to registered callbacks for interacting + with the <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowRunner</code></a>, including reading and writing the + values of <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>s and side inputs (<a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values"><code>PCollectionView</code></a>s).</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineTranslator</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html#fromOptions-org.apache.beam.runners.dataflow.options.DataflowPipelineOptions-">fromOptions</a></span>(<a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions</a> options)</code> +<div class="block">Constructs a translator from the provided options.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><TransformT extends <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a>><br><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow">DataflowPipelineTranslator.TransformTranslator</a><TransformT></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html#getTransformTranslator-java.lang.Class-">getTransformTranslator</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><TransformT> transformClass)</code> +<div class="block">Returns the <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow"><code>DataflowPipelineTranslator.TransformTranslator</code></a> to use for instances of the + specified PTransform class, or null if none registered.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html#jobToString-com.google.api.services.dataflow.model.Job-">jobToString</a></span>(com.google.api.services.dataflow.model.Job job)</code> +<div class="block">Renders a <code>Job</code> as a string.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <TransformT extends <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a>><br>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html#registerTransformTranslator-java.lang.Class-org.apache.beam.runners.dataflow.DataflowPipelineTranslator.TransformTranslator-">registerTransformTranslator</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><TransformT> transformClass, + <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow">DataflowPipelineTranslator.TransformTranslator</a><? extends TransformT> transformTranslator)</code> +<div class="block">Records that instances of the specified PTransform class + should be translated by default by the corresponding + <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow"><code>DataflowPipelineTranslator.TransformTranslator</code></a>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html#toString--">toString</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.JobSpecification.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineTranslator.JobSpecification</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html#translate-org.apache.beam.sdk.Pipeline-org.apache.beam.runners.dataflow.DataflowRunner-java.util.List-">translate</a></span>(<a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> pipeline, + <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow">DataflowRunner</a> runner, + <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><com.google.api.services.dataflow.model.DataflowPackage> packages)</code> +<div class="block">Translates a <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> into a <code>JobSpecification</code>.</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#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="fromOptions-org.apache.beam.runners.dataflow.options.DataflowPipelineOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fromOptions</h4> +<pre>public static <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineTranslator</a> fromOptions(<a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions</a> options)</pre> +<div class="block">Constructs a translator from the provided options.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>options</code> - Properties that configure the translator.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The newly created translator.</dd> +</dl> +</li> +</ul> +<a name="translate-org.apache.beam.sdk.Pipeline-org.apache.beam.runners.dataflow.DataflowRunner-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>translate</h4> +<pre>public <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.JobSpecification.html" title="class in org.apache.beam.runners.dataflow">DataflowPipelineTranslator.JobSpecification</a> translate(<a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> pipeline, + <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow">DataflowRunner</a> runner, + <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><com.google.api.services.dataflow.model.DataflowPackage> packages)</pre> +<div class="block">Translates a <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> into a <code>JobSpecification</code>.</div> +</li> +</ul> +<a name="jobToString-com.google.api.services.dataflow.model.Job-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>jobToString</h4> +<pre>public static <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> jobToString(com.google.api.services.dataflow.model.Job job)</pre> +<div class="block">Renders a <code>Job</code> as a string.</div> +</li> +</ul> +<a name="registerTransformTranslator-java.lang.Class-org.apache.beam.runners.dataflow.DataflowPipelineTranslator.TransformTranslator-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerTransformTranslator</h4> +<pre>public static <TransformT extends <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a>> void registerTransformTranslator(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><TransformT> transformClass, + <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow">DataflowPipelineTranslator.TransformTranslator</a><? extends TransformT> transformTranslator)</pre> +<div class="block">Records that instances of the specified PTransform class + should be translated by default by the corresponding + <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow"><code>DataflowPipelineTranslator.TransformTranslator</code></a>.</div> +</li> +</ul> +<a name="getTransformTranslator-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransformTranslator</h4> +<pre>public <TransformT 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/runners/dataflow/DataflowPipelineTranslator.TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow">DataflowPipelineTranslator.TransformTranslator</a><TransformT> getTransformTranslator(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><TransformT> transformClass)</pre> +<div class="block">Returns the <a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow"><code>DataflowPipelineTranslator.TransformTranslator</code></a> to use for instances of the + specified PTransform class, or null if none registered.</div> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +</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/DataflowPipelineTranslator.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/dataflow/DataflowPipelineRegistrar.Runner.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowPipelineTranslator.JobSpecification.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowPipelineTranslator.html" target="_top">Frames</a></li> +<li><a href="DataflowPipelineTranslator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/141627ec/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html ---------------------------------------------------------------------- diff --git a/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html new file mode 100644 index 0000000..ba4193b --- /dev/null +++ b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html @@ -0,0 +1,359 @@ +<!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_102) on Mon Oct 31 14:28:39 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DataflowRunner.StreamingPCollectionViewWriterFn (Apache Beam SDK for Java, version 0.3.0-incubating)</title> +<meta name="date" content="2016-10-31"> +<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="DataflowRunner.StreamingPCollectionViewWriterFn (Apache Beam SDK for Java, version 0.3.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":41,"i1":42,"i2":42,"i3":42}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/DataflowRunner.StreamingPCollectionViewWriterFn.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/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerHooks.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" target="_top">Frames</a></li> +<li><a href="DataflowRunner.StreamingPCollectionViewWriterFn.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.transforms.OldDoFn">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.dataflow</div> +<h2 title="Class DataflowRunner.StreamingPCollectionViewWriterFn" class="title">Class DataflowRunner.StreamingPCollectionViewWriterFn<T></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/OldDoFn.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.OldDoFn</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><T>,T></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.DataflowRunner.StreamingPCollectionViewWriterFn<T></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>, <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.RequiresWindowAccess.html" title="interface in org.apache.beam.sdk.transforms">OldDoFn.RequiresWindowAccess</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow">DataflowRunner</a></dd> +</dl> +<hr> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> +<br> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +public static class <span class="typeNameLabel">DataflowRunner.StreamingPCollectionViewWriterFn<T></span> +extends <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html" title="class in org.apache.beam.sdk.transforms">OldDoFn</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><T>,T> +implements <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.RequiresWindowAccess.html" title="interface in org.apache.beam.sdk.transforms">OldDoFn.RequiresWindowAccess</a></pre> +<div class="block">A specialized <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> for writing the contents of a <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> + to a streaming <a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values"><code>PCollectionView</code></a> backend implementation.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.dataflow.DataflowRunner.StreamingPCollectionViewWriterFn">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.transforms.OldDoFn"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html" title="class in org.apache.beam.sdk.transforms">OldDoFn</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.Context.html" title="class in org.apache.beam.sdk.transforms">OldDoFn.Context</a>, <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.ProcessContext.html" title="class in org.apache.beam.sdk.transforms">OldDoFn.ProcessContext</a>, <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.RequiresWindowAccess.html" title="interface in org.apache.beam.sdk.transforms">OldDoFn.RequiresWindowAccess</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" title="class in org.apache.beam.runners.dataflow">DataflowRunner.StreamingPCollectionViewWriterFn</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html#create-org.apache.beam.sdk.values.PCollectionView-org.apache.beam.sdk.coders.Coder-">create</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?> view, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><T> dataCoder)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> + </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" title="type parameter in DataflowRunner.StreamingPCollectionViewWriterFn">T</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html#getDataCoder--">getDataCoder</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> + </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><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/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html#getView--">getView</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </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/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html#processElement-org.apache.beam.sdk.transforms.OldDoFn.ProcessContext-">processElement</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.ProcessContext.html" title="class in org.apache.beam.sdk.transforms">OldDoFn.ProcessContext</a> c)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Processes one input element.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.OldDoFn"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html" title="class in org.apache.beam.sdk.transforms">OldDoFn</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html#createAggregator-java.lang.String-org.apache.beam.sdk.transforms.Combine.CombineFn-">createAggregator</a>, <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html#createAggregator-java.lang.String-org.apache.beam.sdk.transforms.SerializableFunction-">createAggregator</a>, <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html#finishBundle-org.apache.beam.sdk.transforms.OldDoFn.Context-">finishBundle</a>, <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html#getAllowedTimestampSkew--">getAllowedTimestampSkew</a>, <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html#getInputTypeDescriptor--">getInputTypeDescriptor</a>, <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html#getOutputTypeDescriptor--">getOutputTypeDescriptor</a>, <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html#populateDisplayData-org.apache.beam.sdk.transforms.d isplay.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html#setup--">setup</a>, <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html#startBundle-org.apache.beam.sdk.transforms.OldDoFn.Context-">startBundle</a>, <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html#teardown--">teardown</a>, <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html#toDoFn--">toDoFn</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#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.sdk.values.PCollectionView-org.apache.beam.sdk.coders.Coder-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <T> <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" title="class in org.apache.beam.runners.dataflow">DataflowRunner.StreamingPCollectionViewWriterFn</a><T> create(<a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?> view, + <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><T> dataCoder)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</li> +</ul> +<a name="getView--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getView</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?> getView()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</li> +</ul> +<a name="getDataCoder--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataCoder</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" title="type parameter in DataflowRunner.StreamingPCollectionViewWriterFn">T</a>> getDataCoder()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</li> +</ul> +<a name="processElement-org.apache.beam.sdk.transforms.OldDoFn.ProcessContext-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>processElement</h4> +<pre>public void processElement(<a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.ProcessContext.html" title="class in org.apache.beam.sdk.transforms">OldDoFn.ProcessContext</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html#processElement-org.apache.beam.sdk.transforms.OldDoFn.ProcessContext-">OldDoFn</a></code></span></div> +<div class="block">Processes one input element. + + <p>The current element of the input <code>PCollection</code> is returned by + <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.ProcessContext.html#element--"><code>c.element()</code></a>. It should be considered immutable. The Beam + runner will not mutate the element, so it is safe to cache, etc. The element should not be + mutated by any of the <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html" title="class in org.apache.beam.sdk.transforms"><code>OldDoFn</code></a> methods, because it may be cached elsewhere, retained by + the Beam runner, or used in other unspecified ways. + + <p>A value is added to the main output <code>PCollection</code> by <a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.Context.html#output-OutputT-"><code>OldDoFn.Context.output(OutputT)</code></a>. + Once passed to <code>output</code> the element should be considered immutable and not be modified in + any way. It may be cached elsewhere, retained by the Beam runner, or used in other + unspecified ways.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html#processElement-org.apache.beam.sdk.transforms.OldDoFn.ProcessContext-">processElement</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.html" title="class in org.apache.beam.sdk.transforms">OldDoFn</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" title="type parameter in DataflowRunner.StreamingPCollectionViewWriterFn">T</a>>,<a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" title="type parameter in DataflowRunner.StreamingPCollectionViewWriterFn">T</a>></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/beam/sdk/transforms/OldDoFn.ProcessContext.html" title="class in org.apache.beam.sdk.transforms"><code>OldDoFn.ProcessContext</code></a></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/DataflowRunner.StreamingPCollectionViewWriterFn.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/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunnerHooks.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowRunner.StreamingPCollectionViewWriterFn.html" target="_top">Frames</a></li> +<li><a href="DataflowRunner.StreamingPCollectionViewWriterFn.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.transforms.OldDoFn">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>