blob: b22b7eebc88bf9d9b8ef52989aa69daf18e5c63a [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:12 PDT 2019 -->
<title>StageBundleFactory (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="StageBundleFactory (Apache Beam 2.15.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":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/fnexecution/control/SingleEnvironmentInstanceJobBundleFactory.html" title="class in org.apache.beam.runners.fnexecution.control"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/runners/fnexecution/control/TimerReceiverFactory.html" title="class in org.apache.beam.runners.fnexecution.control"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/control/StageBundleFactory.html" target="_top">Frames</a></li>
<li><a href="StageBundleFactory.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.control</div>
<h2 title="Interface StageBundleFactory" class="title">Interface StageBundleFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.lang.AutoCloseable</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">StageBundleFactory</span>
extends java.lang.AutoCloseable</pre>
<div class="block">A bundle factory scoped to a particular <code>ExecutableStage</code>, which has all of the resources
it needs to provide new <a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>RemoteBundles</code></a>.
<p>Closing a StageBundleFactory signals that the stage has completed and any resources bound to
its lifetime can be cleaned up.</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html" title="interface in org.apache.beam.runners.fnexecution.control">RemoteBundle</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/StageBundleFactory.html#getBundle-org.apache.beam.runners.fnexecution.control.OutputReceiverFactory-org.apache.beam.runners.fnexecution.state.StateRequestHandler-org.apache.beam.runners.fnexecution.control.BundleProgressHandler-">getBundle</a></span>(<a href="../../../../../../org/apache/beam/runners/fnexecution/control/OutputReceiverFactory.html" title="interface in org.apache.beam.runners.fnexecution.control">OutputReceiverFactory</a>&nbsp;outputReceiverFactory,
<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.state">StateRequestHandler</a>&nbsp;stateRequestHandler,
<a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleProgressHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleProgressHandler</a>&nbsp;progressHandler)</code>
<div class="block">Get a new <a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>bundle</code></a> for processing the data in an executable stage.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/fnexecution/control/ProcessBundleDescriptors.ExecutableProcessBundleDescriptor.html" title="class in org.apache.beam.runners.fnexecution.control">ProcessBundleDescriptors.ExecutableProcessBundleDescriptor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/StageBundleFactory.html#getProcessBundleDescriptor--">getProcessBundleDescriptor</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.AutoCloseable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.AutoCloseable</h3>
<code>close</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="getBundle-org.apache.beam.runners.fnexecution.control.OutputReceiverFactory-org.apache.beam.runners.fnexecution.state.StateRequestHandler-org.apache.beam.runners.fnexecution.control.BundleProgressHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBundle</h4>
<pre><a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html" title="interface in org.apache.beam.runners.fnexecution.control">RemoteBundle</a>&nbsp;getBundle(<a href="../../../../../../org/apache/beam/runners/fnexecution/control/OutputReceiverFactory.html" title="interface in org.apache.beam.runners.fnexecution.control">OutputReceiverFactory</a>&nbsp;outputReceiverFactory,
<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.state">StateRequestHandler</a>&nbsp;stateRequestHandler,
<a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleProgressHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleProgressHandler</a>&nbsp;progressHandler)
throws java.lang.Exception</pre>
<div class="block">Get a new <a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>bundle</code></a> for processing the data in an executable stage.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="getProcessBundleDescriptor--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getProcessBundleDescriptor</h4>
<pre><a href="../../../../../../org/apache/beam/runners/fnexecution/control/ProcessBundleDescriptors.ExecutableProcessBundleDescriptor.html" title="class in org.apache.beam.runners.fnexecution.control">ProcessBundleDescriptors.ExecutableProcessBundleDescriptor</a>&nbsp;getProcessBundleDescriptor()</pre>
</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/control/SingleEnvironmentInstanceJobBundleFactory.html" title="class in org.apache.beam.runners.fnexecution.control"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/runners/fnexecution/control/TimerReceiverFactory.html" title="class in org.apache.beam.runners.fnexecution.control"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/control/StageBundleFactory.html" target="_top">Frames</a></li>
<li><a href="StageBundleFactory.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>