shared-infrastructure/com.vertyll.veds.sharedinfrastructure.saga.enums/SagaStepStatus

SagaStepStatus

enum SagaStepStatus : Enum<SagaStepStatus> (source)

Lifecycle status of an individual saga step (SagaStep).

Steps progress independently of the owning Saga status; the saga engine uses step statuses to decide whether the saga as a whole can be marked COMPLETED (all steps COMPLETED) or must be compensated (any FAILED).

Terminal statuses (COMPLETED, FAILED, COMPENSATED, COMPENSATION_FAILED) prevent the engine from re-applying a different status to the same step (idempotency guard inside recordSagaStep).

Entries

STARTED

Initial state, written by SagaEngine.recordSagaStep before applying the requested status.

COMPLETED

Terminal — step finished successfully.

FAILED

Terminal — step failed; triggers saga-level compensation.

COMPENSATED

Terminal — step was successfully rolled back by SagaCompensator.

COMPENSATION_FAILED

Terminal — compensator failed to roll back the step; eligible for watchdog retry.

PARTIALLY_COMPLETED

Step succeeded only in part (rare; reserved for steps that publish to multiple downstream effects and want to record partial success without triggering full compensation).

Properties

entries

val entries: EnumEntries<SagaStepStatus>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): SagaStepStatus

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.)

values

fun values(): Array<SagaStepStatus>

Returns an array containing the constants of this enum type, in the order they're declared.