| <!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 Mon Jan 27 16:42:29 PST 2020 --> |
| <title>SdkHarnessClient.BundleProcessor.ActiveBundle (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-01-27"> |
| <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="SdkHarnessClient.BundleProcessor.ActiveBundle (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/control/SdkHarnessClient.BundleProcessor.html" title="class in org.apache.beam.runners.fnexecution.control"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SingleEnvironmentInstanceJobBundleFactory.html" title="class in org.apache.beam.runners.fnexecution.control"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" target="_top">Frames</a></li> |
| <li><a href="SdkHarnessClient.BundleProcessor.ActiveBundle.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>Nested | </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.control</div> |
| <h2 title="Class SdkHarnessClient.BundleProcessor.ActiveBundle" class="title">Class SdkHarnessClient.BundleProcessor.ActiveBundle</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.runners.fnexecution.control.SdkHarnessClient.BundleProcessor.ActiveBundle</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.lang.AutoCloseable, <a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html" title="interface in org.apache.beam.runners.fnexecution.control">RemoteBundle</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.html" title="class in org.apache.beam.runners.fnexecution.control">SdkHarnessClient.BundleProcessor</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SdkHarnessClient.BundleProcessor.ActiveBundle</span> |
| extends java.lang.Object |
| implements <a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html" title="interface in org.apache.beam.runners.fnexecution.control">RemoteBundle</a></pre> |
| <div class="block">An active bundle for a particular <code>BeamFnApi.ProcessBundleDescriptor</code>.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html#close--">close</a></span>()</code> |
| <div class="block">Blocks until bundle processing is finished.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html#getId--">getId</a></span>()</code> |
| <div class="block">Returns an id used to represent this bundle.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">FnDataReceiver</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html#getInputReceivers--">getInputReceivers</a></span>()</code> |
| <div class="block">Get a map of PCollection ids to <a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data"><code>receiver</code></a>s which consume input |
| elements, forwarding them to the remote environment.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html#split-double-">split</a></span>(double fractionOfRemainder)</code> |
| <div class="block">Ask the remote bundle to split its current processing based upon its knowledge of remaining |
| work.</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 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="getId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre>public java.lang.String getId()</pre> |
| <div class="block">Returns an id used to represent this bundle.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html#getId--">getId</a></code> in interface <code><a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html" title="interface in org.apache.beam.runners.fnexecution.control">RemoteBundle</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInputReceivers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputReceivers</h4> |
| <pre>public java.util.Map<java.lang.String,<a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">FnDataReceiver</a>> getInputReceivers()</pre> |
| <div class="block">Get a map of PCollection ids to <a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data"><code>receiver</code></a>s which consume input |
| elements, forwarding them to the remote environment.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html#getInputReceivers--">getInputReceivers</a></code> in interface <code><a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html" title="interface in org.apache.beam.runners.fnexecution.control">RemoteBundle</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="split-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>split</h4> |
| <pre>public void split(double fractionOfRemainder)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html#split-double-">RemoteBundle</a></code></span></div> |
| <div class="block">Ask the remote bundle to split its current processing based upon its knowledge of remaining |
| work. A fraction of 0, is equivalent to asking the SDK to checkpoint. |
| |
| <p>This method will return after the request has been issued. Any splits will be forwarded to |
| the <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleSplitHandler.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>BundleSplitHandler</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html#split-double-">split</a></code> in interface <code><a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html" title="interface in org.apache.beam.runners.fnexecution.control">RemoteBundle</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close() |
| throws java.lang.Exception</pre> |
| <div class="block">Blocks until bundle processing is finished. This is comprised of: |
| |
| <ul> |
| <li>closing each <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html#getInputReceivers--"><code>input receiver</code></a>. |
| <li>waiting for the SDK to say that processing the bundle is finished. |
| <li>waiting for all inbound data clients to complete |
| </ul> |
| |
| <p>This method will throw an exception if bundle processing has failed. <code>Throwable.getSuppressed()</code> will return all the reasons as to why processing has failed.</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html#close--">close</a></code> in interface <code><a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteBundle.html" title="interface in org.apache.beam.runners.fnexecution.control">RemoteBundle</a></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/control/SdkHarnessClient.BundleProcessor.html" title="class in org.apache.beam.runners.fnexecution.control"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SingleEnvironmentInstanceJobBundleFactory.html" title="class in org.apache.beam.runners.fnexecution.control"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" target="_top">Frames</a></li> |
| <li><a href="SdkHarnessClient.BundleProcessor.ActiveBundle.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>Nested | </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> |
