| <!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>FnDataService (Apache Beam 2.47.0)</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="FnDataService (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/runners/fnexecution/data/GrpcDataService.html" title="class in org.apache.beam.runners.fnexecution.data"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/data/FnDataService.html" target="_top">Frames</a></li> |
| <li><a href="FnDataService.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.data</div> |
| <h2 title="Interface FnDataService" class="title">Interface FnDataService</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/beam/runners/fnexecution/data/GrpcDataService.html" title="class in org.apache.beam.runners.fnexecution.data">GrpcDataService</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">FnDataService</span></pre> |
| <div class="block">The <a href="../../../../../../org/apache/beam/runners/fnexecution/data/FnDataService.html" title="interface in org.apache.beam.runners.fnexecution.data"><code>FnDataService</code></a> is able to forward inbound elements to a consumer and is also a |
| consumer of outbound elements. Callers can register themselves as consumers for inbound elements |
| or can get a handle for a consumer for outbound elements.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/sdk/fn/data/BeamFnDataOutboundAggregator.html" title="class in org.apache.beam.sdk.fn.data">BeamFnDataOutboundAggregator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/data/FnDataService.html#createOutboundAggregator-java.util.function.Supplier-boolean-">createOutboundAggregator</a></span>(java.util.function.Supplier<java.lang.String> processBundleRequestIdSupplier, |
| boolean collectElementsIfNoFlushes)</code> |
| <div class="block">Creates a <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataOutboundAggregator.html" title="class in org.apache.beam.sdk.fn.data"><code>BeamFnDataOutboundAggregator</code></a> for buffering and sending outbound data and |
| timers over the data plane.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/data/FnDataService.html#registerReceiver-java.lang.String-org.apache.beam.sdk.fn.data.CloseableFnDataReceiver-">registerReceiver</a></span>(java.lang.String instructionId, |
| <a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">CloseableFnDataReceiver</a><org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements> observer)</code> |
| <div class="block">Registers a receiver for the provided instruction id.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/data/FnDataService.html#unregisterReceiver-java.lang.String-">unregisterReceiver</a></span>(java.lang.String instructionId)</code> |
| <div class="block">Receivers are only expected to be unregistered when bundle processing has completed |
| successfully.</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="registerReceiver-java.lang.String-org.apache.beam.sdk.fn.data.CloseableFnDataReceiver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerReceiver</h4> |
| <pre>void registerReceiver(java.lang.String instructionId, |
| <a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">CloseableFnDataReceiver</a><org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements> observer)</pre> |
| <div class="block">Registers a receiver for the provided instruction id. |
| |
| <p>The receiver is not required to be thread safe. |
| |
| <p>Receivers for successfully processed bundles must be unregistered. See <a href="../../../../../../org/apache/beam/runners/fnexecution/data/FnDataService.html#unregisterReceiver-java.lang.String-"><code>unregisterReceiver(java.lang.String)</code></a> for details. |
| |
| <p>Any failure during <a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html#accept-T-"><code>FnDataReceiver.accept(T)</code></a> will mark the provided <code>instructionId</code> as invalid and will ignore any future data. It is expected that if a bundle |
| fails during processing then the failure will become visible to the <a href="../../../../../../org/apache/beam/runners/fnexecution/data/FnDataService.html" title="interface in org.apache.beam.runners.fnexecution.data"><code>FnDataService</code></a> |
| during a future <a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html#accept-T-"><code>FnDataReceiver.accept(T)</code></a> invocation.</div> |
| </li> |
| </ul> |
| <a name="unregisterReceiver-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unregisterReceiver</h4> |
| <pre>void unregisterReceiver(java.lang.String instructionId)</pre> |
| <div class="block">Receivers are only expected to be unregistered when bundle processing has completed |
| successfully. |
| |
| <p>It is expected that if a bundle fails during processing then the failure will become visible |
| to the <a href="../../../../../../org/apache/beam/runners/fnexecution/data/FnDataService.html" title="interface in org.apache.beam.runners.fnexecution.data"><code>FnDataService</code></a> during a future <a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html#accept-T-"><code>FnDataReceiver.accept(T)</code></a> invocation.</div> |
| </li> |
| </ul> |
| <a name="createOutboundAggregator-java.util.function.Supplier-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createOutboundAggregator</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataOutboundAggregator.html" title="class in org.apache.beam.sdk.fn.data">BeamFnDataOutboundAggregator</a> createOutboundAggregator(java.util.function.Supplier<java.lang.String> processBundleRequestIdSupplier, |
| boolean collectElementsIfNoFlushes)</pre> |
| <div class="block">Creates a <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataOutboundAggregator.html" title="class in org.apache.beam.sdk.fn.data"><code>BeamFnDataOutboundAggregator</code></a> for buffering and sending outbound data and |
| timers over the data plane. It is important that <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataOutboundAggregator.html#sendOrCollectBufferedDataAndFinishOutboundStreams--"><code>BeamFnDataOutboundAggregator.sendOrCollectBufferedDataAndFinishOutboundStreams()</code></a> is called on |
| the returned BeamFnDataOutboundAggregator at the end of each bundle. If |
| collectElementsIfNoFlushes is set to true, <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataOutboundAggregator.html#sendOrCollectBufferedDataAndFinishOutboundStreams--"><code>BeamFnDataOutboundAggregator.sendOrCollectBufferedDataAndFinishOutboundStreams()</code></a> returns the |
| buffered elements instead of sending it through the outbound StreamObserver if there's no |
| previous flush. |
| |
| <p>Closing the returned aggregator signals the end of the streams. |
| |
| <p>The returned aggregator is not thread safe.</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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/runners/fnexecution/data/GrpcDataService.html" title="class in org.apache.beam.runners.fnexecution.data"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/data/FnDataService.html" target="_top">Frames</a></li> |
| <li><a href="FnDataService.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> |
