blob: 0439213f304b30a50e5fde446216989e851420ef [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 -->
<title>org.apache.beam.runners.fnexecution.environment (Apache Beam 2.38.0-SNAPSHOT)</title>
<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.environment (Apache Beam 2.38.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/data/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/testing/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/environment/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.environment</h1>
<div class="docSummary">
<div class="block">Classes used to instantiate and manage SDK harness environments.</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/environment/EnvironmentFactory.html" title="interface in org.apache.beam.runners.fnexecution.environment">EnvironmentFactory</a></td>
<td class="colLast">
<div class="block">Creates <code>environments</code> which communicate to an <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.html" title="class in org.apache.beam.runners.fnexecution.control"><code>SdkHarnessClient</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/EnvironmentFactory.Provider.html" title="interface in org.apache.beam.runners.fnexecution.environment">EnvironmentFactory.Provider</a></td>
<td class="colLast">
<div class="block">Provider for a <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/EnvironmentFactory.html" title="interface in org.apache.beam.runners.fnexecution.environment"><code>EnvironmentFactory</code></a> and <a href="../../../../../../org/apache/beam/sdk/fn/server/ServerFactory.html" title="class in org.apache.beam.sdk.fn.server"><code>ServerFactory</code></a> for the environment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html" title="interface in org.apache.beam.runners.fnexecution.environment">RemoteEnvironment</a></td>
<td class="colLast">
<div class="block">A handle to an available remote <code>RunnerApi.Environment</code>.</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/environment/DockerEnvironmentFactory.html" title="class in org.apache.beam.runners.fnexecution.environment">DockerEnvironmentFactory</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/EnvironmentFactory.html" title="interface in org.apache.beam.runners.fnexecution.environment"><code>EnvironmentFactory</code></a> that creates docker containers by shelling out to docker.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/DockerEnvironmentFactory.Provider.html" title="class in org.apache.beam.runners.fnexecution.environment">DockerEnvironmentFactory.Provider</a></td>
<td class="colLast">
<div class="block">Provider for DockerEnvironmentFactory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/EmbeddedEnvironmentFactory.html" title="class in org.apache.beam.runners.fnexecution.environment">EmbeddedEnvironmentFactory</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/EnvironmentFactory.html" title="interface in org.apache.beam.runners.fnexecution.environment"><code>EnvironmentFactory</code></a> that communicates to a <code>FnHarness</code> which is executing in the
same process.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/EmbeddedEnvironmentFactory.Provider.html" title="class in org.apache.beam.runners.fnexecution.environment">EmbeddedEnvironmentFactory.Provider</a></td>
<td class="colLast">
<div class="block">Provider of EmbeddedEnvironmentFactory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/ExternalEnvironmentFactory.html" title="class in org.apache.beam.runners.fnexecution.environment">ExternalEnvironmentFactory</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/EnvironmentFactory.html" title="interface in org.apache.beam.runners.fnexecution.environment"><code>EnvironmentFactory</code></a> which requests workers via the given URL in the Environment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/ExternalEnvironmentFactory.Provider.html" title="class in org.apache.beam.runners.fnexecution.environment">ExternalEnvironmentFactory.Provider</a></td>
<td class="colLast">
<div class="block">Provider of ExternalEnvironmentFactory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/ProcessEnvironment.html" title="class in org.apache.beam.runners.fnexecution.environment">ProcessEnvironment</a></td>
<td class="colLast">
<div class="block">Environment for process-based execution.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/ProcessEnvironmentFactory.html" title="class in org.apache.beam.runners.fnexecution.environment">ProcessEnvironmentFactory</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/EnvironmentFactory.html" title="interface in org.apache.beam.runners.fnexecution.environment"><code>EnvironmentFactory</code></a> which forks processes based on the parameters in the Environment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/ProcessEnvironmentFactory.Provider.html" title="class in org.apache.beam.runners.fnexecution.environment">ProcessEnvironmentFactory.Provider</a></td>
<td class="colLast">
<div class="block">Provider of ProcessEnvironmentFactory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/ProcessManager.html" title="class in org.apache.beam.runners.fnexecution.environment">ProcessManager</a></td>
<td class="colLast">
<div class="block">A simple process manager which forks processes and kills them if necessary.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/ProcessManager.RunningProcess.html" title="class in org.apache.beam.runners.fnexecution.environment">ProcessManager.RunningProcess</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.SimpleRemoteEnvironment.html" title="class in org.apache.beam.runners.fnexecution.environment">RemoteEnvironment.SimpleRemoteEnvironment</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html" title="interface in org.apache.beam.runners.fnexecution.environment"><code>RemoteEnvironment</code></a> which uses the default <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html#close--"><code>RemoteEnvironment.close()</code></a> behavior.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/StaticRemoteEnvironment.html" title="class in org.apache.beam.runners.fnexecution.environment">StaticRemoteEnvironment</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html" title="interface in org.apache.beam.runners.fnexecution.environment"><code>RemoteEnvironment</code></a> that connects to Dataflow runner harness.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/StaticRemoteEnvironmentFactory.html" title="class in org.apache.beam.runners.fnexecution.environment">StaticRemoteEnvironmentFactory</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/EnvironmentFactory.html" title="interface in org.apache.beam.runners.fnexecution.environment"><code>EnvironmentFactory</code></a> that creates StaticRemoteEnvironment used by a runner harness that
would like to use an existing InstructionRequestHandler.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/StaticRemoteEnvironmentFactory.Provider.html" title="class in org.apache.beam.runners.fnexecution.environment">StaticRemoteEnvironmentFactory.Provider</a></td>
<td class="colLast">
<div class="block">Provider for StaticRemoteEnvironmentFactory.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.runners.fnexecution.environment Description">Package org.apache.beam.runners.fnexecution.environment Description</h2>
<div class="block">Classes used to instantiate and manage SDK harness environments.</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/data/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/testing/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/environment/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>