blob: 14566800ac11fb1f5cfb9d535b21f0d99ba8ef1a [file] [log] [blame]
<!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_161-google-v7) on Thu Oct 18 16:14:32 PDT 2018 -->
<title>FlinkBatchPortablePipelineTranslator (Apache Beam 2.8.0-SNAPSHOT)</title>
<meta name="date" content="2018-10-18">
<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="FlinkBatchPortablePipelineTranslator (Apache Beam 2.8.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.BatchTranslationContext.html" title="class in org.apache.beam.runners.flink"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.html" target="_top">Frames</a></li>
<li><a href="FlinkBatchPortablePipelineTranslator.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.flink</div>
<h2 title="Class FlinkBatchPortablePipelineTranslator" class="title">Class FlinkBatchPortablePipelineTranslator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.runners.flink.FlinkBatchPortablePipelineTranslator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/beam/runners/flink/FlinkPortablePipelineTranslator.html" title="interface in org.apache.beam.runners.flink">FlinkPortablePipelineTranslator</a>&lt;<a href="../../../../../org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.BatchTranslationContext.html" title="class in org.apache.beam.runners.flink">FlinkBatchPortablePipelineTranslator.BatchTranslationContext</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">FlinkBatchPortablePipelineTranslator</span>
extends java.lang.Object
implements <a href="../../../../../org/apache/beam/runners/flink/FlinkPortablePipelineTranslator.html" title="interface in org.apache.beam.runners.flink">FlinkPortablePipelineTranslator</a>&lt;<a href="../../../../../org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.BatchTranslationContext.html" title="class in org.apache.beam.runners.flink">FlinkBatchPortablePipelineTranslator.BatchTranslationContext</a>&gt;</pre>
<div class="block">A translator that translates bounded portable pipelines into executable Flink pipelines.
<p>Example usage:
<pre>
FlinkBatchPortablePipelineTranslator translator =
FlinkBatchPortablePipelineTranslator.createTranslator();
BatchTranslationContext context =
FlinkBatchPortablePipelineTranslator.createTranslationContext(jobInfo);
translator.translate(context, pipeline);
ExecutionEnvironment executionEnvironment = context.getExecutionEnvironment();
// Do something with executionEnvironment...
</pre>
<p>After translation the <code>ExecutionEnvironment</code> in the translation context will contain the
full not-yet-executed pipeline DAG corresponding to the input pipeline.</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">&nbsp;</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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.BatchTranslationContext.html" title="class in org.apache.beam.runners.flink">FlinkBatchPortablePipelineTranslator.BatchTranslationContext</a></span></code>
<div class="block">Batch translation context.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.runners.flink.FlinkPortablePipelineTranslator">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.beam.runners.flink.<a href="../../../../../org/apache/beam/runners/flink/FlinkPortablePipelineTranslator.html" title="interface in org.apache.beam.runners.flink">FlinkPortablePipelineTranslator</a></h3>
<code><a href="../../../../../org/apache/beam/runners/flink/FlinkPortablePipelineTranslator.TranslationContext.html" title="interface in org.apache.beam.runners.flink">FlinkPortablePipelineTranslator.TranslationContext</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/flink/FlinkBatchPortablePipelineTranslator.BatchTranslationContext.html" title="class in org.apache.beam.runners.flink">FlinkBatchPortablePipelineTranslator.BatchTranslationContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.html#createTranslationContext-org.apache.beam.runners.fnexecution.provisioning.JobInfo-org.apache.beam.runners.flink.FlinkPipelineOptions-java.util.List-">createTranslationContext</a></span>(<a href="../../../../../org/apache/beam/runners/fnexecution/provisioning/JobInfo.html" title="class in org.apache.beam.runners.fnexecution.provisioning">JobInfo</a>&nbsp;jobInfo,
<a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html" title="interface in org.apache.beam.runners.flink">FlinkPipelineOptions</a>&nbsp;pipelineOptions,
java.util.List&lt;java.lang.String&gt;&nbsp;filesToStage)</code>
<div class="block">Creates a batch translation context.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.html" title="class in org.apache.beam.runners.flink">FlinkBatchPortablePipelineTranslator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.html#createTranslator--">createTranslator</a></span>()</code>
<div class="block">Creates a batch translator.</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/flink/FlinkBatchPortablePipelineTranslator.html#translate-org.apache.beam.runners.flink.FlinkBatchPortablePipelineTranslator.BatchTranslationContext-org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline-">translate</a></span>(<a href="../../../../../org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.BatchTranslationContext.html" title="class in org.apache.beam.runners.flink">FlinkBatchPortablePipelineTranslator.BatchTranslationContext</a>&nbsp;context,
org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline&nbsp;pipeline)</code>
<div class="block">Translates the given pipeline.</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="createTranslationContext-org.apache.beam.runners.fnexecution.provisioning.JobInfo-org.apache.beam.runners.flink.FlinkPipelineOptions-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTranslationContext</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.BatchTranslationContext.html" title="class in org.apache.beam.runners.flink">FlinkBatchPortablePipelineTranslator.BatchTranslationContext</a>&nbsp;createTranslationContext(<a href="../../../../../org/apache/beam/runners/fnexecution/provisioning/JobInfo.html" title="class in org.apache.beam.runners.fnexecution.provisioning">JobInfo</a>&nbsp;jobInfo,
<a href="../../../../../org/apache/beam/runners/flink/FlinkPipelineOptions.html" title="interface in org.apache.beam.runners.flink">FlinkPipelineOptions</a>&nbsp;pipelineOptions,
java.util.List&lt;java.lang.String&gt;&nbsp;filesToStage)</pre>
<div class="block">Creates a batch translation context. The resulting Flink execution dag will live in a new
<code>ExecutionEnvironment</code>.</div>
</li>
</ul>
<a name="createTranslator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTranslator</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.html" title="class in org.apache.beam.runners.flink">FlinkBatchPortablePipelineTranslator</a>&nbsp;createTranslator()</pre>
<div class="block">Creates a batch translator.</div>
</li>
</ul>
<a name="translate-org.apache.beam.runners.flink.FlinkBatchPortablePipelineTranslator.BatchTranslationContext-org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>translate</h4>
<pre>public&nbsp;void&nbsp;translate(<a href="../../../../../org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.BatchTranslationContext.html" title="class in org.apache.beam.runners.flink">FlinkBatchPortablePipelineTranslator.BatchTranslationContext</a>&nbsp;context,
org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline&nbsp;pipeline)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/beam/runners/flink/FlinkPortablePipelineTranslator.html#translate-T-org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline-">FlinkPortablePipelineTranslator</a></code></span></div>
<div class="block">Translates the given pipeline.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/runners/flink/FlinkPortablePipelineTranslator.html#translate-T-org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline-">translate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/beam/runners/flink/FlinkPortablePipelineTranslator.html" title="interface in org.apache.beam.runners.flink">FlinkPortablePipelineTranslator</a>&lt;<a href="../../../../../org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.BatchTranslationContext.html" title="class in org.apache.beam.runners.flink">FlinkBatchPortablePipelineTranslator.BatchTranslationContext</a>&gt;</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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.BatchTranslationContext.html" title="class in org.apache.beam.runners.flink"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/runners/flink/FlinkBatchPortablePipelineTranslator.html" target="_top">Frames</a></li>
<li><a href="FlinkBatchPortablePipelineTranslator.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>