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

Enum BoundedMode

java.lang.Object

java.lang.Enum<BoundedMode>

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

All Implemented Interfaces:

Serializable, Comparable<BoundedMode>

@Internal
public enum BoundedMode
extends Enum<BoundedMode>

End modes for the Kafka Consumer.

Enum Constant Summary

Enum Constants

Enum Constant	Description
GROUP_OFFSETS	End from committed offsets in ZK / Kafka brokers of a specific consumer group.
LATEST	End from the latest offset.
SPECIFIC_OFFSETS	End from user-supplied specific offsets for each partition.
TIMESTAMP	End from user-supplied timestamp for each partition.
UNBOUNDED	Do not end consuming.

Method Summary

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

UNBOUNDED

public static final BoundedMode UNBOUNDED

Do not end consuming.

GROUP_OFFSETS

public static final BoundedMode GROUP_OFFSETS

End from committed offsets in ZK / Kafka brokers of a specific consumer group. This is evaluated at the start of consumption from a given partition.

LATEST

public static final BoundedMode LATEST

End from the latest offset. This is evaluated at the start of consumption from a given partition.

TIMESTAMP

public static final BoundedMode TIMESTAMP

End from user-supplied timestamp for each partition.

SPECIFIC_OFFSETS

public static final BoundedMode SPECIFIC_OFFSETS

End from user-supplied specific offsets for each partition. If an offset for a partition is not provided it will not consume from that partition.

Method Detail

values

public static BoundedMode[] 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 (BoundedMode c : BoundedMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static BoundedMode 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