| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TopologyBuilder.BoltGetter (Storm 2.6.2 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.storm.topology, class: TopologyBuilder, class: BoltGetter"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/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="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/TopologyBuilder.BoltGetter.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.topology</a></div> |
| <h1 title="Class TopologyBuilder.BoltGetter" class="title">Class TopologyBuilder.BoltGetter</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="BaseConfigurationDeclarer.html" title="class in org.apache.storm.topology">org.apache.storm.topology.BaseConfigurationDeclarer</a><T> |
| <div class="inheritance"><a href="TopologyBuilder.ConfigGetter.html" title="class in org.apache.storm.topology">org.apache.storm.topology.TopologyBuilder.ConfigGetter</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>> |
| <div class="inheritance">org.apache.storm.topology.TopologyBuilder.BoltGetter</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code>, <code><a href="ComponentConfigurationDeclarer.html" title="interface in org.apache.storm.topology">ComponentConfigurationDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code>, <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code>, <code><a href="ResourceDeclarer.html" title="interface in org.apache.storm.topology">ResourceDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="TopologyBuilder.html" title="class in org.apache.storm.topology">TopologyBuilder</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">protected class </span><span class="element-name type-name-label">TopologyBuilder.BoltGetter</span> |
| <span class="extends-implements">extends <a href="TopologyBuilder.ConfigGetter.html" title="class in org.apache.storm.topology">TopologyBuilder.ConfigGetter</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>> |
| implements <a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">BoltGetter</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> boltId)</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#allGrouping(java.lang.String)" class="member-name-link">allGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The stream is replicated across all the bolt's tasks.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#allGrouping(java.lang.String,java.lang.String)" class="member-name-link">allGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The stream is replicated across all the bolt's tasks.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#customGrouping(java.lang.String,java.lang.String,org.apache.storm.grouping.CustomStreamGrouping)" class="member-name-link">customGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId, |
| <a href="../grouping/CustomStreamGrouping.html" title="interface in org.apache.storm.grouping">CustomStreamGrouping</a> grouping)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A custom stream grouping by implementing the CustomStreamGrouping interface.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#customGrouping(java.lang.String,org.apache.storm.grouping.CustomStreamGrouping)" class="member-name-link">customGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="../grouping/CustomStreamGrouping.html" title="interface in org.apache.storm.grouping">CustomStreamGrouping</a> grouping)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A custom stream grouping by implementing the CustomStreamGrouping interface.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#directGrouping(java.lang.String)" class="member-name-link">directGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#directGrouping(java.lang.String,java.lang.String)" class="member-name-link">directGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fieldsGrouping(java.lang.String,java.lang.String,org.apache.storm.tuple.Fields)" class="member-name-link">fieldsGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId, |
| <a href="../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The stream is partitioned by the fields specified in the grouping.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fieldsGrouping(java.lang.String,org.apache.storm.tuple.Fields)" class="member-name-link">fieldsGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The stream is partitioned by the fields specified in the grouping.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#globalGrouping(java.lang.String)" class="member-name-link">globalGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The entire stream goes to a single one of the bolt's tasks.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#globalGrouping(java.lang.String,java.lang.String)" class="member-name-link">globalGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The entire stream goes to a single one of the bolt's tasks.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#grouping(org.apache.storm.generated.GlobalStreamId,org.apache.storm.generated.Grouping)" class="member-name-link">grouping</a><wbr>(<a href="../generated/GlobalStreamId.html" title="class in org.apache.storm.generated">GlobalStreamId</a> id, |
| <a href="../generated/Grouping.html" title="class in org.apache.storm.generated">Grouping</a> grouping)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#localOrShuffleGrouping(java.lang.String)" class="member-name-link">localOrShuffleGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#localOrShuffleGrouping(java.lang.String,java.lang.String)" class="member-name-link">localOrShuffleGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#noneGrouping(java.lang.String)" class="member-name-link">noneGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This grouping specifies that you don't care how the stream is grouped.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#noneGrouping(java.lang.String,java.lang.String)" class="member-name-link">noneGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This grouping specifies that you don't care how the stream is grouped.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#partialKeyGrouping(java.lang.String,java.lang.String,org.apache.storm.tuple.Fields)" class="member-name-link">partialKeyGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId, |
| <a href="../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#partialKeyGrouping(java.lang.String,org.apache.storm.tuple.Fields)" class="member-name-link">partialKeyGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shuffleGrouping(java.lang.String)" class="member-name-link">shuffleGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shuffleGrouping(java.lang.String,java.lang.String)" class="member-name-link">shuffleGrouping</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.topology.TopologyBuilder.ConfigGetter">Methods inherited from class org.apache.storm.topology.<a href="TopologyBuilder.ConfigGetter.html" title="class in org.apache.storm.topology">TopologyBuilder.ConfigGetter</a></h3> |
| <code><a href="TopologyBuilder.ConfigGetter.html#addConfigurations(java.util.Map)">addConfigurations</a>, <a href="TopologyBuilder.ConfigGetter.html#addResource(java.lang.String,java.lang.Number)">addResource</a>, <a href="TopologyBuilder.ConfigGetter.html#addResources(java.util.Map)">addResources</a>, <a href="TopologyBuilder.ConfigGetter.html#addSharedMemory(org.apache.storm.generated.SharedMemory)">addSharedMemory</a>, <a href="TopologyBuilder.ConfigGetter.html#getComponentConfiguration()">getComponentConfiguration</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.topology.BaseConfigurationDeclarer">Methods inherited from class org.apache.storm.topology.<a href="BaseConfigurationDeclarer.html" title="class in org.apache.storm.topology">BaseConfigurationDeclarer</a></h3> |
| <code><a href="BaseConfigurationDeclarer.html#addConfiguration(java.lang.String,java.lang.Object)">addConfiguration</a>, <a href="BaseConfigurationDeclarer.html#setCPULoad(java.lang.Number)">setCPULoad</a>, <a href="BaseConfigurationDeclarer.html#setDebug(boolean)">setDebug</a>, <a href="BaseConfigurationDeclarer.html#setMaxSpoutPending(java.lang.Number)">setMaxSpoutPending</a>, <a href="BaseConfigurationDeclarer.html#setMaxTaskParallelism(java.lang.Number)">setMaxTaskParallelism</a>, <a href="BaseConfigurationDeclarer.html#setMemoryLoad(java.lang.Number)">setMemoryLoad</a>, <a href="BaseConfigurationDeclarer.html#setMemoryLoad(java.lang.Number,java.lang.Number)">setMemoryLoad</a>, <a href="BaseConfigurationDeclarer.html#setNumTasks(java.lang.Number)">setNumTasks</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.topology.ComponentConfigurationDeclarer">Methods inherited from interface org.apache.storm.topology.<a href="ComponentConfigurationDeclarer.html" title="interface in org.apache.storm.topology">ComponentConfigurationDeclarer</a></h3> |
| <code><a href="ComponentConfigurationDeclarer.html#addConfiguration(java.lang.String,java.lang.Object)">addConfiguration</a>, <a href="ComponentConfigurationDeclarer.html#addConfigurations(java.util.Map)">addConfigurations</a>, <a href="ComponentConfigurationDeclarer.html#addResource(java.lang.String,java.lang.Number)">addResource</a>, <a href="ComponentConfigurationDeclarer.html#addResources(java.util.Map)">addResources</a>, <a href="ComponentConfigurationDeclarer.html#getComponentConfiguration()">getComponentConfiguration</a>, <a href="ComponentConfigurationDeclarer.html#setDebug(boolean)">setDebug</a>, <a href="ComponentConfigurationDeclarer.html#setMaxSpoutPending(java.lang.Number)">setMaxSpoutPending</a>, <a href="ComponentConfigurationDeclarer.html#setMaxTaskParallelism(java.lang.Number)">setMaxTaskParallelism</a>, <a href="ComponentConfigurationDeclarer.html#setNumTasks(java.lang.Number)">setNumTasks</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.topology.ResourceDeclarer">Methods inherited from interface org.apache.storm.topology.<a href="ResourceDeclarer.html" title="interface in org.apache.storm.topology">ResourceDeclarer</a></h3> |
| <code><a href="ResourceDeclarer.html#addSharedMemory(org.apache.storm.generated.SharedMemory)">addSharedMemory</a>, <a href="ResourceDeclarer.html#setCPULoad(java.lang.Number)">setCPULoad</a>, <a href="ResourceDeclarer.html#setMemoryLoad(java.lang.Number)">setMemoryLoad</a>, <a href="ResourceDeclarer.html#setMemoryLoad(java.lang.Number,java.lang.Number)">setMemoryLoad</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.String)"> |
| <h3>BoltGetter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">BoltGetter</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> boltId)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="fieldsGrouping(java.lang.String,org.apache.storm.tuple.Fields)"> |
| <h3>fieldsGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">fieldsGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#fieldsGrouping(java.lang.String,org.apache.storm.tuple.Fields)">InputDeclarer</a></code></span></div> |
| <div class="block">The stream is partitioned by the fields specified in the grouping.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#fieldsGrouping(java.lang.String,org.apache.storm.tuple.Fields)">fieldsGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fieldsGrouping(java.lang.String,java.lang.String,org.apache.storm.tuple.Fields)"> |
| <h3>fieldsGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">fieldsGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId, |
| <a href="../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#fieldsGrouping(java.lang.String,java.lang.String,org.apache.storm.tuple.Fields)">InputDeclarer</a></code></span></div> |
| <div class="block">The stream is partitioned by the fields specified in the grouping.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#fieldsGrouping(java.lang.String,java.lang.String,org.apache.storm.tuple.Fields)">fieldsGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="globalGrouping(java.lang.String)"> |
| <h3>globalGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">globalGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#globalGrouping(java.lang.String)">InputDeclarer</a></code></span></div> |
| <div class="block">The entire stream goes to a single one of the bolt's tasks. Specifically, it goes to the task with the lowest id.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#globalGrouping(java.lang.String)">globalGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="globalGrouping(java.lang.String,java.lang.String)"> |
| <h3>globalGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">globalGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#globalGrouping(java.lang.String,java.lang.String)">InputDeclarer</a></code></span></div> |
| <div class="block">The entire stream goes to a single one of the bolt's tasks. Specifically, it goes to the task with the lowest id.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#globalGrouping(java.lang.String,java.lang.String)">globalGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shuffleGrouping(java.lang.String)"> |
| <h3>shuffleGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">shuffleGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#shuffleGrouping(java.lang.String)">InputDeclarer</a></code></span></div> |
| <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> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#shuffleGrouping(java.lang.String)">shuffleGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shuffleGrouping(java.lang.String,java.lang.String)"> |
| <h3>shuffleGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">shuffleGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#shuffleGrouping(java.lang.String,java.lang.String)">InputDeclarer</a></code></span></div> |
| <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> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#shuffleGrouping(java.lang.String,java.lang.String)">shuffleGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="localOrShuffleGrouping(java.lang.String)"> |
| <h3>localOrShuffleGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">localOrShuffleGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#localOrShuffleGrouping(java.lang.String)">InputDeclarer</a></code></span></div> |
| <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. |
| Otherwise, this acts like a normal shuffle grouping.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#localOrShuffleGrouping(java.lang.String)">localOrShuffleGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="localOrShuffleGrouping(java.lang.String,java.lang.String)"> |
| <h3>localOrShuffleGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">localOrShuffleGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#localOrShuffleGrouping(java.lang.String,java.lang.String)">InputDeclarer</a></code></span></div> |
| <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. |
| Otherwise, this acts like a normal shuffle grouping.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#localOrShuffleGrouping(java.lang.String,java.lang.String)">localOrShuffleGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="noneGrouping(java.lang.String)"> |
| <h3>noneGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">noneGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#noneGrouping(java.lang.String)">InputDeclarer</a></code></span></div> |
| <div class="block">This grouping specifies that you don't care how the stream is grouped.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#noneGrouping(java.lang.String)">noneGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="noneGrouping(java.lang.String,java.lang.String)"> |
| <h3>noneGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">noneGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#noneGrouping(java.lang.String,java.lang.String)">InputDeclarer</a></code></span></div> |
| <div class="block">This grouping specifies that you don't care how the stream is grouped.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#noneGrouping(java.lang.String,java.lang.String)">noneGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="allGrouping(java.lang.String)"> |
| <h3>allGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">allGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#allGrouping(java.lang.String)">InputDeclarer</a></code></span></div> |
| <div class="block">The stream is replicated across all the bolt's tasks. Use this grouping with care.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#allGrouping(java.lang.String)">allGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="allGrouping(java.lang.String,java.lang.String)"> |
| <h3>allGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">allGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#allGrouping(java.lang.String,java.lang.String)">InputDeclarer</a></code></span></div> |
| <div class="block">The stream is replicated across all the bolt's tasks. Use this grouping with care.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#allGrouping(java.lang.String,java.lang.String)">allGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="directGrouping(java.lang.String)"> |
| <h3>directGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">directGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#directGrouping(java.lang.String)">InputDeclarer</a></code></span></div> |
| <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> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#directGrouping(java.lang.String)">directGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="directGrouping(java.lang.String,java.lang.String)"> |
| <h3>directGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">directGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#directGrouping(java.lang.String,java.lang.String)">InputDeclarer</a></code></span></div> |
| <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> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#directGrouping(java.lang.String,java.lang.String)">directGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="grouping(org.apache.storm.generated.GlobalStreamId,org.apache.storm.generated.Grouping)"> |
| <h3>grouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">grouping</span><wbr><span class="parameters">(<a href="../generated/GlobalStreamId.html" title="class in org.apache.storm.generated">GlobalStreamId</a> id, |
| <a href="../generated/Grouping.html" title="class in org.apache.storm.generated">Grouping</a> grouping)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#grouping(org.apache.storm.generated.GlobalStreamId,org.apache.storm.generated.Grouping)">grouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="partialKeyGrouping(java.lang.String,org.apache.storm.tuple.Fields)"> |
| <h3>partialKeyGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">partialKeyGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#partialKeyGrouping(java.lang.String,org.apache.storm.tuple.Fields)">InputDeclarer</a></code></span></div> |
| <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. |
| |
| <p>See https://melmeric.files.wordpress.com/2014/11/the-power-of-both-choices-practical-load-balancing-for-distributed-stream |
| -processing-engines.pdf</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#partialKeyGrouping(java.lang.String,org.apache.storm.tuple.Fields)">partialKeyGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="partialKeyGrouping(java.lang.String,java.lang.String,org.apache.storm.tuple.Fields)"> |
| <h3>partialKeyGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">partialKeyGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId, |
| <a href="../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a> fields)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#partialKeyGrouping(java.lang.String,java.lang.String,org.apache.storm.tuple.Fields)">InputDeclarer</a></code></span></div> |
| <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. |
| |
| <p>See https://melmeric.files.wordpress.com/2014/11/the-power-of-both-choices-practical-load-balancing-for-distributed-stream |
| -processing-engines.pdf</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#partialKeyGrouping(java.lang.String,java.lang.String,org.apache.storm.tuple.Fields)">partialKeyGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="customGrouping(java.lang.String,org.apache.storm.grouping.CustomStreamGrouping)"> |
| <h3>customGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">customGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="../grouping/CustomStreamGrouping.html" title="interface in org.apache.storm.grouping">CustomStreamGrouping</a> grouping)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#customGrouping(java.lang.String,org.apache.storm.grouping.CustomStreamGrouping)">InputDeclarer</a></code></span></div> |
| <div class="block">A custom stream grouping by implementing the CustomStreamGrouping interface.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#customGrouping(java.lang.String,org.apache.storm.grouping.CustomStreamGrouping)">customGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="customGrouping(java.lang.String,java.lang.String,org.apache.storm.grouping.CustomStreamGrouping)"> |
| <h3>customGrouping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></span> <span class="element-name">customGrouping</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> componentId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId, |
| <a href="../grouping/CustomStreamGrouping.html" title="interface in org.apache.storm.grouping">CustomStreamGrouping</a> grouping)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InputDeclarer.html#customGrouping(java.lang.String,java.lang.String,org.apache.storm.grouping.CustomStreamGrouping)">InputDeclarer</a></code></span></div> |
| <div class="block">A custom stream grouping by implementing the CustomStreamGrouping interface.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InputDeclarer.html#customGrouping(java.lang.String,java.lang.String,org.apache.storm.grouping.CustomStreamGrouping)">customGrouping</a></code> in interface <code><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a><<a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
