| <!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>org.apache.beam.sdk.fn.data (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="org.apache.beam.sdk.fn.data (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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/channel/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/fn/server/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/fn/data/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.beam.sdk.fn.data</h1> |
| <div class="docSummary"> |
| <div class="block">Classes to interact with the portability framework data plane.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/CloseableFnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">CloseableFnDataReceiver</a><T></td> |
| <td class="colLast"> |
| <div class="block">A receiver of streamed data that can be closed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/FnDataReceiver.html" title="interface in org.apache.beam.sdk.fn.data">FnDataReceiver</a><T></td> |
| <td class="colLast"> |
| <div class="block">A receiver of streamed data.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/InboundDataClient.html" title="interface in org.apache.beam.sdk.fn.data">InboundDataClient</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Migrate to <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver2.html" title="class in org.apache.beam.sdk.fn.data"><code>BeamFnDataInboundObserver2</code></a>.</span></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataGrpcMultiplexer.html" title="class in org.apache.beam.sdk.fn.data">BeamFnDataGrpcMultiplexer</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Migrate to <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataGrpcMultiplexer2.html" title="class in org.apache.beam.sdk.fn.data"><code>BeamFnDataGrpcMultiplexer2</code></a>.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataGrpcMultiplexer2.html" title="class in org.apache.beam.sdk.fn.data">BeamFnDataGrpcMultiplexer2</a></td> |
| <td class="colLast"> |
| <div class="block">A gRPC multiplexer for a specific <code>Endpoints.ApiServiceDescriptor</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver.html" title="class in org.apache.beam.sdk.fn.data">BeamFnDataInboundObserver</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Migrate to <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver2.html" title="class in org.apache.beam.sdk.fn.data"><code>BeamFnDataInboundObserver2</code></a>.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver2.html" title="class in org.apache.beam.sdk.fn.data">BeamFnDataInboundObserver2</a></td> |
| <td class="colLast"> |
| <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.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataOutboundAggregator.html" title="class in org.apache.beam.sdk.fn.data">BeamFnDataOutboundAggregator</a></td> |
| <td class="colLast"> |
| <div class="block">An outbound data buffering aggregator with size-based buffer and time-based buffer if |
| corresponding options are set.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataOutboundObserver.html" title="class in org.apache.beam.sdk.fn.data">BeamFnDataOutboundObserver</a><T></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Migrate to use <a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataOutboundAggregator.html" title="class in org.apache.beam.sdk.fn.data"><code>BeamFnDataOutboundAggregator</code></a> directly.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/CompletableFutureInboundDataClient.html" title="class in org.apache.beam.sdk.fn.data">CompletableFutureInboundDataClient</a></td> |
| <td class="colLast"> |
| <div class="block">An <a href="../../../../../../org/apache/beam/sdk/fn/data/InboundDataClient.html" title="interface in org.apache.beam.sdk.fn.data"><code>InboundDataClient</code></a> backed by a <code>CompletableFuture</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/DataEndpoint.html" title="class in org.apache.beam.sdk.fn.data">DataEndpoint</a><T></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/DecodingFnDataReceiver.html" title="class in org.apache.beam.sdk.fn.data">DecodingFnDataReceiver</a><T></td> |
| <td class="colLast"> |
| <div class="block">A receiver of encoded data, decoding it and passing it onto a downstream consumer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/LogicalEndpoint.html" title="class in org.apache.beam.sdk.fn.data">LogicalEndpoint</a></td> |
| <td class="colLast"> |
| <div class="block">A logical endpoint is a pair of an instruction ID corresponding to the <code>BeamFnApi.ProcessBundleRequest</code> and the transform within the processing graph.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/RemoteGrpcPortRead.html" title="class in org.apache.beam.sdk.fn.data">RemoteGrpcPortRead</a></td> |
| <td class="colLast"> |
| <div class="block">An execution-time only <code>RunnerApi.PTransform</code> which represents an SDK harness reading from a <code>BeamFnApi.RemoteGrpcPort</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/RemoteGrpcPortWrite.html" title="class in org.apache.beam.sdk.fn.data">RemoteGrpcPortWrite</a></td> |
| <td class="colLast"> |
| <div class="block">An execution-time only <code>RunnerApi.PTransform</code> which represents a write from within an SDK harness to |
| a <code>BeamFnApi.RemoteGrpcPort</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/TimerEndpoint.html" title="class in org.apache.beam.sdk.fn.data">TimerEndpoint</a><T></td> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/fn/data/BeamFnDataInboundObserver2.CloseException.html" title="class in org.apache.beam.sdk.fn.data">BeamFnDataInboundObserver2.CloseException</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.beam.sdk.fn.data Description">Package org.apache.beam.sdk.fn.data Description</h2> |
| <div class="block">Classes to interact with the portability framework data plane.</div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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/channel/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/fn/server/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/fn/data/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
