org.apache.flink.streaming.connectors.kafka

Enum FlinkKafkaConsumer.OffsetStore

java.lang.Object

java.lang.Enum<FlinkKafkaConsumer.OffsetStore>

org.apache.flink.streaming.connectors.kafka.FlinkKafkaConsumer.OffsetStore

All Implemented Interfaces:

Serializable, Comparable<FlinkKafkaConsumer.OffsetStore>

Enclosing class:

FlinkKafkaConsumer<T>

public static enum FlinkKafkaConsumer.OffsetStore
extends Enum<FlinkKafkaConsumer.OffsetStore>

The offset store defines how acknowledged offsets are committed back to Kafka. Different options include letting Flink periodically commit to ZooKeeper, or letting Kafka manage the offsets (new Kafka versions only).

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLINK_ZOOKEEPER Let Flink manage the offsets.
KAFKA Use the mechanisms in Kafka to commit offsets.

Method Summary

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

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FLINK_ZOOKEEPER

public static final FlinkKafkaConsumer.OffsetStore FLINK_ZOOKEEPER

Let Flink manage the offsets. Flink will periodically commit them to Zookeeper (usually after successful checkpoints), in the same structure as Kafka 0.8.2.x

Use this mode when using the source with Kafka 0.8.1.x brokers.

KAFKA

public static final FlinkKafkaConsumer.OffsetStore KAFKA

Use the mechanisms in Kafka to commit offsets. Depending on the Kafka configuration, different mechanism will be used (broker coordinator, zookeeper)

Method Detail

values

public static FlinkKafkaConsumer.OffsetStore[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FlinkKafkaConsumer.OffsetStore c : FlinkKafkaConsumer.OffsetStore.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FlinkKafkaConsumer.OffsetStore valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null