| <!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>SdkHarnessClient.BundleProcessor (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="SdkHarnessClient.BundleProcessor (Apache Beam 2.38.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.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/SdkHarnessClient.BundleProcessor.ActiveBundle.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.html" target="_top">Frames</a></li> |
| <li><a href="SdkHarnessClient.BundleProcessor.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.control</div> |
| <h2 title="Class SdkHarnessClient.BundleProcessor" class="title">Class SdkHarnessClient.BundleProcessor</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</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.html" title="class in org.apache.beam.runners.fnexecution.control">SdkHarnessClient</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SdkHarnessClient.BundleProcessor</span> |
| extends java.lang.Object</pre> |
| <div class="block">A processor capable of creating bundles for some registered <code>BeamFnApi.ProcessBundleDescriptor</code>.</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">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" title="class in org.apache.beam.runners.fnexecution.control">SdkHarnessClient.BundleProcessor.ActiveBundle</a></span></code> |
| <div class="block">An active bundle for a particular <code>BeamFnApi.ProcessBundleDescriptor</code>.</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="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><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" title="class in org.apache.beam.runners.fnexecution.control">SdkHarnessClient.BundleProcessor.ActiveBundle</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.html#newBundle-java.util.Map-org.apache.beam.runners.fnexecution.control.BundleProgressHandler-">newBundle</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteOutputReceiver.html" title="class in org.apache.beam.runners.fnexecution.control">RemoteOutputReceiver</a><?>> outputReceivers, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleProgressHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleProgressHandler</a> progressHandler)</code> |
| <div class="block">Start a new bundle for the given <code>BeamFnApi.ProcessBundleDescriptor</code> identifier.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" title="class in org.apache.beam.runners.fnexecution.control">SdkHarnessClient.BundleProcessor.ActiveBundle</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.html#newBundle-java.util.Map-java.util.Map-org.apache.beam.runners.fnexecution.state.StateRequestHandler-org.apache.beam.runners.fnexecution.control.BundleProgressHandler-org.apache.beam.runners.fnexecution.control.BundleFinalizationHandler-org.apache.beam.runners.fnexecution.control.BundleCheckpointHandler-">newBundle</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteOutputReceiver.html" title="class in org.apache.beam.runners.fnexecution.control">RemoteOutputReceiver</a><?>> outputReceivers, |
| java.util.Map<<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><java.lang.String,java.lang.String>,<a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteOutputReceiver.html" title="class in org.apache.beam.runners.fnexecution.control">RemoteOutputReceiver</a><org.apache.beam.runners.core.construction.Timer<?>>> timerReceivers, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.state">StateRequestHandler</a> stateRequestHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleProgressHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleProgressHandler</a> progressHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleFinalizationHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleFinalizationHandler</a> finalizationHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleCheckpointHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleCheckpointHandler</a> checkpointHandler)</code> |
| <div class="block">Start a new bundle for the given <code>BeamFnApi.ProcessBundleDescriptor</code> identifier.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" title="class in org.apache.beam.runners.fnexecution.control">SdkHarnessClient.BundleProcessor.ActiveBundle</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.html#newBundle-java.util.Map-java.util.Map-org.apache.beam.runners.fnexecution.state.StateRequestHandler-org.apache.beam.runners.fnexecution.control.BundleProgressHandler-org.apache.beam.runners.fnexecution.control.BundleSplitHandler-org.apache.beam.runners.fnexecution.control.BundleCheckpointHandler-org.apache.beam.runners.fnexecution.control.BundleFinalizationHandler-">newBundle</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteOutputReceiver.html" title="class in org.apache.beam.runners.fnexecution.control">RemoteOutputReceiver</a><?>> outputReceivers, |
| java.util.Map<<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><java.lang.String,java.lang.String>,<a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteOutputReceiver.html" title="class in org.apache.beam.runners.fnexecution.control">RemoteOutputReceiver</a><org.apache.beam.runners.core.construction.Timer<?>>> timerReceivers, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.state">StateRequestHandler</a> stateRequestHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleProgressHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleProgressHandler</a> progressHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleSplitHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleSplitHandler</a> splitHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleCheckpointHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleCheckpointHandler</a> checkpointHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleFinalizationHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleFinalizationHandler</a> finalizationHandler)</code> |
| <div class="block">Start a new bundle for the given <code>BeamFnApi.ProcessBundleDescriptor</code> identifier.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" title="class in org.apache.beam.runners.fnexecution.control">SdkHarnessClient.BundleProcessor.ActiveBundle</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.html#newBundle-java.util.Map-org.apache.beam.runners.fnexecution.state.StateRequestHandler-org.apache.beam.runners.fnexecution.control.BundleProgressHandler-">newBundle</a></span>(java.util.Map<java.lang.String,<a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteOutputReceiver.html" title="class in org.apache.beam.runners.fnexecution.control">RemoteOutputReceiver</a><?>> outputReceivers, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.state">StateRequestHandler</a> stateRequestHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleProgressHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleProgressHandler</a> progressHandler)</code> |
| <div class="block">Start a new bundle for the given <code>BeamFnApi.ProcessBundleDescriptor</code> identifier.</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="newBundle-java.util.Map-org.apache.beam.runners.fnexecution.control.BundleProgressHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newBundle</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" title="class in org.apache.beam.runners.fnexecution.control">SdkHarnessClient.BundleProcessor.ActiveBundle</a> newBundle(java.util.Map<java.lang.String,<a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteOutputReceiver.html" title="class in org.apache.beam.runners.fnexecution.control">RemoteOutputReceiver</a><?>> outputReceivers, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleProgressHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleProgressHandler</a> progressHandler)</pre> |
| <div class="block">Start a new bundle for the given <code>BeamFnApi.ProcessBundleDescriptor</code> identifier. |
| |
| <p>The input channels for the returned <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" title="class in org.apache.beam.runners.fnexecution.control"><code>SdkHarnessClient.BundleProcessor.ActiveBundle</code></a> are derived from the instructions |
| in the <code>BeamFnApi.ProcessBundleDescriptor</code>. |
| |
| <p>NOTE: It is important to <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.html#close--"><code>SdkHarnessClient.close()</code></a> each bundle after all elements are emitted. |
| |
| <pre><code> |
| try (ActiveBundle bundle = SdkHarnessClient.newBundle(...)) { |
| FnDataReceiver<InputT> inputReceiver = |
| (FnDataReceiver) bundle.getInputReceivers().get(mainPCollectionId); |
| // send all main input elements ... |
| } |
| </code></pre> |
| |
| <p>An exception during <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.html#close--"><code>SdkHarnessClient.close()</code></a> will be thrown if the bundle requests finalization or |
| attempts to checkpoint by returning a <code>BeamFnApi.DelayedBundleApplication</code>.</div> |
| </li> |
| </ul> |
| <a name="newBundle-java.util.Map-org.apache.beam.runners.fnexecution.state.StateRequestHandler-org.apache.beam.runners.fnexecution.control.BundleProgressHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newBundle</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" title="class in org.apache.beam.runners.fnexecution.control">SdkHarnessClient.BundleProcessor.ActiveBundle</a> newBundle(java.util.Map<java.lang.String,<a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteOutputReceiver.html" title="class in org.apache.beam.runners.fnexecution.control">RemoteOutputReceiver</a><?>> outputReceivers, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.state">StateRequestHandler</a> stateRequestHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleProgressHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleProgressHandler</a> progressHandler)</pre> |
| <div class="block">Start a new bundle for the given <code>BeamFnApi.ProcessBundleDescriptor</code> identifier. |
| |
| <p>The input channels for the returned <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" title="class in org.apache.beam.runners.fnexecution.control"><code>SdkHarnessClient.BundleProcessor.ActiveBundle</code></a> are derived from the instructions |
| in the <code>BeamFnApi.ProcessBundleDescriptor</code>. |
| |
| <p>NOTE: It is important to <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.html#close--"><code>SdkHarnessClient.close()</code></a> each bundle after all elements are emitted. |
| |
| <pre><code> |
| try (ActiveBundle bundle = SdkHarnessClient.newBundle(...)) { |
| FnDataReceiver<InputT> inputReceiver = |
| (FnDataReceiver) bundle.getInputReceivers().get(mainPCollectionId); |
| // send all main input elements ... |
| } |
| </code></pre> |
| |
| <p>An exception during <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.html#close--"><code>SdkHarnessClient.close()</code></a> will be thrown if the bundle requests finalization or |
| attempts to checkpoint by returning a <code>BeamFnApi.DelayedBundleApplication</code>.</div> |
| </li> |
| </ul> |
| <a name="newBundle-java.util.Map-java.util.Map-org.apache.beam.runners.fnexecution.state.StateRequestHandler-org.apache.beam.runners.fnexecution.control.BundleProgressHandler-org.apache.beam.runners.fnexecution.control.BundleFinalizationHandler-org.apache.beam.runners.fnexecution.control.BundleCheckpointHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newBundle</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" title="class in org.apache.beam.runners.fnexecution.control">SdkHarnessClient.BundleProcessor.ActiveBundle</a> newBundle(java.util.Map<java.lang.String,<a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteOutputReceiver.html" title="class in org.apache.beam.runners.fnexecution.control">RemoteOutputReceiver</a><?>> outputReceivers, |
| java.util.Map<<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><java.lang.String,java.lang.String>,<a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteOutputReceiver.html" title="class in org.apache.beam.runners.fnexecution.control">RemoteOutputReceiver</a><org.apache.beam.runners.core.construction.Timer<?>>> timerReceivers, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.state">StateRequestHandler</a> stateRequestHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleProgressHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleProgressHandler</a> progressHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleFinalizationHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleFinalizationHandler</a> finalizationHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleCheckpointHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleCheckpointHandler</a> checkpointHandler)</pre> |
| <div class="block">Start a new bundle for the given <code>BeamFnApi.ProcessBundleDescriptor</code> identifier. |
| |
| <p>The input channels for the returned <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" title="class in org.apache.beam.runners.fnexecution.control"><code>SdkHarnessClient.BundleProcessor.ActiveBundle</code></a> are derived from the instructions |
| in the <code>BeamFnApi.ProcessBundleDescriptor</code>. |
| |
| <p>NOTE: It is important to <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.html#close--"><code>SdkHarnessClient.close()</code></a> each bundle after all elements are emitted. |
| |
| <pre><code> |
| try (ActiveBundle bundle = SdkHarnessClient.newBundle(...)) { |
| FnDataReceiver<InputT> inputReceiver = |
| (FnDataReceiver) bundle.getInputReceivers().get(mainPCollectionId); |
| // send all main input elements ... |
| } |
| </code></pre> |
| |
| <p>An exception during <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.html#close--"><code>SdkHarnessClient.close()</code></a> will be thrown if the bundle requests finalization if |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleFinalizationHandler.html" title="interface in org.apache.beam.runners.fnexecution.control"><code>BundleFinalizationHandler</code></a> is <code>null</code> or attempts to checkpoint by returning a |
| <code>BeamFnApi.DelayedBundleApplication</code> .</div> |
| </li> |
| </ul> |
| <a name="newBundle-java.util.Map-java.util.Map-org.apache.beam.runners.fnexecution.state.StateRequestHandler-org.apache.beam.runners.fnexecution.control.BundleProgressHandler-org.apache.beam.runners.fnexecution.control.BundleSplitHandler-org.apache.beam.runners.fnexecution.control.BundleCheckpointHandler-org.apache.beam.runners.fnexecution.control.BundleFinalizationHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>newBundle</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" title="class in org.apache.beam.runners.fnexecution.control">SdkHarnessClient.BundleProcessor.ActiveBundle</a> newBundle(java.util.Map<java.lang.String,<a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteOutputReceiver.html" title="class in org.apache.beam.runners.fnexecution.control">RemoteOutputReceiver</a><?>> outputReceivers, |
| java.util.Map<<a href="../../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><java.lang.String,java.lang.String>,<a href="../../../../../../org/apache/beam/runners/fnexecution/control/RemoteOutputReceiver.html" title="class in org.apache.beam.runners.fnexecution.control">RemoteOutputReceiver</a><org.apache.beam.runners.core.construction.Timer<?>>> timerReceivers, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandler.html" title="interface in org.apache.beam.runners.fnexecution.state">StateRequestHandler</a> stateRequestHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleProgressHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleProgressHandler</a> progressHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleSplitHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleSplitHandler</a> splitHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleCheckpointHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleCheckpointHandler</a> checkpointHandler, |
| <a href="../../../../../../org/apache/beam/runners/fnexecution/control/BundleFinalizationHandler.html" title="interface in org.apache.beam.runners.fnexecution.control">BundleFinalizationHandler</a> finalizationHandler)</pre> |
| <div class="block">Start a new bundle for the given <code>BeamFnApi.ProcessBundleDescriptor</code> identifier. |
| |
| <p>The input channels for the returned <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.BundleProcessor.ActiveBundle.html" title="class in org.apache.beam.runners.fnexecution.control"><code>SdkHarnessClient.BundleProcessor.ActiveBundle</code></a> are derived from the instructions |
| in the <code>BeamFnApi.ProcessBundleDescriptor</code>. |
| |
| <p>NOTE: It is important to <a href="../../../../../../org/apache/beam/runners/fnexecution/control/SdkHarnessClient.html#close--"><code>SdkHarnessClient.close()</code></a> each bundle after all elements are emitted. |
| |
| <pre><code> |
| try (ActiveBundle bundle = SdkHarnessClient.newBundle(...)) { |
| FnDataReceiver<InputT> inputReceiver = |
| (FnDataReceiver) bundle.getInputReceivers().get(mainPCollectionId); |
| // send all elements ... |
| } |
| </code></pre></div> |
| </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.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/SdkHarnessClient.BundleProcessor.ActiveBundle.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.html" target="_top">Frames</a></li> |
| <li><a href="SdkHarnessClient.BundleProcessor.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> |
