Enum Class GroupProtocol

java.lang.Object

java.lang.Enum<GroupProtocol>

org.apache.kafka.clients.consumer.GroupProtocol

All Implemented Interfaces:

Serializable, Comparable<GroupProtocol>, Constable

@Public
public enum GroupProtocol
extends Enum<GroupProtocol>

Enum representing the supported consumer group protocols.

• CLASSIC - The Classic consumer group protocol (pre KIP-848)
• CONSUMER - The Consumer rebalance protocol (KIP-848)

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLASSIC	Classic group protocol.
CONSUMER	Consumer group protocol

Field Summary

Fields

Modifier and Type	Field	Description
final String	name	String representation of the group protocol.

Method Summary

Modifier and Type	Method	Description
static GroupProtocol	of(String name)	Case-insensitive group protocol lookup by string name.
static GroupProtocol	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GroupProtocol[]	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

CLASSIC

public static final GroupProtocol CLASSIC

Classic group protocol.

CONSUMER

public static final GroupProtocol CONSUMER

Consumer group protocol

Field Details

name

public final String name

String representation of the group protocol.

Method Details

values

public static GroupProtocol[] 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 GroupProtocol 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

of

public static GroupProtocol of(String name)

Case-insensitive group protocol lookup by string name.

Parameters:

name - The name of the group protocol

Returns:

The corresponding GroupProtocol

Throws:

IllegalArgumentException - If the name does not match any protocol