Enum Class FlowErrorType

java.lang.Object

java.lang.Enum<FlowErrorType>

io.superdurable.dex.FlowErrorType

All Implemented Interfaces:

Serializable, Comparable<FlowErrorType>, Constable

public enum FlowErrorType
extends Enum<FlowErrorType>

Classifies why a Flow reached a terminal status other than FlowStatus.COMPLETED.

FlowResult.getErrorType() exposes this value after Dex records a Flow failure.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIENT_API_FAILED	A client API operation caused the Flow to fail.
FLOW_TIMEOUT	A Dex soft Flow timeout expired under FlowTimeoutPolicy.FAIL.
INTERNAL	Dex encountered an internal failure.
INVALID_USER_FLOW_CODE	Dex rejected invalid user Flow code or an invalid definition.
STEP_DECISION_FAILED	A Step returned a decision that failed the Flow.
WORKER_API_FAILED	A worker API invocation caused the Flow to fail.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STEP_DECISION_FAILED

public static final FlowErrorType STEP_DECISION_FAILED

A Step returned a decision that failed the Flow.

CLIENT_API_FAILED

public static final FlowErrorType CLIENT_API_FAILED

A client API operation caused the Flow to fail.

WORKER_API_FAILED

public static final FlowErrorType WORKER_API_FAILED

A worker API invocation caused the Flow to fail.

INVALID_USER_FLOW_CODE

public static final FlowErrorType INVALID_USER_FLOW_CODE

Dex rejected invalid user Flow code or an invalid definition.

INTERNAL

public static final FlowErrorType INTERNAL

Dex encountered an internal failure.

FLOW_TIMEOUT

public static final FlowErrorType FLOW_TIMEOUT

A Dex soft Flow timeout expired under FlowTimeoutPolicy.FAIL.

Method Details

values

public static FlowErrorType[] 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 FlowErrorType 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