software.amazon.kinesis.common

Enum InitialPositionInStream

java.lang.Object

java.lang.Enum<InitialPositionInStream>

software.amazon.kinesis.common.InitialPositionInStream

All Implemented Interfaces:

Serializable, Comparable<InitialPositionInStream>

public enum InitialPositionInStream
extends Enum<InitialPositionInStream>

Used to specify the position in the stream where a new application should start from. This is used during initial application bootstrap (when a checkpoint doesn't exist for a shard or its parents).

Enum Constant Summary

Enum Constants

Enum Constant and Description
AT_TIMESTAMP Start from the record at or after the specified server-side timestamp.
LATEST Start after the most recent data record (fetch new data).
TRIM_HORIZON Start from the oldest available data record.

Method Summary

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

LATEST

public static final InitialPositionInStream LATEST

Start after the most recent data record (fetch new data).

TRIM_HORIZON

public static final InitialPositionInStream TRIM_HORIZON

Start from the oldest available data record.

AT_TIMESTAMP

public static final InitialPositionInStream AT_TIMESTAMP

Start from the record at or after the specified server-side timestamp.

Method Detail

values

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

Returns:

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

valueOf

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