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

Enum Class StartupMode

java.lang.Object

java.lang.Enum<StartupMode>

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

All Implemented Interfaces:

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

@Internal
public enum StartupMode
extends Enum<StartupMode>

Startup modes for the Kafka Consumer.

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
EARLIEST	Start from the earliest offset possible.
GROUP_OFFSETS	Start from committed offsets in ZK / Kafka brokers of a specific consumer group (default).
LATEST	Start from the latest offset.
SPECIFIC_OFFSETS	Start from user-supplied specific offsets for each partition.
TIMESTAMP	Start from user-supplied timestamp for each partition.

Method Summary

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

GROUP_OFFSETS

public static final StartupMode GROUP_OFFSETS

Start from committed offsets in ZK / Kafka brokers of a specific consumer group (default).

EARLIEST

public static final StartupMode EARLIEST

Start from the earliest offset possible.

LATEST

public static final StartupMode LATEST

Start from the latest offset.

TIMESTAMP

public static final StartupMode TIMESTAMP

Start from user-supplied timestamp for each partition. Since this mode will have specific offsets to start with, we do not need a sentinel value; using Long.MIN_VALUE as a placeholder.

SPECIFIC_OFFSETS

public static final StartupMode SPECIFIC_OFFSETS

Start from user-supplied specific offsets for each partition. Since this mode will have specific offsets to start with, we do not need a sentinel value; using Long.MIN_VALUE as a placeholder.

Method Details

values

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

getStateSentinel

public long getStateSentinel()