| <!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_181-google-v7) on Mon Jan 27 16:42:27 PST 2020 --> |
| <title>TransformTranslator.StepTranslationContext (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-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="TransformTranslator.StepTranslationContext (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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="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/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/TransformTranslator.TranslationContext.html" title="interface 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/TransformTranslator.StepTranslationContext.html" target="_top">Frames</a></li> |
| <li><a href="TransformTranslator.StepTranslationContext.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 TransformTranslator.StepTranslationContext" class="title">Interface TransformTranslator.StepTranslationContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="../../../../../org/apache/beam/runners/dataflow/TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow">TransformTranslator</a><<a href="../../../../../org/apache/beam/runners/dataflow/TransformTranslator.html" title="type parameter in TransformTranslator">TransformT</a> extends <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static interface <span class="typeNameLabel">TransformTranslator.StepTranslationContext</span></pre> |
| <div class="block">The interface for a <a href="../../../../../org/apache/beam/runners/dataflow/TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow"><code>TransformTranslator</code></a> to build a Dataflow step.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/TransformTranslator.StepTranslationContext.html#addCollectionToSingletonOutput-org.apache.beam.sdk.values.PCollection-java.lang.String-org.apache.beam.sdk.values.PCollectionView-">addCollectionToSingletonOutput</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><?> inputValue, |
| java.lang.String outputName, |
| <a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?> outputValue)</code> |
| <div class="block">Adds an output to this <code>CollectionToSingleton</code> 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/TransformTranslator.StepTranslationContext.html#addEncodingInput-org.apache.beam.sdk.coders.Coder-">addEncodingInput</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><?> value)</code> |
| <div class="block">Sets the encoding for this 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/TransformTranslator.StepTranslationContext.html#addInput-java.lang.String-java.lang.Boolean-">addInput</a></span>(java.lang.String name, |
| java.lang.Boolean value)</code> |
| <div class="block">Adds an input with the given name and value to this 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/TransformTranslator.StepTranslationContext.html#addInput-java.lang.String-java.util.List-">addInput</a></span>(java.lang.String name, |
| java.util.List<? extends java.util.Map<java.lang.String,java.lang.Object>> 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/TransformTranslator.StepTranslationContext.html#addInput-java.lang.String-java.lang.Long-">addInput</a></span>(java.lang.String name, |
| java.lang.Long value)</code> |
| <div class="block">Adds an input with the given name and value to this 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/TransformTranslator.StepTranslationContext.html#addInput-java.lang.String-java.util.Map-">addInput</a></span>(java.lang.String name, |
| java.util.Map<java.lang.String,java.lang.Object> 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/TransformTranslator.StepTranslationContext.html#addInput-java.lang.String-org.apache.beam.sdk.values.PInput-">addInput</a></span>(java.lang.String 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 this 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/TransformTranslator.StepTranslationContext.html#addInput-java.lang.String-java.lang.String-">addInput</a></span>(java.lang.String name, |
| java.lang.String value)</code> |
| <div class="block">Adds an input with the given name and value to this Dataflow step.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/TransformTranslator.StepTranslationContext.html#addOutput-java.lang.String-org.apache.beam.sdk.values.PCollection-">addOutput</a></span>(java.lang.String name, |
| <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><?> value)</code> |
| <div class="block">Adds a primitive output to this Dataflow step with the given name as the local output name, |
| producing the specified output <code>PValue</code>, including its <code>Coder</code> if a <code>TypedPValue</code>.</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="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="class in org.apache.beam.sdk.coders">Coder</a><?> value)</pre> |
| <div class="block">Sets the encoding for this 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(java.lang.String name, |
| java.lang.Boolean value)</pre> |
| <div class="block">Adds an input with the given name and value to this 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(java.lang.String name, |
| java.lang.String value)</pre> |
| <div class="block">Adds an input with the given name and value to this 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(java.lang.String name, |
| java.lang.Long value)</pre> |
| <div class="block">Adds an input with the given name and value to this 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(java.lang.String 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 this Dataflow step, coming from the specified input |
| PValue. |
| |
| <p>The input <a href="../../../../../org/apache/beam/sdk/values/PValue.html" title="interface in org.apache.beam.sdk.values"><code>PValue</code></a> must have already been produced by a step earlier in this <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>. If the input value has not yet been produced yet (by a call to either <a href="../../../../../org/apache/beam/runners/dataflow/TransformTranslator.StepTranslationContext.html#addOutput-java.lang.String-org.apache.beam.sdk.values.PCollection-"><code>addOutput(java.lang.String, org.apache.beam.sdk.values.PCollection<?>)</code></a> or <a href="../../../../../org/apache/beam/runners/dataflow/TransformTranslator.StepTranslationContext.html#addCollectionToSingletonOutput-org.apache.beam.sdk.values.PCollection-java.lang.String-org.apache.beam.sdk.values.PCollectionView-"><code>addCollectionToSingletonOutput(org.apache.beam.sdk.values.PCollection<?>, java.lang.String, org.apache.beam.sdk.values.PCollectionView<?>)</code></a>) this method will throw an exception.</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(java.lang.String name, |
| java.util.Map<java.lang.String,java.lang.Object> 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(java.lang.String name, |
| java.util.List<? extends java.util.Map<java.lang.String,java.lang.Object>> elements)</pre> |
| <div class="block">Adds an input that is a list of objects.</div> |
| </li> |
| </ul> |
| <a name="addOutput-java.lang.String-org.apache.beam.sdk.values.PCollection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOutput</h4> |
| <pre>void addOutput(java.lang.String name, |
| <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><?> value)</pre> |
| <div class="block">Adds a primitive output to this Dataflow step with the given name as the local output name, |
| 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>.</div> |
| </li> |
| </ul> |
| <a name="addCollectionToSingletonOutput-org.apache.beam.sdk.values.PCollection-java.lang.String-org.apache.beam.sdk.values.PCollectionView-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addCollectionToSingletonOutput</h4> |
| <pre>void addCollectionToSingletonOutput(<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><?> inputValue, |
| java.lang.String outputName, |
| <a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values">PCollectionView</a><?> outputValue)</pre> |
| <div class="block">Adds an output to this <code>CollectionToSingleton</code> 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> |
| </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="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/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/TransformTranslator.TranslationContext.html" title="interface 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/TransformTranslator.StepTranslationContext.html" target="_top">Frames</a></li> |
| <li><a href="TransformTranslator.StepTranslationContext.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 ======= --> |
| </body> |
| </html> |
