| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ConsumerPartitionAssignor (kafka 3.6.1 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.kafka.clients.consumer, interface: ConsumerPartitionAssignor"> |
| <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.5.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="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><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.kafka.clients.consumer</a></div> |
| <h1 title="Interface ConsumerPartitionAssignor" class="title">Interface ConsumerPartitionAssignor</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code>org.apache.kafka.clients.consumer.internals.AbstractPartitionAssignor</code>, <code>org.apache.kafka.clients.consumer.internals.AbstractStickyAssignor</code>, <code><a href="CooperativeStickyAssignor.html" title="class in org.apache.kafka.clients.consumer">CooperativeStickyAssignor</a></code>, <code><a href="RangeAssignor.html" title="class in org.apache.kafka.clients.consumer">RangeAssignor</a></code>, <code><a href="RoundRobinAssignor.html" title="class in org.apache.kafka.clients.consumer">RoundRobinAssignor</a></code>, <code><a href="StickyAssignor.html" title="class in org.apache.kafka.clients.consumer">StickyAssignor</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ConsumerPartitionAssignor</span></div> |
| <div class="block">This interface is used to define custom partition assignment for use in |
| <a href="KafkaConsumer.html" title="class in org.apache.kafka.clients.consumer"><code>KafkaConsumer</code></a>. Members of the consumer group subscribe |
| to the topics they are interested in and forward their subscriptions to a Kafka broker serving |
| as the group coordinator. The coordinator selects one member to perform the group assignment and |
| propagates the subscriptions of all members to it. Then <a href="#assign(org.apache.kafka.common.Cluster,org.apache.kafka.clients.consumer.ConsumerPartitionAssignor.GroupSubscription)"><code>assign(Cluster, GroupSubscription)</code></a> is called |
| to perform the assignment and the results are forwarded back to each respective members |
| <p> |
| In some cases, it is useful to forward additional metadata to the assignor in order to make |
| assignment decisions. For this, you can override <a href="#subscriptionUserData(java.util.Set)"><code>subscriptionUserData(Set)</code></a> and provide custom |
| userData in the returned Subscription. For example, to have a rack-aware assignor, an implementation |
| can use this user data to forward the rackId belonging to each member. |
| <p> |
| The implementation can extend <a href="../../common/Configurable.html" title="interface in org.apache.kafka.common"><code>Configurable</code></a> to get configs from consumer.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final class </code></div> |
| <div class="col-second even-row-color"><code><a href="ConsumerPartitionAssignor.Assignment.html" class="type-name-link" title="class in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.Assignment</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final class </code></div> |
| <div class="col-second odd-row-color"><code><a href="ConsumerPartitionAssignor.GroupAssignment.html" class="type-name-link" title="class in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.GroupAssignment</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final class </code></div> |
| <div class="col-second even-row-color"><code><a href="ConsumerPartitionAssignor.GroupSubscription.html" class="type-name-link" title="class in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.GroupSubscription</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static enum </code></div> |
| <div class="col-second odd-row-color"><code><a href="ConsumerPartitionAssignor.RebalanceProtocol.html" class="type-name-link" title="enum class in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.RebalanceProtocol</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The rebalance protocol defines partition assignment and revocation semantics.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final class </code></div> |
| <div class="col-second even-row-color"><code><a href="ConsumerPartitionAssignor.Subscription.html" class="type-name-link" title="class in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.Subscription</a></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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab3"><code><a href="ConsumerPartitionAssignor.GroupAssignment.html" title="class in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.GroupAssignment</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#assign(org.apache.kafka.common.Cluster,org.apache.kafka.clients.consumer.ConsumerPartitionAssignor.GroupSubscription)" class="member-name-link">assign</a><wbr>(<a href="../../common/Cluster.html" title="class in org.apache.kafka.common">Cluster</a> metadata, |
| <a href="ConsumerPartitionAssignor.GroupSubscription.html" title="class in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.GroupSubscription</a> groupSubscription)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Perform the group assignment given the member subscriptions and current cluster metadata.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ConsumerPartitionAssignor.html" title="interface in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#getAssignorInstances(java.util.List,java.util.Map)" class="member-name-link">getAssignorInstances</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> assignorClasses, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> configs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Get a list of configured instances of <a href="ConsumerPartitionAssignor.html" title="interface in org.apache.kafka.clients.consumer"><code>ConsumerPartitionAssignor</code></a> |
| based on the class names/types specified by <a href="ConsumerConfig.html#PARTITION_ASSIGNMENT_STRATEGY_CONFIG"><code>ConsumerConfig.PARTITION_ASSIGNMENT_STRATEGY_CONFIG</code></a></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#name()" class="member-name-link">name</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Unique name for this assignor (e.g.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#onAssignment(org.apache.kafka.clients.consumer.ConsumerPartitionAssignor.Assignment,org.apache.kafka.clients.consumer.ConsumerGroupMetadata)" class="member-name-link">onAssignment</a><wbr>(<a href="ConsumerPartitionAssignor.Assignment.html" title="class in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.Assignment</a> assignment, |
| <a href="ConsumerGroupMetadata.html" title="class in org.apache.kafka.clients.consumer">ConsumerGroupMetadata</a> metadata)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Callback which is invoked when a group member receives its assignment from the leader.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#subscriptionUserData(java.util.Set)" class="member-name-link">subscriptionUserData</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> topics)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Return serialized data that will be included in the <a href="ConsumerPartitionAssignor.Subscription.html" title="class in org.apache.kafka.clients.consumer"><code>ConsumerPartitionAssignor.Subscription</code></a> sent to the leader |
| and can be leveraged in <a href="#assign(org.apache.kafka.common.Cluster,org.apache.kafka.clients.consumer.ConsumerPartitionAssignor.GroupSubscription)"><code>assign(Cluster, GroupSubscription)</code></a> ((e.g.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ConsumerPartitionAssignor.RebalanceProtocol.html" title="enum class in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.RebalanceProtocol</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#supportedProtocols()" class="member-name-link">supportedProtocols</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Indicate which rebalance protocol this assignor works with; |
| By default it should always work with <a href="ConsumerPartitionAssignor.RebalanceProtocol.html#EAGER"><code>ConsumerPartitionAssignor.RebalanceProtocol.EAGER</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default short</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#version()" class="member-name-link">version</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Return the version of the assignor which indicates how the user metadata encodings |
| and the assignment algorithm gets evolved.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="subscriptionUserData(java.util.Set)"> |
| <h3>subscriptionUserData</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a></span> <span class="element-name">subscriptionUserData</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> topics)</span></div> |
| <div class="block">Return serialized data that will be included in the <a href="ConsumerPartitionAssignor.Subscription.html" title="class in org.apache.kafka.clients.consumer"><code>ConsumerPartitionAssignor.Subscription</code></a> sent to the leader |
| and can be leveraged in <a href="#assign(org.apache.kafka.common.Cluster,org.apache.kafka.clients.consumer.ConsumerPartitionAssignor.GroupSubscription)"><code>assign(Cluster, GroupSubscription)</code></a> ((e.g. local host/rack information)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topics</code> - Topics subscribed to through <a href="KafkaConsumer.html#subscribe(java.util.Collection)"><code>KafkaConsumer.subscribe(java.util.Collection)</code></a> |
| and variants</dd> |
| <dt>Returns:</dt> |
| <dd>nullable subscription user data</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="assign(org.apache.kafka.common.Cluster,org.apache.kafka.clients.consumer.ConsumerPartitionAssignor.GroupSubscription)"> |
| <h3>assign</h3> |
| <div class="member-signature"><span class="return-type"><a href="ConsumerPartitionAssignor.GroupAssignment.html" title="class in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.GroupAssignment</a></span> <span class="element-name">assign</span><wbr><span class="parameters">(<a href="../../common/Cluster.html" title="class in org.apache.kafka.common">Cluster</a> metadata, |
| <a href="ConsumerPartitionAssignor.GroupSubscription.html" title="class in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.GroupSubscription</a> groupSubscription)</span></div> |
| <div class="block">Perform the group assignment given the member subscriptions and current cluster metadata.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>metadata</code> - Current topic/broker metadata known by consumer</dd> |
| <dd><code>groupSubscription</code> - Subscriptions from all members including metadata provided through <a href="#subscriptionUserData(java.util.Set)"><code>subscriptionUserData(Set)</code></a></dd> |
| <dt>Returns:</dt> |
| <dd>A map from the members to their respective assignments. This should have one entry |
| for each member in the input subscription map.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onAssignment(org.apache.kafka.clients.consumer.ConsumerPartitionAssignor.Assignment,org.apache.kafka.clients.consumer.ConsumerGroupMetadata)"> |
| <h3>onAssignment</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name">onAssignment</span><wbr><span class="parameters">(<a href="ConsumerPartitionAssignor.Assignment.html" title="class in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.Assignment</a> assignment, |
| <a href="ConsumerGroupMetadata.html" title="class in org.apache.kafka.clients.consumer">ConsumerGroupMetadata</a> metadata)</span></div> |
| <div class="block">Callback which is invoked when a group member receives its assignment from the leader.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>assignment</code> - The local member's assignment as provided by the leader in <a href="#assign(org.apache.kafka.common.Cluster,org.apache.kafka.clients.consumer.ConsumerPartitionAssignor.GroupSubscription)"><code>assign(Cluster, GroupSubscription)</code></a></dd> |
| <dd><code>metadata</code> - Additional metadata on the consumer (optional)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="supportedProtocols()"> |
| <h3>supportedProtocols</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ConsumerPartitionAssignor.RebalanceProtocol.html" title="enum class in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.RebalanceProtocol</a>></span> <span class="element-name">supportedProtocols</span>()</div> |
| <div class="block">Indicate which rebalance protocol this assignor works with; |
| By default it should always work with <a href="ConsumerPartitionAssignor.RebalanceProtocol.html#EAGER"><code>ConsumerPartitionAssignor.RebalanceProtocol.EAGER</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="version()"> |
| <h3>version</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">short</span> <span class="element-name">version</span>()</div> |
| <div class="block">Return the version of the assignor which indicates how the user metadata encodings |
| and the assignment algorithm gets evolved.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="name()"> |
| <h3>name</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">name</span>()</div> |
| <div class="block">Unique name for this assignor (e.g. "range" or "roundrobin" or "sticky"). Note, this is not required |
| to be the same as the class name specified in <a href="ConsumerConfig.html#PARTITION_ASSIGNMENT_STRATEGY_CONFIG"><code>ConsumerConfig.PARTITION_ASSIGNMENT_STRATEGY_CONFIG</code></a></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>non-null unique name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAssignorInstances(java.util.List,java.util.Map)"> |
| <h3>getAssignorInstances</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ConsumerPartitionAssignor.html" title="interface in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor</a>></span> <span class="element-name">getAssignorInstances</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> assignorClasses, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> configs)</span></div> |
| <div class="block">Get a list of configured instances of <a href="ConsumerPartitionAssignor.html" title="interface in org.apache.kafka.clients.consumer"><code>ConsumerPartitionAssignor</code></a> |
| based on the class names/types specified by <a href="ConsumerConfig.html#PARTITION_ASSIGNMENT_STRATEGY_CONFIG"><code>ConsumerConfig.PARTITION_ASSIGNMENT_STRATEGY_CONFIG</code></a></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |