klokka-core/com.eventslooped.klokka/JobState

JobState

sealed interface JobState

The lifecycle of a job run.

Scheduled -> Enqueued -> Running -> Succeeded
                                  | Failed (a retry is booked for retryAt)
                                  | DeadLettered
                                  | Cancelled

com.eventslooped.klokka.spi.JobStore.transition performs a compare-and-set on these values: a transition only applies if the stored state still equals the expected from state.

Inheritors

Types

data object Cancelled : JobState

data object DeadLettered : JobState

Retries exhausted or non-retryable failure. Kept for triage, never silently deleted.

data object Enqueued : JobState

Due and visible to workers.

data class Failed(val retryAt: Instant) : JobState

The last attempt failed and a retry is booked. Not terminal.

data object Running : JobState

Claimed under a lease and executing.

data object Scheduled : JobState

Waiting for its run-at time. Delayed jobs and schedule-emitted runs start here.

data object Succeeded : JobState

Properties

val JobState.status: JobStatus

The JobStatus classifying this state.

open val terminal: Boolean

True when no further execution will happen for this run.