Enum Class CloseOptions.GroupMembershipOperation

java.lang.Object

java.lang.Enum<CloseOptions.GroupMembershipOperation>

org.apache.kafka.streams.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 closing the Kafka Streams application.

• DEFAULT: Applies the default behavior based on the active protocol and membership type:
  • For the classic protocol: The consumer will remain in the group.
  • For the streams protocol (group.protocol=streams):
    • Dynamic members: The consumer will leave the group (consistent with the protocol's design for dynamic members).
    • Static members: The consumer will remain in the group until session timeout (consistent with static membership semantics).
• LEAVE_GROUP: The consumer will explicitly leave the group, regardless of the active protocol.
• REMAIN_IN_GROUP: The consumer will remain in the group, regardless of the active protocol. Under the streams protocol, this enables a faster rebalance upon restart for static members.

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

DEFAULT

public static final CloseOptions.GroupMembershipOperation DEFAULT

LEAVE_GROUP

public static final CloseOptions.GroupMembershipOperation LEAVE_GROUP

REMAIN_IN_GROUP

public static final CloseOptions.GroupMembershipOperation REMAIN_IN_GROUP

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