Package io.axoniq.framework.workflow.dsl.api

Enum Class StepStatus

java.lang.Object

java.lang.Enum<StepStatus>

io.axoniq.framework.workflow.dsl.api.StepStatus

All Implemented Interfaces:

Serializable, Comparable<StepStatus>, Constable

public enum StepStatus
extends Enum<StepStatus>

Step status.

Since:

5.4.0

Author:

Allard Buijze, Stefan Dragisic, Simon Zambrovski

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
CANCELLED	The step was cancelled, either directly or through a terminal transition of the workflow.
COMPLETED	The step finished successfully.
FAILED	The step finished with an error and no retry is left.
RETRY_STARTED	A retry attempt was accepted by the store and is running.
RETRYING	An attempt failed and the retry policy allows another one.
STARTED	The first attempt of the step was accepted by the store and is running.
TIMED_OUT	The step did not finish within its timeout.

Method Summary

Modifier and Type	Method	Description
boolean	isTerminal()	Checks if the status is terminal.
static StepStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StepStatus[]	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

STARTED

public static final StepStatus STARTED

The first attempt of the step was accepted by the store and is running.

RETRYING

public static final StepStatus RETRYING

An attempt failed and the retry policy allows another one. The step waits for the backoff before the next attempt starts.

RETRY_STARTED

public static final StepStatus RETRY_STARTED

A retry attempt was accepted by the store and is running. Recorded once per retry attempt, after the RETRYING record of the attempt that failed.

COMPLETED

public static final StepStatus COMPLETED

The step finished successfully. Terminal.

FAILED

public static final StepStatus FAILED

The step finished with an error and no retry is left. Terminal.

TIMED_OUT

public static final StepStatus TIMED_OUT

The step did not finish within its timeout. Terminal.

CANCELLED

public static final StepStatus CANCELLED

The step was cancelled, either directly or through a terminal transition of the workflow. Terminal.

Method Details

values

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

isTerminal

public boolean isTerminal()

Checks if the status is terminal.

Returns:

true, if terminal.