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

Enum TaskType

java.lang.Object

java.lang.Enum<TaskType>

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

All Implemented Interfaces:

Serializable, Comparable<TaskType>

public enum TaskType
extends Enum<TaskType>

Enumerates types of tasks executed as part of processing a shard.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCK_ON_PARENT_SHARDS Polls and waits until parent shard(s) have been fully processed.
INITIALIZE Initialization of RecordProcessor (and Amazon Kinesis Client Library internal state for a shard).
PROCESS Fetching and processing of records.
SHARDSYNC Sync leases/activities corresponding to Kinesis shards.
SHUTDOWN Shutdown of RecordProcessor.
SHUTDOWN_COMPLETE Occurs once the shutdown has been completed
SHUTDOWN_NOTIFICATION Graceful shutdown has been requested, and notification of the record processor will occur.

Method Summary

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

BLOCK_ON_PARENT_SHARDS

public static final TaskType BLOCK_ON_PARENT_SHARDS

Polls and waits until parent shard(s) have been fully processed.

INITIALIZE

public static final TaskType INITIALIZE

Initialization of RecordProcessor (and Amazon Kinesis Client Library internal state for a shard).

PROCESS

public static final TaskType PROCESS

Fetching and processing of records.

SHUTDOWN

public static final TaskType SHUTDOWN

Shutdown of RecordProcessor.

SHUTDOWN_NOTIFICATION

public static final TaskType SHUTDOWN_NOTIFICATION

Graceful shutdown has been requested, and notification of the record processor will occur.

SHUTDOWN_COMPLETE

public static final TaskType SHUTDOWN_COMPLETE

Occurs once the shutdown has been completed

SHARDSYNC

public static final TaskType SHARDSYNC

Sync leases/activities corresponding to Kinesis shards.

Method Detail

values

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

Returns:

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

valueOf

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