Enum Class CloseOptions.GroupMembershipOperation

java.lang.Object

java.lang.Enum<CloseOptions.GroupMembershipOperation>

org.apache.kafka.clients.consumer.CloseOptions.GroupMembershipOperation

All Implemented Interfaces:

Serializable, Comparable<CloseOptions.GroupMembershipOperation>, Constable

Enclosing class:

CloseOptions

public static enum CloseOptions.GroupMembershipOperation
extends Enum<CloseOptions.GroupMembershipOperation>

Enum to specify the group membership operation upon leaving a group.

• LEAVE_GROUP: The consumer will leave the group. This is the default for dynamic members, and can be used by static members when they want to permanently leave the group and trigger a rebalance.
• REMAIN_IN_GROUP: The consumer will remain in the group. This is the default for static members, allowing them to rejoin quickly without triggering a rebalance. When used by dynamic members, no leave heartbeat will be sent and the member will be removed by the coordinator after the session timeout expires.
• DEFAULT: Applies the default behavior:
  • For static members: The consumer will remain in the group.
  • For dynamic members: The consumer will leave the group.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT
LEAVE_GROUP
REMAIN_IN_GROUP

Method Summary

Modifier and Type	Method	Description
static CloseOptions.GroupMembershipOperation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CloseOptions.GroupMembershipOperation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LEAVE_GROUP

public static final CloseOptions.GroupMembershipOperation LEAVE_GROUP

REMAIN_IN_GROUP

public static final CloseOptions.GroupMembershipOperation REMAIN_IN_GROUP

DEFAULT

public static final CloseOptions.GroupMembershipOperation DEFAULT

Method Details

values

public static CloseOptions.GroupMembershipOperation[] 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

public static CloseOptions.GroupMembershipOperation valueOf(String name)

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 name

NullPointerException - if the argument is null