Package org.apache.flink.streaming.connectors.kafka.config

Enum Class OffsetCommitMode

java.lang.Object

java.lang.Enum<OffsetCommitMode>

org.apache.flink.streaming.connectors.kafka.config.OffsetCommitMode

All Implemented Interfaces:

Serializable, Comparable<OffsetCommitMode>, java.lang.constant.Constable

@Internal
@Deprecated
public enum OffsetCommitMode
extends Enum<OffsetCommitMode>

Deprecated.

The offset commit mode represents the behaviour of how offsets are externally committed back to Kafka brokers / Zookeeper.

The exact value of this is determined at runtime in the consumer subtasks.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLED	Deprecated. Completely disable offset committing.
KAFKA_PERIODIC	Deprecated. Commit offsets periodically back to Kafka, using the auto commit functionality of internal Kafka clients.
ON_CHECKPOINTS	Deprecated. Commit offsets back to Kafka only when checkpoints are completed.

Method Summary

Modifier and Type	Method	Description
static OffsetCommitMode	valueOf(String name)	Deprecated. Returns the enum constant of this class with the specified name.
static OffsetCommitMode[]	values()	Deprecated. 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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISABLED

public static final OffsetCommitMode DISABLED

Deprecated.

Completely disable offset committing.

ON_CHECKPOINTS

public static final OffsetCommitMode ON_CHECKPOINTS

Deprecated.

Commit offsets back to Kafka only when checkpoints are completed.

KAFKA_PERIODIC

public static final OffsetCommitMode KAFKA_PERIODIC

Deprecated.

Commit offsets periodically back to Kafka, using the auto commit functionality of internal Kafka clients.

Method Details

values

public static OffsetCommitMode[] values()

Deprecated.

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 OffsetCommitMode valueOf(String name)

Deprecated.

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