| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>org.apache.heron.streamlet (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-03-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.heron.streamlet (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.heron.streamlet</h1> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <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"> |
| <th class="colFirst" scope="row"><a href="Builder.html" title="interface in org.apache.heron.streamlet">Builder</a></th> |
| <td class="colLast"> |
| <div class="block">Builder is used to register all sources.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Context.html" title="interface in org.apache.heron.streamlet">Context</a></th> |
| <td class="colLast"> |
| <div class="block">Context is the information available at runtime for operators like transform.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="IStreamletBasicOperator.html" title="interface in org.apache.heron.streamlet">IStreamletBasicOperator</a><R,​T></th> |
| <td class="colLast"> |
| <div class="block">The interface for streamlet operators.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="IStreamletOperator.html" title="interface in org.apache.heron.streamlet">IStreamletOperator</a><R,​T></th> |
| <td class="colLast"> |
| <div class="block">The base interface for all Streamlet operator interfaces.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="IStreamletRichOperator.html" title="interface in org.apache.heron.streamlet">IStreamletRichOperator</a><R,​T></th> |
| <td class="colLast"> |
| <div class="block">The interface for custom operators: it can be used to create |
| operators based on existing Bolts (subclasses of IRichBolt).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="IStreamletWindowOperator.html" title="interface in org.apache.heron.streamlet">IStreamletWindowOperator</a><R,​T></th> |
| <td class="colLast"> |
| <div class="block">The interface for streamlet operators.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="KVStreamlet.html" title="interface in org.apache.heron.streamlet">KVStreamlet</a><K,​V></th> |
| <td class="colLast"> |
| <div class="block">A KVStreamlet is a Streamlet with KeyValue data.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SerializableBiFunction.html" title="interface in org.apache.heron.streamlet">SerializableBiFunction</a><A,​B,​C></th> |
| <td class="colLast"> |
| <div class="block">All user supplied transformation functions have to be serializable.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SerializableBinaryOperator.html" title="interface in org.apache.heron.streamlet">SerializableBinaryOperator</a><T></th> |
| <td class="colLast"> |
| <div class="block">All user supplied transformation functions have to be serializable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SerializableConsumer.html" title="interface in org.apache.heron.streamlet">SerializableConsumer</a><T></th> |
| <td class="colLast"> |
| <div class="block">All user supplied transformation functions have to be serializable.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SerializableFunction.html" title="interface in org.apache.heron.streamlet">SerializableFunction</a><A,​B></th> |
| <td class="colLast"> |
| <div class="block">All user supplied transformation functions have to be serializable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SerializablePredicate.html" title="interface in org.apache.heron.streamlet">SerializablePredicate</a><T></th> |
| <td class="colLast"> |
| <div class="block">All user supplied transformation functions have to be serializable.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SerializableSupplier.html" title="interface in org.apache.heron.streamlet">SerializableSupplier</a><T></th> |
| <td class="colLast"> |
| <div class="block">All user supplied transformation functions have to be serializable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SerializableTransformer.html" title="interface in org.apache.heron.streamlet">SerializableTransformer</a><I,​O></th> |
| <td class="colLast"> |
| <div class="block">All user supplied transformation functions have to be serializable.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Sink.html" title="interface in org.apache.heron.streamlet">Sink</a><T></th> |
| <td class="colLast"> |
| <div class="block">Sink is how Streamlet's end.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Source.html" title="interface in org.apache.heron.streamlet">Source</a><T></th> |
| <td class="colLast"> |
| <div class="block">Source is how Streamlet's originate.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Streamlet.html" title="interface in org.apache.heron.streamlet">Streamlet</a><R></th> |
| <td class="colLast"> |
| <div class="block">A Streamlet is a (potentially unbounded) ordered collection of tuples.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="StreamletBase.html" title="interface in org.apache.heron.streamlet">StreamletBase</a><R></th> |
| <td class="colLast"> |
| <div class="block">A Streamlet is a (potentially unbounded) ordered collection of tuples.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="WindowConfig.html" title="interface in org.apache.heron.streamlet">WindowConfig</a></th> |
| <td class="colLast"> |
| <div class="block">WindowConfig allows Streamlet API users to program window configuration for operations |
| that rely on windowing.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <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"> |
| <th class="colFirst" scope="row"><a href="Config.html" title="class in org.apache.heron.streamlet">Config</a></th> |
| <td class="colLast"> |
| <div class="block">Config is the way users configure the execution of the topology.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Config.Builder.html" title="class in org.apache.heron.streamlet">Config.Builder</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="KeyedWindow.html" title="class in org.apache.heron.streamlet">KeyedWindow</a><T></th> |
| <td class="colLast"> |
| <div class="block">Transformation depending on Windowing pass on the window/key information |
| using this class</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="KeyValue.html" title="class in org.apache.heron.streamlet">KeyValue</a><K,​V></th> |
| <td class="colLast"> |
| <div class="block">Certain operations in the Streamlet API, like join/reduce, necessitate |
| the concept of key value pairs.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Runner.html" title="class in org.apache.heron.streamlet">Runner</a></th> |
| <td class="colLast"> |
| <div class="block">Runner is used to run a topology that is built by the builder.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="StreamletReducers.html" title="class in org.apache.heron.streamlet">StreamletReducers</a></th> |
| <td class="colLast"> |
| <div class="block">This class contains a few standard reduces that can be used with |
| Streamlet reduce functions such as reduceByKeyAndWindow.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="StreamletReducersTest.html" title="class in org.apache.heron.streamlet">StreamletReducersTest</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Window.html" title="class in org.apache.heron.streamlet">Window</a></th> |
| <td class="colLast"> |
| <div class="block">Window is a container containing information about a particular window.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Config.DeliverySemantics.html" title="enum in org.apache.heron.streamlet">Config.DeliverySemantics</a></th> |
| <td class="colLast"> |
| <div class="block">An enum encapsulating the delivery semantics that can be applied to Heron topologies.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Config.Serializer.html" title="enum in org.apache.heron.streamlet">Config.Serializer</a></th> |
| <td class="colLast"> |
| <div class="block">An enum encapsulating the serializers that can be used for data in the topology.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JoinType.html" title="enum in org.apache.heron.streamlet">JoinType</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
