blob: b9d42af591ef0b221510697b2c9a397b73ea4199 [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_181-google-v7) on Wed Aug 14 17:37:14 PDT 2019 -->
<title>PipelineTranslatorUtils (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="PipelineTranslatorUtils (Apache Beam 2.15.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/fnexecution/translation/BatchSideInputHandlerFactory.SideInputGetter.html" title="interface in org.apache.beam.runners.fnexecution.translation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/translation/PipelineTranslatorUtils.html" target="_top">Frames</a></li>
<li><a href="PipelineTranslatorUtils.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>Nested&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.fnexecution.translation</div>
<h2 title="Class PipelineTranslatorUtils" class="title">Class PipelineTranslatorUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.runners.fnexecution.translation.PipelineTranslatorUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">PipelineTranslatorUtils</span>
extends java.lang.Object</pre>
<div class="block">Utilities for pipeline translation.</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">&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="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 org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.BiMap&lt;java.lang.String,java.lang.Integer&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/translation/PipelineTranslatorUtils.html#createOutputMap-java.lang.Iterable-">createOutputMap</a></span>(java.lang.Iterable&lt;java.lang.String&gt;&nbsp;localOutputs)</code>
<div class="block">Creates a mapping from PCollection id to output tag integer.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/translation/PipelineTranslatorUtils.html#fireEligibleTimers-org.apache.beam.runners.core.InMemoryTimerInternals-java.util.function.BiConsumer-java.lang.Object-">fireEligibleTimers</a></span>(org.apache.beam.runners.core.InMemoryTimerInternals&nbsp;timerInternals,
java.util.function.BiConsumer&lt;java.lang.String,org.apache.beam.sdk.util.WindowedValue&gt;&nbsp;timerConsumer,
java.lang.Object&nbsp;currentTimerKey)</code>
<div class="block">Fires all timers which are ready to be fired.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/values/WindowingStrategy.html" title="class in org.apache.beam.sdk.values">WindowingStrategy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/translation/PipelineTranslatorUtils.html#getWindowingStrategy-java.lang.String-org.apache.beam.model.pipeline.v1.RunnerApi.Components-">getWindowingStrategy</a></span>(java.lang.String&nbsp;pCollectionId,
org.apache.beam.model.pipeline.v1.RunnerApi.Components&nbsp;components)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/translation/PipelineTranslatorUtils.html#hasUnboundedPCollections-org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline-">hasUnboundedPCollections</a></span>(org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline&nbsp;pipeline)</code>
<div class="block">Indicates whether the given pipeline has any unbounded PCollections.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;org.apache.beam.sdk.util.WindowedValue&lt;T&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/translation/PipelineTranslatorUtils.html#instantiateCoder-java.lang.String-org.apache.beam.model.pipeline.v1.RunnerApi.Components-">instantiateCoder</a></span>(java.lang.String&nbsp;collectionId,
org.apache.beam.model.pipeline.v1.RunnerApi.Components&nbsp;components)</code>
<div class="block">Creates a coder for a given PCollection id from the Proto definition.</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="createOutputMap-java.lang.Iterable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createOutputMap</h4>
<pre>public static&nbsp;org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.BiMap&lt;java.lang.String,java.lang.Integer&gt;&nbsp;createOutputMap(java.lang.Iterable&lt;java.lang.String&gt;&nbsp;localOutputs)</pre>
<div class="block">Creates a mapping from PCollection id to output tag integer.</div>
</li>
</ul>
<a name="instantiateCoder-java.lang.String-org.apache.beam.model.pipeline.v1.RunnerApi.Components-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>instantiateCoder</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;org.apache.beam.sdk.util.WindowedValue&lt;T&gt;&gt;&nbsp;instantiateCoder(java.lang.String&nbsp;collectionId,
org.apache.beam.model.pipeline.v1.RunnerApi.Components&nbsp;components)</pre>
<div class="block">Creates a coder for a given PCollection id from the Proto definition.</div>
</li>
</ul>
<a name="getWindowingStrategy-java.lang.String-org.apache.beam.model.pipeline.v1.RunnerApi.Components-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWindowingStrategy</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/WindowingStrategy.html" title="class in org.apache.beam.sdk.values">WindowingStrategy</a>&nbsp;getWindowingStrategy(java.lang.String&nbsp;pCollectionId,
org.apache.beam.model.pipeline.v1.RunnerApi.Components&nbsp;components)</pre>
</li>
</ul>
<a name="hasUnboundedPCollections-org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasUnboundedPCollections</h4>
<pre>public static&nbsp;boolean&nbsp;hasUnboundedPCollections(org.apache.beam.model.pipeline.v1.RunnerApi.Pipeline&nbsp;pipeline)</pre>
<div class="block">Indicates whether the given pipeline has any unbounded PCollections.</div>
</li>
</ul>
<a name="fireEligibleTimers-org.apache.beam.runners.core.InMemoryTimerInternals-java.util.function.BiConsumer-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fireEligibleTimers</h4>
<pre>public static&nbsp;void&nbsp;fireEligibleTimers(org.apache.beam.runners.core.InMemoryTimerInternals&nbsp;timerInternals,
java.util.function.BiConsumer&lt;java.lang.String,org.apache.beam.sdk.util.WindowedValue&gt;&nbsp;timerConsumer,
java.lang.Object&nbsp;currentTimerKey)</pre>
<div class="block">Fires all timers which are ready to be fired. This is done in a loop because timers may itself
schedule timers.</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/fnexecution/translation/BatchSideInputHandlerFactory.SideInputGetter.html" title="interface in org.apache.beam.runners.fnexecution.translation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/translation/PipelineTranslatorUtils.html" target="_top">Frames</a></li>
<li><a href="PipelineTranslatorUtils.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>Nested&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>