Enum Class ConsumerPartitionAssignor.RebalanceProtocol
java.lang.Object
java.lang.Enum<ConsumerPartitionAssignor.RebalanceProtocol>
org.apache.kafka.clients.consumer.ConsumerPartitionAssignor.RebalanceProtocol
- All Implemented Interfaces:
Serializable,Comparable<ConsumerPartitionAssignor.RebalanceProtocol>,Constable
- Enclosing interface:
ConsumerPartitionAssignor
public static enum ConsumerPartitionAssignor.RebalanceProtocolextends 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.
ConsumerPartitionAssignor implementors 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 EAGER 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. COOPERATIVE 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.Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>Enum Constant Summary
Enum ConstantsMethod Summary
Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Enum Constant Details
EAGER
COOPERATIVE
Method Details
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
valueOf
Returns 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.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
id
public byte id()forId