Google Git
Sign in
apache / beam-site / refs/heads/updates_release_2.8.0 / . / javadoc / 2.8.0 / org / apache / beam / runners / fnexecution / control / package-summary.html
blob: 3029540c9ecab6d3e6456eba7426f60ea215d32f [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:36 PDT 2018 -->
<title>org.apache.beam.runners.fnexecution.control (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="org.apache.beam.runners.fnexecution.control (Apache Beam 2.8.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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/artifact/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/runners/fnexecution/data/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/control/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.runners.fnexecution.control</h1>
<div class="docSummary">
<div class="block">Utilities for a Beam runner to interact with the Fn API <code>Control Service</code> via java abstractions.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleProgressHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleProgressHandler</a></td>
<td class="colLast">
<div class="block">A handler for bundle progress messages, both during bundle execution and on its completion.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/ControlClientPool.html" title="interface in org.apache.beam.runners.fnexecution.control">ControlClientPool</a></td>
<td class="colLast">
<div class="block">A pool of control clients that brokers incoming SDK harness connections (in the form of <a href="../../../../../../org/apache/beam/runners/fnexecution/control/InstructionRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>InstructionRequestHandlers</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/ControlClientPool.Sink.html" title="interface in org.apache.beam.runners.fnexecution.control">ControlClientPool.Sink</a></td>
<td class="colLast">
<div class="block">A sink for <a href="../../../../../../org/apache/beam/runners/fnexecution/control/InstructionRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>InstructionRequestHandlers</code></a> keyed by worker id.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/ControlClientPool.Source.html" title="interface in org.apache.beam.runners.fnexecution.control">ControlClientPool.Source</a></td>
<td class="colLast">
<div class="block">A source of <a href="../../../../../../org/apache/beam/runners/fnexecution/control/InstructionRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>InstructionRequestHandlers</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/InstructionRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">InstructionRequestHandler</a></td>
<td class="colLast">
<div class="block">Interface for any function that can handle a Fn API <code>BeamFnApi.InstructionRequest</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/JobBundleFactory.html" title="interface in org.apache.beam.runners.fnexecution.control">JobBundleFactory</a></td>
<td class="colLast">
<div class="block">A factory that has all job-scoped information, and can be combined with stage-scoped information
to create a <a href="../../../../../../org/apache/beam/runners/fnexecution/control/StageBundleFactory.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>StageBundleFactory</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/OutputReceiverFactory.html" title="interface in org.apache.beam.runners.fnexecution.control">OutputReceiverFactory</a></td>
<td class="colLast">
<div class="block">A factory that can create output receivers during an executable stage.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html" title="interface in org.apache.beam.runners.fnexecution.control">RemoteBundle</a></td>
<td class="colLast">
<div class="block">A bundle capable of handling input data elements for a <code>bundle descriptor</code> by
forwarding them to a remote environment for processing.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/StageBundleFactory.html" title="interface in org.apache.beam.runners.fnexecution.control">StageBundleFactory</a></td>
<td class="colLast">
<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>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/DefaultJobBundleFactory.html" title="class in org.apache.beam.runners.fnexecution.control">DefaultJobBundleFactory</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/runners/fnexecution/control/JobBundleFactory.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>JobBundleFactory</code></a> for which the implementation can specify a custom <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/EnvironmentFactory.html" title="interface in org.apache.beam.runners.fnexecution.environment"><code>EnvironmentFactory</code></a> for environment management.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/DefaultJobBundleFactory.SimpleStageBundleFactory.html" title="class in org.apache.beam.runners.fnexecution.control">DefaultJobBundleFactory.SimpleStageBundleFactory</a></td>
<td class="colLast">
<div class="block">A simple stage bundle factory for remotely processing bundles.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/DefaultJobBundleFactory.WrappedSdkHarnessClient.html" title="class in org.apache.beam.runners.fnexecution.control">DefaultJobBundleFactory.WrappedSdkHarnessClient</a></td>
<td class="colLast">
<div class="block">Holder for an <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.html" title="class in org.apache.beam.runners.fnexecution.control"><code>SdkHarnessClient</code></a> along with its associated state and data servers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/FnApiControlClient.html" title="class in org.apache.beam.runners.fnexecution.control">FnApiControlClient</a></td>
<td class="colLast">
<div class="block">A client for the control plane of an SDK harness, which can issue requests to it over the Fn API.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/FnApiControlClientPoolService.html" title="class in org.apache.beam.runners.fnexecution.control">FnApiControlClientPoolService</a></td>
<td class="colLast">
<div class="block">A Fn API control service which adds incoming SDK harness connections to a sink.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/MapControlClientPool.html" title="class in org.apache.beam.runners.fnexecution.control">MapControlClientPool</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/runners/fnexecution/control/ControlClientPool.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>ControlClientPool</code></a> backed by a client map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/ProcessBundleDescriptors.html" title="class in org.apache.beam.runners.fnexecution.control">ProcessBundleDescriptors</a></td>
<td class="colLast">
<div class="block">Utility methods for creating <code>BeamFnApi.ProcessBundleDescriptor</code> instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/ProcessBundleDescriptors.BagUserStateSpec.html" title="class in org.apache.beam.runners.fnexecution.control">ProcessBundleDescriptors.BagUserStateSpec</a>&lt;K,V,W extends <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>&gt;</td>
<td class="colLast">
<div class="block">A container type storing references to the key, value, and window <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> used when
handling bag user state requests.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/ProcessBundleDescriptors.ExecutableProcessBundleDescriptor.html" title="class in org.apache.beam.runners.fnexecution.control">ProcessBundleDescriptors.ExecutableProcessBundleDescriptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/ProcessBundleDescriptors.SideInputSpec.html" title="class in org.apache.beam.runners.fnexecution.control">ProcessBundleDescriptors.SideInputSpec</a>&lt;K,T,W extends <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>&gt;</td>
<td class="colLast">
<div class="block">A container type storing references to the key, value, and window <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> used when
handling side input state requests.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/ProcessBundleDescriptors.TimerSpec.html" title="class in org.apache.beam.runners.fnexecution.control">ProcessBundleDescriptors.TimerSpec</a>&lt;K,V,W extends <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>&gt;</td>
<td class="colLast">
<div class="block">A container type storing references to the key, timer and payload coders and the remote input
destination used when handling timer requests.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteOutputReceiver.html" title="class in org.apache.beam.runners.fnexecution.control">RemoteOutputReceiver</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A pair of <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> and <a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data"><code>FnDataReceiver</code></a> which can be registered to receive elements
for a <a href="../../../../../../org/apache/beam/sdk/fn/data/LogicalEndpoint.html" title="class in org.apache.beam.sdk.fn.data"><code>LogicalEndpoint</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.html" title="class in org.apache.beam.runners.fnexecution.control">SdkHarnessClient</a></td>
<td class="colLast">
<div class="block">A high-level client for an SDK harness.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.ActiveBundle.html" title="class in org.apache.beam.runners.fnexecution.control">SdkHarnessClient.ActiveBundle</a></td>
<td class="colLast">
<div class="block">An active bundle for a particular <code>BeamFnApi.ProcessBundleDescriptor</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SingleEnvironmentInstanceJobBundleFactory.html" title="class in org.apache.beam.runners.fnexecution.control">SingleEnvironmentInstanceJobBundleFactory</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">replace with a <a href="../../../../../../org/apache/beam/runners/fnexecution/control/DefaultJobBundleFactory.html" title="class in org.apache.beam.runners.fnexecution.control"><code>DefaultJobBundleFactory</code></a> when appropriate if the <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/EnvironmentFactory.html" title="interface in org.apache.beam.runners.fnexecution.environment"><code>EnvironmentFactory</code></a> is a <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/DockerEnvironmentFactory.html" title="class in org.apache.beam.runners.fnexecution.environment"><code>DockerEnvironmentFactory</code></a>, or create an
<code>InProcessJobBundleFactory</code> and inline the creation of the environment if appropriate.</span></div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.runners.fnexecution.control Description">Package org.apache.beam.runners.fnexecution.control Description</h2>
<div class="block">Utilities for a Beam runner to interact with the Fn API <code>Control Service</code> via java abstractions.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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/artifact/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/runners/fnexecution/data/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/control/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>