org.apache.flink.streaming.connectors.kinesis.config

Enum ConsumerConfigConstants.InitialPosition

java.lang.Object

java.lang.Enum<ConsumerConfigConstants.InitialPosition>

org.apache.flink.streaming.connectors.kinesis.config.ConsumerConfigConstants.InitialPosition

All Implemented Interfaces:

Serializable, Comparable<ConsumerConfigConstants.InitialPosition>

Enclosing class:

ConsumerConfigConstants

public static enum ConsumerConfigConstants.InitialPosition
extends Enum<ConsumerConfigConstants.InitialPosition>

The initial position to start reading shards from. This will affect the ShardIteratorType used when the consumer tasks retrieve the first shard iterator for each Kinesis shard.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AT_TIMESTAMP Start reading from the record at the specified timestamp.
LATEST Start reading from the latest incoming record.
TRIM_HORIZON Start reading from the earliest possible record in the stream (excluding expired data records).

Method Summary

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

TRIM_HORIZON

public static final ConsumerConfigConstants.InitialPosition TRIM_HORIZON

Start reading from the earliest possible record in the stream (excluding expired data records).

LATEST

public static final ConsumerConfigConstants.InitialPosition LATEST

Start reading from the latest incoming record.

AT_TIMESTAMP

public static final ConsumerConfigConstants.InitialPosition AT_TIMESTAMP

Start reading from the record at the specified timestamp.

Method Detail

values

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

Returns:

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

valueOf

public static ConsumerConfigConstants.InitialPosition 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

toSentinelSequenceNumber

public SentinelSequenceNumber toSentinelSequenceNumber()