Enum Class ConsumerPartitionAssignor.RebalanceProtocol
- All Implemented Interfaces:
- Enclosing interface:
public static enum ConsumerPartitionAssignor.RebalanceProtocol extends Enum<ConsumerPartitionAssignor.RebalanceProtocol>
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.
ConsumerPartitionAssignorimplementors can claim supporting one or more rebalance protocols via the
ConsumerPartitionAssignor.supportedProtocols(), and it is their responsibility to respect the rules of those protocols in their
ConsumerPartitionAssignor.assign(Cluster, GroupSubscription)implementations. Failures to follow the rules of the supported protocols would lead to runtime error or undefined behavior. The
EAGERrebalance 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.
COOPERATIVErebalance 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.
Nested Class Summary
Enum Constant Summary
Method SummaryModifier and TypeMethodDescription
id()Returns the enum constant of this class with the specified name.
values()Returns an array containing the constants of this enum class, in the order they are declared.
Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Enum Constant Details
valuespublic static ConsumerPartitionAssignor.RebalanceProtocol values()Returns an array containing the constants of this enum class, in the order they are declared.
- an array containing the constants of this enum class, in the order they are declared
valueOfReturns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
idpublic byte id()
forIdpublic static ConsumerPartitionAssignor.RebalanceProtocol forId