software.amazon.kinesis.checkpoint

Enum SentinelCheckpoint

java.lang.Object

java.lang.Enum<SentinelCheckpoint>

software.amazon.kinesis.checkpoint.SentinelCheckpoint

All Implemented Interfaces:

Serializable, Comparable<SentinelCheckpoint>

public enum SentinelCheckpoint
extends Enum<SentinelCheckpoint>

Enumeration of the sentinel values of checkpoints. Used during initialization of ShardConsumers to determine the starting point in the shard and to flag that a shard has been completely processed.

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 from the latest record in the shard.
SHARD_END We've completely processed all records in this shard.
TRIM_HORIZON Start from the first available record in the shard.

Method Summary

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

Start from the first available record in the shard.

LATEST

public static final SentinelCheckpoint LATEST

Start from the latest record in the shard.

SHARD_END

public static final SentinelCheckpoint SHARD_END

We've completely processed all records in this shard.

AT_TIMESTAMP

public static final SentinelCheckpoint AT_TIMESTAMP

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

Method Detail

values

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

Returns:

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

valueOf

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