| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ConsumerPartitionAssignor.RebalanceProtocol (kafka 3.0.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.kafka.clients.consumer, interface: ConsumerPartitionAssignor, enum: RebalanceProtocol"> |
| <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 data = {"i0":9,"i1":10,"i2":9,"i3":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "alt-color"; |
| var rowColor = "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">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><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" 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="Enum ConsumerPartitionAssignor.RebalanceProtocol" class="title">Enum ConsumerPartitionAssignor.RebalanceProtocol</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/15/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="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="ConsumerPartitionAssignor.RebalanceProtocol.html" title="enum in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.RebalanceProtocol</a>> |
| <div class="inheritance">org.apache.kafka.clients.consumer.ConsumerPartitionAssignor.RebalanceProtocol</div> |
| </div> |
| </div> |
| <section class="description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="ConsumerPartitionAssignor.RebalanceProtocol.html" title="enum in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.RebalanceProtocol</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="ConsumerPartitionAssignor.html" title="interface in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor</a></dd> |
| </dl> |
| <hr> |
| <pre>public static enum <span class="type-name-label">ConsumerPartitionAssignor.RebalanceProtocol</span> |
| extends <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="ConsumerPartitionAssignor.RebalanceProtocol.html" title="enum in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.RebalanceProtocol</a>></pre> |
| <div class="block">The rebalance protocol defines partition assignment and revocation semantics. The purpose is to establish a |
| consistent set of rules that all consumers in a group follow in order to transfer ownership of a partition. |
| <a href="ConsumerPartitionAssignor.html" title="interface in org.apache.kafka.clients.consumer"><code>ConsumerPartitionAssignor</code></a> implementors can claim supporting one or more rebalance protocols via the |
| <a href="ConsumerPartitionAssignor.html#supportedProtocols()"><code>ConsumerPartitionAssignor.supportedProtocols()</code></a>, and it is their responsibility to respect the rules |
| of those protocols in their <a href="ConsumerPartitionAssignor.html#assign(org.apache.kafka.common.Cluster,org.apache.kafka.clients.consumer.ConsumerPartitionAssignor.GroupSubscription)"><code>ConsumerPartitionAssignor.assign(Cluster, GroupSubscription)</code></a> implementations. |
| Failures to follow the rules of the supported protocols would lead to runtime error or undefined behavior. |
| |
| The <a href="#EAGER"><code>EAGER</code></a> rebalance protocol requires a consumer to always revoke all its owned |
| partitions before participating in a rebalance event. It therefore allows a complete reshuffling of the assignment. |
| |
| <a href="#COOPERATIVE"><code>COOPERATIVE</code></a> rebalance protocol allows a consumer to retain its currently owned |
| partitions before participating in a rebalance event. The assignor should not reassign any owned partitions |
| immediately, but instead may indicate consumers the need for partition revocation so that the revoked |
| partitions can be reassigned to other consumers in the next rebalance event. This is designed for sticky assignment |
| logic which attempts to minimize partition reassignment with cooperative adjustments.</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="inherited-list"> |
| <h2 id="nested.classes.inherited.from.class.java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> |
| <code><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> |
| </section> |
| </li> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <li> |
| <section class="constants-summary" id="enum.constant.summary"> |
| <h2>Enum Constant Summary</h2> |
| <div class="member-summary"> |
| <table class="summary-table"> |
| <caption><span>Enum Constants</span></caption> |
| <thead> |
| <tr> |
| <th class="col-first" scope="col">Enum Constant</th> |
| <th class="col-last" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="alt-color"> |
| <th class="col-first" scope="row"><code><span class="member-name-link"><a href="#COOPERATIVE">COOPERATIVE</a></span></code></th> |
| <td class="col-last"> </td> |
| </tr> |
| <tr class="row-color"> |
| <th class="col-first" scope="row"><code><span class="member-name-link"><a href="#EAGER">EAGER</a></span></code></th> |
| <td class="col-last"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method.summary"> |
| <h2>Method Summary</h2> |
| <div class="member-summary" id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="active-table-tab">All Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="table-tab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="table-tab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="table-tab" onclick="show(8);">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <table class="summary-table" aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="col-first" scope="col">Modifier and Type</th> |
| <th class="col-second" scope="col">Method</th> |
| <th class="col-last" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="alt-color" id="i0"> |
| <td class="col-first"><code>static <a href="ConsumerPartitionAssignor.RebalanceProtocol.html" title="enum in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.RebalanceProtocol</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#forId(byte)">forId</a></span>​(byte id)</code></th> |
| <td class="col-last"> </td> |
| </tr> |
| <tr class="row-color" id="i1"> |
| <td class="col-first"><code>byte</code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#id()">id</a></span>()</code></th> |
| <td class="col-last"> </td> |
| </tr> |
| <tr class="alt-color" id="i2"> |
| <td class="col-first"><code>static <a href="ConsumerPartitionAssignor.RebalanceProtocol.html" title="enum in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.RebalanceProtocol</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#valueOf(java.lang.String)">valueOf</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></th> |
| <td class="col-last"> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i3"> |
| <td class="col-first"><code>static <a href="ConsumerPartitionAssignor.RebalanceProtocol.html" title="enum in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.RebalanceProtocol</a>[]</code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#values()">values</a></span>()</code></th> |
| <td class="col-last"> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.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/15/docs/api/java.base/java/lang/Enum.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</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/15/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/15/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/15/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/15/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/15/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/15/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/15/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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <li> |
| <section class="constant-details" id="enum.constant.detail"> |
| <h2>Enum Constant Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="EAGER"> |
| <h3>EAGER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ConsumerPartitionAssignor.RebalanceProtocol.html" title="enum in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.RebalanceProtocol</a></span> <span class="member-name">EAGER</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="COOPERATIVE"> |
| <h3>COOPERATIVE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ConsumerPartitionAssignor.RebalanceProtocol.html" title="enum in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.RebalanceProtocol</a></span> <span class="member-name">COOPERATIVE</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="values()"> |
| <h3>values</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ConsumerPartitionAssignor.RebalanceProtocol.html" title="enum in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.RebalanceProtocol</a>[]</span> <span class="member-name">values</span>()</div> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="valueOf(java.lang.String)"> |
| <h3>valueOf</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ConsumerPartitionAssignor.RebalanceProtocol.html" title="enum in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.RebalanceProtocol</a></span> <span class="member-name">valueOf</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block">Returns the enum constant of this type with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt>Returns:</dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="id()"> |
| <h3>id</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte</span> <span class="member-name">id</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="forId(byte)"> |
| <h3>forId</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ConsumerPartitionAssignor.RebalanceProtocol.html" title="enum in org.apache.kafka.clients.consumer">ConsumerPartitionAssignor.RebalanceProtocol</a></span> <span class="member-name">forId</span>​(<span class="parameters">byte id)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottom-nav" id="navbar.bottom"> |
| <div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar.bottom.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">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><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <span class="skip-nav" id="skip.navbar.bottom"> |
| <!-- --> |
| </span></nav> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
