com.amazonaws.services.kinesis.clientlibrary.lib.worker

Enum ShutdownReason

java.lang.Object

java.lang.Enum<ShutdownReason>

com.amazonaws.services.kinesis.clientlibrary.lib.worker.ShutdownReason

All Implemented Interfaces:

Serializable, Comparable<ShutdownReason>

public enum ShutdownReason
extends Enum<ShutdownReason>

Reason the RecordProcessor is being shutdown. Used to distinguish between a fail-over vs. a termination (shard is closed and all records have been delivered). In case of a fail over, applications should NOT checkpoint as part of shutdown, since another record processor may have already started processing records for that shard. In case of termination (resharding use case), applications SHOULD checkpoint their progress to indicate that they have successfully processed all the records (processing of child shards can then begin).

Enum Constant Summary

Enum Constants

Enum Constant and Description
REQUESTED Indicates that the entire application is being shutdown, and if desired the record processor will be given a final chance to checkpoint.
TERMINATE Terminate processing for this RecordProcessor (resharding use case).
ZOMBIE Processing will be moved to a different record processor (fail over, load balancing use cases).

Method Summary

Modifier and Type	Method and Description
boolean	canTransitionTo(ShutdownReason reason) Indicates whether the given reason can override the current reason.
KinesisConsumerStates.ConsumerState	getShutdownState()
static ShutdownReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static ShutdownReason[]	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

ZOMBIE

public static final ShutdownReason ZOMBIE

Processing will be moved to a different record processor (fail over, load balancing use cases). Applications SHOULD NOT checkpoint their progress (as another record processor may have already started processing data).

TERMINATE

public static final ShutdownReason TERMINATE

Terminate processing for this RecordProcessor (resharding use case). Indicates that the shard is closed and all records from the shard have been delivered to the application. Applications SHOULD checkpoint their progress to indicate that they have successfully processed all records from this shard and processing of child shards can be started.

REQUESTED

public static final ShutdownReason REQUESTED

Indicates that the entire application is being shutdown, and if desired the record processor will be given a final chance to checkpoint. This state will not trigger a direct call to IRecordProcessor.shutdown(ShutdownInput), but instead depend on a different interface for backward compatibility.

Method Detail

values

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

Returns:

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

valueOf

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

canTransitionTo

public boolean canTransitionTo(ShutdownReason reason)

Indicates whether the given reason can override the current reason.

Parameters:

reason - the reason to transition to

Returns:

true if the transition is allowed, false if it's not.

getShutdownState

public KinesisConsumerStates.ConsumerState getShutdownState()