| <!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_151-google-v7) on Tue Oct 02 14:37:30 PDT 2018 --> |
| <title>RemoteEnvironment (Apache Beam 2.7.0-SNAPSHOT)</title> |
| <meta name="date" content="2018-10-02"> |
| <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="RemoteEnvironment (Apache Beam 2.7.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":18,"i1":17,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/environment/InProcessEnvironmentFactory.html" title="class in org.apache.beam.runners.fnexecution.environment"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.SimpleRemoteEnvironment.html" title="class in org.apache.beam.runners.fnexecution.environment"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html" target="_top">Frames</a></li> |
| <li><a href="RemoteEnvironment.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.environment</div> |
| <h2 title="Interface RemoteEnvironment" class="title">Interface RemoteEnvironment</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> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.SimpleRemoteEnvironment.html" title="class in org.apache.beam.runners.fnexecution.environment">RemoteEnvironment.SimpleRemoteEnvironment</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">RemoteEnvironment</span> |
| extends java.lang.AutoCloseable</pre> |
| <div class="block">A handle to an available remote <code>RunnerApi.Environment</code>. This environment is connected to a Fn API |
| Control service, and the associated client is available via <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html#getInstructionRequestHandler--"><code>getInstructionRequestHandler()</code></a>.</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"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.SimpleRemoteEnvironment.html" title="class in org.apache.beam.runners.fnexecution.environment">RemoteEnvironment.SimpleRemoteEnvironment</a></span></code> |
| <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>close()</code></a> behavior.</div> |
| </td> |
| </tr> |
| </table> |
| </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </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>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html#close--">close</a></span>()</code> |
| <div class="block">.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html" title="interface in org.apache.beam.runners.fnexecution.environment">RemoteEnvironment</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html#forHandler-org.apache.beam.model.pipeline.v1.RunnerApi.Environment-org.apache.beam.runners.fnexecution.control.InstructionRequestHandler-">forHandler</a></span>(org.apache.beam.model.pipeline.v1.RunnerApi.Environment env, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/InstructionRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">InstructionRequestHandler</a> handler)</code> |
| <div class="block">Create a new <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html" title="interface in org.apache.beam.runners.fnexecution.environment"><code>RemoteEnvironment</code></a> for the provided <code>RunnerApi.Environment</code> and <code>AutoCloseable</code> <a href="../../../../../../org/apache/beam/runners/fnexecution/control/InstructionRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>InstructionRequestHandler</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>org.apache.beam.model.pipeline.v1.RunnerApi.Environment</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html#getEnvironment--">getEnvironment</a></span>()</code> |
| <div class="block">Return the environment that the remote handles.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/fnexecution/control/InstructionRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">InstructionRequestHandler</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html#getInstructionRequestHandler--">getInstructionRequestHandler</a></span>()</code> |
| <div class="block">Return an <a href="../../../../../../org/apache/beam/runners/fnexecution/control/InstructionRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>InstructionRequestHandler</code></a> which can communicate with the environment.</div> |
| </td> |
| </tr> |
| </table> |
| </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="forHandler-org.apache.beam.model.pipeline.v1.RunnerApi.Environment-org.apache.beam.runners.fnexecution.control.InstructionRequestHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forHandler</h4> |
| <pre>static <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html" title="interface in org.apache.beam.runners.fnexecution.environment">RemoteEnvironment</a> forHandler(org.apache.beam.model.pipeline.v1.RunnerApi.Environment env, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/InstructionRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">InstructionRequestHandler</a> handler)</pre> |
| <div class="block">Create a new <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html" title="interface in org.apache.beam.runners.fnexecution.environment"><code>RemoteEnvironment</code></a> for the provided <code>RunnerApi.Environment</code> and <code>AutoCloseable</code> <a href="../../../../../../org/apache/beam/runners/fnexecution/control/InstructionRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>InstructionRequestHandler</code></a>. |
| |
| <p>When the <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html" title="interface in org.apache.beam.runners.fnexecution.environment"><code>RemoteEnvironment</code></a> is closed, the <a href="../../../../../../org/apache/beam/runners/fnexecution/control/InstructionRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>InstructionRequestHandler</code></a> will be |
| closed.</div> |
| </li> |
| </ul> |
| <a name="getEnvironment--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnvironment</h4> |
| <pre>org.apache.beam.model.pipeline.v1.RunnerApi.Environment getEnvironment()</pre> |
| <div class="block">Return the environment that the remote handles.</div> |
| </li> |
| </ul> |
| <a name="getInstructionRequestHandler--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstructionRequestHandler</h4> |
| <pre><a href="../../../../../../org/apache/beam/runners/fnexecution/control/InstructionRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">InstructionRequestHandler</a> getInstructionRequestHandler()</pre> |
| <div class="block">Return an <a href="../../../../../../org/apache/beam/runners/fnexecution/control/InstructionRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>InstructionRequestHandler</code></a> which can communicate with the environment.</div> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>default void close() |
| throws java.lang.Exception</pre> |
| <div class="block">. |
| |
| <p>By default, closes the <a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html#getInstructionRequestHandler--"><code>getInstructionRequestHandler()</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</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><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/InProcessEnvironmentFactory.html" title="class in org.apache.beam.runners.fnexecution.environment"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.SimpleRemoteEnvironment.html" title="class in org.apache.beam.runners.fnexecution.environment"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/environment/RemoteEnvironment.html" target="_top">Frames</a></li> |
| <li><a href="RemoteEnvironment.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |