Package software.amazon.lambda.durable.plugin

Enum Class UserFunctionOutcome

java.lang.Object

java.lang.Enum<UserFunctionOutcome>

software.amazon.lambda.durable.plugin.UserFunctionOutcome

All Implemented Interfaces:

Serializable, Comparable<UserFunctionOutcome>, Constable

public enum UserFunctionOutcome
extends Enum<UserFunctionOutcome>

Outcome of a user-provided function when its execution ends.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILED	The user function threw an error.
INCOMPLETE	The user function exited before completing, for example when the durable execution suspended.
SUCCEEDED	The user function returned normally.

Method Summary

Modifier and Type	Method	Description
static UserFunctionOutcome	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UserFunctionOutcome[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUCCEEDED

public static final UserFunctionOutcome SUCCEEDED

The user function returned normally.

FAILED

public static final UserFunctionOutcome FAILED

The user function threw an error.

INCOMPLETE

public static final UserFunctionOutcome INCOMPLETE

The user function exited before completing, for example when the durable execution suspended.

Method Details

values

public static UserFunctionOutcome[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static UserFunctionOutcome valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null