| <!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 Wed Aug 14 17:37:10 PDT 2019 --> |
| <title>DataflowPipelineTranslator (Apache Beam 2.15.0-SNAPSHOT)</title> |
| <meta name="date" content="2019-08-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DataflowPipelineTranslator (Apache Beam 2.15.0-SNAPSHOT)"; |
| } |
| } |
| 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="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>java.lang.Object</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 java.lang.Object</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 <a href="https://static.javadoc.io/com.google.apis/google-api-services-dataflow/v1b3-rev20190607-1.27.0/com/google/api/services/dataflow/model/Job.html?is-external=true" title="class or interface in com.google.api.services.dataflow.model"><code>Job</code></a>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> |
| </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/TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow">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>(java.lang.Class<TransformT> transformClass)</code> |
| <div class="block">Returns the <a href="../../../../../org/apache/beam/runners/dataflow/TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow"><code>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 java.lang.String</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>(<a href="https://static.javadoc.io/com.google.apis/google-api-services-dataflow/v1b3-rev20190607-1.27.0/com/google/api/services/dataflow/model/Job.html?is-external=true" title="class or interface in com.google.api.services.dataflow.model">Job</a> job)</code> |
| <div class="block">Renders a <a href="https://static.javadoc.io/com.google.apis/google-api-services-dataflow/v1b3-rev20190607-1.27.0/com/google/api/services/dataflow/model/Job.html?is-external=true" title="class or interface in com.google.api.services.dataflow.model"><code>Job</code></a> 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.TransformTranslator-">registerTransformTranslator</a></span>(java.lang.Class<TransformT> transformClass, |
| <a href="../../../../../org/apache/beam/runners/dataflow/TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow">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/TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow"><code>TransformTranslator</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</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, |
| java.util.List<<a href="https://static.javadoc.io/com.google.apis/google-api-services-dataflow/v1b3-rev20190607-1.27.0/com/google/api/services/dataflow/model/DataflowPackage.html?is-external=true" title="class or interface in com.google.api.services.dataflow.model">DataflowPackage</a>> 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.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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, |
| java.util.List<<a href="https://static.javadoc.io/com.google.apis/google-api-services-dataflow/v1b3-rev20190607-1.27.0/com/google/api/services/dataflow/model/DataflowPackage.html?is-external=true" title="class or interface in com.google.api.services.dataflow.model">DataflowPackage</a>> 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 java.lang.String jobToString(<a href="https://static.javadoc.io/com.google.apis/google-api-services-dataflow/v1b3-rev20190607-1.27.0/com/google/api/services/dataflow/model/Job.html?is-external=true" title="class or interface in com.google.api.services.dataflow.model">Job</a> job)</pre> |
| <div class="block">Renders a <a href="https://static.javadoc.io/com.google.apis/google-api-services-dataflow/v1b3-rev20190607-1.27.0/com/google/api/services/dataflow/model/Job.html?is-external=true" title="class or interface in com.google.api.services.dataflow.model"><code>Job</code></a> as a string.</div> |
| </li> |
| </ul> |
| <a name="registerTransformTranslator-java.lang.Class-org.apache.beam.runners.dataflow.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(java.lang.Class<TransformT> transformClass, |
| <a href="../../../../../org/apache/beam/runners/dataflow/TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow">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/TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow"><code>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/TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow">TransformTranslator</a><TransformT> getTransformTranslator(java.lang.Class<TransformT> transformClass)</pre> |
| <div class="block">Returns the <a href="../../../../../org/apache/beam/runners/dataflow/TransformTranslator.html" title="interface in org.apache.beam.runners.dataflow"><code>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 java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</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="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 ======= --> |
| </body> |
| </html> |
