software.amazon.kinesis.lifecycle

Enum TaskOutcome

java.lang.Object

java.lang.Enum<TaskOutcome>

software.amazon.kinesis.lifecycle.TaskOutcome

All Implemented Interfaces:

Serializable, Comparable<TaskOutcome>

public enum TaskOutcome
extends Enum<TaskOutcome>

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
END_OF_SHARD Denotes that the last record from the shard has been read/consumed.
FAILURE Denotes a failure or exception during processing of the shard.
SUCCESSFUL Denotes a successful task outcome.

Method Summary

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

SUCCESSFUL

public static final TaskOutcome SUCCESSFUL

Denotes a successful task outcome.

END_OF_SHARD

public static final TaskOutcome END_OF_SHARD

Denotes that the last record from the shard has been read/consumed.

FAILURE

public static final TaskOutcome FAILURE

Denotes a failure or exception during processing of the shard.

Method Detail

values

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

Returns:

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

valueOf

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