| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>InputDeclarer (Storm 2.1.1 API)</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="InputDeclarer (Storm 2.1.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":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="class-use/InputDeclarer.html">Use</a></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/storm/topology/IComponent.html" title="interface in org.apache.storm.topology"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/storm/topology/IRichBolt.html" title="interface in org.apache.storm.topology"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/storm/topology/InputDeclarer.html" target="_top">Frames</a></li> |
| <li><a href="InputDeclarer.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.storm.topology</div> |
| <h2 title="Interface InputDeclarer" class="title">Interface InputDeclarer<T extends InputDeclarer></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/storm/topology/BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/storm/topology/TopologyBuilder.BoltGetter.html" title="class in org.apache.storm.topology">TopologyBuilder.BoltGetter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">InputDeclarer<T extends InputDeclarer></span></pre> |
| </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/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#allGrouping-java.lang.String-">allGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId)</code> |
| <div class="block">The stream is replicated across all the bolt’s tasks.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#allGrouping-java.lang.String-java.lang.String-">allGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</code> |
| <div class="block">The stream is replicated across all the bolt’s tasks.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#customGrouping-java.lang.String-org.apache.storm.grouping.CustomStreamGrouping-">customGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="../../../../org/apache/storm/grouping/CustomStreamGrouping.html" title="interface in org.apache.storm.grouping">CustomStreamGrouping</a> grouping)</code> |
| <div class="block">A custom stream grouping by implementing the CustomStreamGrouping interface.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#customGrouping-java.lang.String-java.lang.String-org.apache.storm.grouping.CustomStreamGrouping-">customGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="../../../../org/apache/storm/grouping/CustomStreamGrouping.html" title="interface in org.apache.storm.grouping">CustomStreamGrouping</a> grouping)</code> |
| <div class="block">A custom stream grouping by implementing the CustomStreamGrouping interface.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#directGrouping-java.lang.String-">directGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId)</code> |
| <div class="block">A stream grouped this way means that the producer of the tuple decides which task of the consumer will receive this tuple.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#directGrouping-java.lang.String-java.lang.String-">directGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</code> |
| <div class="block">A stream grouped this way means that the producer of the tuple decides which task of the consumer will receive this tuple.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#fieldsGrouping-java.lang.String-org.apache.storm.tuple.Fields-">fieldsGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</code> |
| <div class="block">The stream is partitioned by the fields specified in the grouping.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#fieldsGrouping-java.lang.String-java.lang.String-org.apache.storm.tuple.Fields-">fieldsGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</code> |
| <div class="block">The stream is partitioned by the fields specified in the grouping.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#globalGrouping-java.lang.String-">globalGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId)</code> |
| <div class="block">The entire stream goes to a single one of the bolt’s tasks.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#globalGrouping-java.lang.String-java.lang.String-">globalGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</code> |
| <div class="block">The entire stream goes to a single one of the bolt’s tasks.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#grouping-org.apache.storm.generated.GlobalStreamId-org.apache.storm.generated.Grouping-">grouping</a></span>(<a href="../../../../org/apache/storm/generated/GlobalStreamId.html" title="class in org.apache.storm.generated">GlobalStreamId</a> id, |
| <a href="../../../../org/apache/storm/generated/Grouping.html" title="class in org.apache.storm.generated">Grouping</a> grouping)</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#localOrShuffleGrouping-java.lang.String-">localOrShuffleGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId)</code> |
| <div class="block">If the target bolt has one or more tasks in the same worker process, tuples will be shuffled to just those in-process tasks.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#localOrShuffleGrouping-java.lang.String-java.lang.String-">localOrShuffleGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</code> |
| <div class="block">If the target bolt has one or more tasks in the same worker process, tuples will be shuffled to just those in-process tasks.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#noneGrouping-java.lang.String-">noneGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId)</code> |
| <div class="block">This grouping specifies that you don’t care how the stream is grouped.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#noneGrouping-java.lang.String-java.lang.String-">noneGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</code> |
| <div class="block">This grouping specifies that you don’t care how the stream is grouped.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#partialKeyGrouping-java.lang.String-org.apache.storm.tuple.Fields-">partialKeyGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</code> |
| <div class="block">Tuples are passed to two hashing functions and each target task is decided based on the comparison of the state of candidate nodes.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#partialKeyGrouping-java.lang.String-java.lang.String-org.apache.storm.tuple.Fields-">partialKeyGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</code> |
| <div class="block">Tuples are passed to two hashing functions and each target task is decided based on the comparison of the state of candidate nodes.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#shuffleGrouping-java.lang.String-">shuffleGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId)</code> |
| <div class="block">Tuples are randomly distributed across the bolt’s tasks in a way such that each bolt is guaranteed to get an equal number of tuples.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/topology/InputDeclarer.html#shuffleGrouping-java.lang.String-java.lang.String-">shuffleGrouping</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</code> |
| <div class="block">Tuples are randomly distributed across the bolt’s tasks in a way such that each bolt is guaranteed to get an equal number of tuples.</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="fieldsGrouping-java.lang.String-org.apache.storm.tuple.Fields-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fieldsGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> fieldsGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</pre> |
| <div class="block"><p>The stream is partitioned by the fields specified in the grouping.</p></div> |
| </li> |
| </ul> |
| <a name="fieldsGrouping-java.lang.String-java.lang.String-org.apache.storm.tuple.Fields-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fieldsGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> fieldsGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</pre> |
| <div class="block"><p>The stream is partitioned by the fields specified in the grouping.</p></div> |
| </li> |
| </ul> |
| <a name="globalGrouping-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>globalGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> globalGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId)</pre> |
| <div class="block"><p>The entire stream goes to a single one of the bolt’s tasks. Specifically, it goes to the task with the lowest id.</p></div> |
| </li> |
| </ul> |
| <a name="globalGrouping-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>globalGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> globalGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</pre> |
| <div class="block"><p>The entire stream goes to a single one of the bolt’s tasks. Specifically, it goes to the task with the lowest id.</p></div> |
| </li> |
| </ul> |
| <a name="shuffleGrouping-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shuffleGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> shuffleGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId)</pre> |
| <div class="block"><p>Tuples are randomly distributed across the bolt’s tasks in a way such that each bolt is guaranteed to get an equal number of tuples.</p></div> |
| </li> |
| </ul> |
| <a name="shuffleGrouping-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shuffleGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> shuffleGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</pre> |
| <div class="block"><p>Tuples are randomly distributed across the bolt’s tasks in a way such that each bolt is guaranteed to get an equal number of tuples.</p></div> |
| </li> |
| </ul> |
| <a name="localOrShuffleGrouping-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localOrShuffleGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> localOrShuffleGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId)</pre> |
| <div class="block"><p>If the target bolt has one or more tasks in the same worker process, tuples will be shuffled to just those in-process tasks. Otherwise, this acts like a normal shuffle grouping.</p></div> |
| </li> |
| </ul> |
| <a name="localOrShuffleGrouping-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localOrShuffleGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> localOrShuffleGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</pre> |
| <div class="block"><p>If the target bolt has one or more tasks in the same worker process, tuples will be shuffled to just those in-process tasks. Otherwise, this acts like a normal shuffle grouping.</p></div> |
| </li> |
| </ul> |
| <a name="noneGrouping-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>noneGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> noneGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId)</pre> |
| <div class="block"><p>This grouping specifies that you don’t care how the stream is grouped.</p></div> |
| </li> |
| </ul> |
| <a name="noneGrouping-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>noneGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> noneGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</pre> |
| <div class="block"><p>This grouping specifies that you don’t care how the stream is grouped.</p></div> |
| </li> |
| </ul> |
| <a name="allGrouping-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> allGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId)</pre> |
| <div class="block"><p>The stream is replicated across all the bolt’s tasks. Use this grouping with care.</p></div> |
| </li> |
| </ul> |
| <a name="allGrouping-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> allGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</pre> |
| <div class="block"><p>The stream is replicated across all the bolt’s tasks. Use this grouping with care.</p></div> |
| </li> |
| </ul> |
| <a name="directGrouping-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>directGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> directGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId)</pre> |
| <div class="block"><p>A stream grouped this way means that the producer of the tuple decides which task of the consumer will receive this tuple.</p></div> |
| </li> |
| </ul> |
| <a name="directGrouping-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>directGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> directGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</pre> |
| <div class="block"><p>A stream grouped this way means that the producer of the tuple decides which task of the consumer will receive this tuple.</p></div> |
| </li> |
| </ul> |
| <a name="partialKeyGrouping-java.lang.String-org.apache.storm.tuple.Fields-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>partialKeyGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> partialKeyGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</pre> |
| <div class="block"><p>Tuples are passed to two hashing functions and each target task is decided based on the comparison of the state of candidate nodes.</p><p><p>See <a href="https://melmeric.files.wordpress.com/2014/11/the-power-of-both-choices-practical-load-balancing-for-distributed-stream">https://melmeric.files.wordpress.com/2014/11/the-power-of-both-choices-practical-load-balancing-for-distributed-stream</a> -processing-engines.pdf</p></div> |
| </li> |
| </ul> |
| <a name="partialKeyGrouping-java.lang.String-java.lang.String-org.apache.storm.tuple.Fields-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>partialKeyGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> partialKeyGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="../../../../org/apache/storm/tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</pre> |
| <div class="block"><p>Tuples are passed to two hashing functions and each target task is decided based on the comparison of the state of candidate nodes.</p><p><p>See <a href="https://melmeric.files.wordpress.com/2014/11/the-power-of-both-choices-practical-load-balancing-for-distributed-stream">https://melmeric.files.wordpress.com/2014/11/the-power-of-both-choices-practical-load-balancing-for-distributed-stream</a> -processing-engines.pdf</p></div> |
| </li> |
| </ul> |
| <a name="customGrouping-java.lang.String-org.apache.storm.grouping.CustomStreamGrouping-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>customGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> customGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="../../../../org/apache/storm/grouping/CustomStreamGrouping.html" title="interface in org.apache.storm.grouping">CustomStreamGrouping</a> grouping)</pre> |
| <div class="block"><p>A custom stream grouping by implementing the CustomStreamGrouping interface.</p></div> |
| </li> |
| </ul> |
| <a name="customGrouping-java.lang.String-java.lang.String-org.apache.storm.grouping.CustomStreamGrouping-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>customGrouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> customGrouping(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> componentId, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId, |
| <a href="../../../../org/apache/storm/grouping/CustomStreamGrouping.html" title="interface in org.apache.storm.grouping">CustomStreamGrouping</a> grouping)</pre> |
| <div class="block"><p>A custom stream grouping by implementing the CustomStreamGrouping interface.</p></div> |
| </li> |
| </ul> |
| <a name="grouping-org.apache.storm.generated.GlobalStreamId-org.apache.storm.generated.Grouping-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>grouping</h4> |
| <pre><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="type parameter in InputDeclarer">T</a> grouping(<a href="../../../../org/apache/storm/generated/GlobalStreamId.html" title="class in org.apache.storm.generated">GlobalStreamId</a> id, |
| <a href="../../../../org/apache/storm/generated/Grouping.html" title="class in org.apache.storm.generated">Grouping</a> grouping)</pre> |
| </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="class-use/InputDeclarer.html">Use</a></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 class="aboutLanguage"><script type="text/javascript" src="../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/storm/topology/IComponent.html" title="interface in org.apache.storm.topology"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/storm/topology/IRichBolt.html" title="interface in org.apache.storm.topology"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/storm/topology/InputDeclarer.html" target="_top">Frames</a></li> |
| <li><a href="InputDeclarer.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
