| <!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>BeamFnDataInboundObserver (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="BeamFnDataInboundObserver (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/sdk/fn/data/BeamFnDataGrpcMultiplexer.html" title="class in org.apache.beam.sdk.fn.data"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver.CloseException.html" title="class in org.apache.beam.sdk.fn.data"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver.html" target="_top">Frames</a></li> |
| <li><a href="BeamFnDataInboundObserver.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.sdk.fn.data</div> |
| <h2 title="Class BeamFnDataInboundObserver" class="title">Class BeamFnDataInboundObserver</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.fn.data.BeamFnDataInboundObserver</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/sdk/fn/data/CloseableFnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">CloseableFnDataReceiver</a><org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements>, <a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">FnDataReceiver</a><org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">BeamFnDataInboundObserver</span> |
| extends java.lang.Object |
| implements <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></pre> |
| <div class="block">Decodes <code>BeamFnApi.Elements</code> partitioning them using the provided <a href="../../../../../../org/apache/beam/sdk/fn/data/DataEndpoint.html" title="class in org.apache.beam.sdk.fn.data"><code>DataEndpoint</code></a>s and |
| <a href="../../../../../../org/apache/beam/sdk/fn/data/TimerEndpoint.html" title="class in org.apache.beam.sdk.fn.data"><code>TimerEndpoint</code></a>s. |
| |
| <p>Note that this receiver uses a queue to buffer and pass elements from one thread to be |
| processed by the thread which invokes <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver.html#awaitCompletion--"><code>awaitCompletion()</code></a>. |
| |
| <p>Closing the receiver will unblock any upstream producer and downstream consumer exceptionally.</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>protected static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver.CloseException.html" title="class in org.apache.beam.sdk.fn.data">BeamFnDataInboundObserver.CloseException</a></span></code> </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="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/sdk/fn/data/BeamFnDataInboundObserver.html#accept-org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements-">accept</a></span>(org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements elements)</code> </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/sdk/fn/data/BeamFnDataInboundObserver.html#awaitCompletion--">awaitCompletion</a></span>()</code> |
| <div class="block">Uses the callers thread to process all elements received until we receive the end of the stream |
| from the upstream producer for all endpoints specified.</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/sdk/fn/data/BeamFnDataInboundObserver.html#close--">close</a></span>()</code> |
| <div class="block">.</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/sdk/fn/data/BeamFnDataInboundObserver.html#flush--">flush</a></span>()</code> |
| <div class="block">Eagerly flushes any data that is buffered in this channel.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver.html" title="class in org.apache.beam.sdk.fn.data">BeamFnDataInboundObserver</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver.html#forConsumers-java.util.List-java.util.List-">forConsumers</a></span>(java.util.List<<a href="../../../../../../org/apache/beam/sdk/fn/data/DataEndpoint.html" title="class in org.apache.beam.sdk.fn.data">DataEndpoint</a><?>> dataEndpoints, |
| java.util.List<<a href="../../../../../../org/apache/beam/sdk/fn/data/TimerEndpoint.html" title="class in org.apache.beam.sdk.fn.data">TimerEndpoint</a><?>> timerEndpoints)</code> |
| <div class="block">Creates a receiver that is able to consume elements multiplexing on to the provided set of |
| endpoints.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver.html#getUnfinishedEndpoints--">getUnfinishedEndpoints</a></span>()</code> |
| <div class="block">Get all unfinished data and timers endpoints represented as [transform_id]:data and |
| [transform_id]:timers:[timer_family_id].</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver.html#multiplexElements-org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements-">multiplexElements</a></span>(org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements elements)</code> |
| <div class="block">Dispatches the data and timers from the elements to corresponding receivers.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver.html#reset--">reset</a></span>()</code> |
| <div class="block">Enables this receiver to be used again for another bundle.</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="forConsumers-java.util.List-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forConsumers</h4> |
| <pre>public static <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver.html" title="class in org.apache.beam.sdk.fn.data">BeamFnDataInboundObserver</a> forConsumers(java.util.List<<a href="../../../../../../org/apache/beam/sdk/fn/data/DataEndpoint.html" title="class in org.apache.beam.sdk.fn.data">DataEndpoint</a><?>> dataEndpoints, |
| java.util.List<<a href="../../../../../../org/apache/beam/sdk/fn/data/TimerEndpoint.html" title="class in org.apache.beam.sdk.fn.data">TimerEndpoint</a><?>> timerEndpoints)</pre> |
| <div class="block">Creates a receiver that is able to consume elements multiplexing on to the provided set of |
| endpoints.</div> |
| </li> |
| </ul> |
| <a name="accept-org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>accept</h4> |
| <pre>public void accept(org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements elements) |
| throws java.lang.Exception</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html#accept-T-">accept</a></code> in interface <code><a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">FnDataReceiver</a><org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="flush--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flush</h4> |
| <pre>public void flush() |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html#flush--">CloseableFnDataReceiver</a></code></span></div> |
| <div class="block">Eagerly flushes any data that is buffered in this channel.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html#flush--">flush</a></code> in interface <code><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></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close() |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html#close--">CloseableFnDataReceiver</a></code></span></div> |
| <div class="block">. |
| |
| <p>Does nothing if this <a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data"><code>CloseableFnDataReceiver</code></a> is already closed.</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/sdk/fn/data/CloseableFnDataReceiver.html#close--">close</a></code> in interface <code><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></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="awaitCompletion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>awaitCompletion</h4> |
| <pre>public void awaitCompletion() |
| throws java.lang.Exception</pre> |
| <div class="block">Uses the callers thread to process all elements received until we receive the end of the stream |
| from the upstream producer for all endpoints specified. |
| |
| <p>Erroneous elements passed from the producer will be visible to the caller of this method.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="multiplexElements-org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>multiplexElements</h4> |
| <pre>public boolean multiplexElements(org.apache.beam.model.fnexecution.v1.BeamFnApi.Elements elements) |
| throws java.lang.Exception</pre> |
| <div class="block">Dispatches the data and timers from the elements to corresponding receivers. Returns true if |
| all the endpoints are done after elements dispatching.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>public void reset()</pre> |
| <div class="block">Enables this receiver to be used again for another bundle.</div> |
| </li> |
| </ul> |
| <a name="getUnfinishedEndpoints--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getUnfinishedEndpoints</h4> |
| <pre>public java.util.List<java.lang.String> getUnfinishedEndpoints()</pre> |
| <div class="block">Get all unfinished data and timers endpoints represented as [transform_id]:data and |
| [transform_id]:timers:[timer_family_id].</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/sdk/fn/data/BeamFnDataGrpcMultiplexer.html" title="class in org.apache.beam.sdk.fn.data"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver.CloseException.html" title="class in org.apache.beam.sdk.fn.data"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver.html" target="_top">Frames</a></li> |
| <li><a href="BeamFnDataInboundObserver.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> |
