Runlane
ReferenceVocabulary

Vocabulary

Stable enum values and public lingo used by Runlane contracts and runtime APIs.

Runlane vocabulary is the set of stable values callers, adapters, transports, and operator tooling can branch on. These values are part of the public contract when they appear in persisted records, public errors, or runtime API results.

Use this section when you need to store, query, display, or switch on Runlane state. Do not invent parallel string values for concepts that already have a Runlane enum.

What Belongs Here

CategoryUse
Error CodesStructured failures and storage conflict kinds from framework, adapters, task failure summaries, and outbox failure summaries.
IdentifiersPublic task IDs, run IDs, schedule IDs, queue names, idempotency keys, singleton keys, and worker IDs.
Run LifecycleRun statuses, status groups, event types, run sources, trigger outcomes, attempt summaries, dispatch reservations, and audit actors.
Tasks And SchedulesRetry backoff types, schedule shapes, schedule occurrence status, and duration units.
Delivery And WorkersOutbox message status, trigger dispatch modes, wakeup publish outcomes, worker modes, and transport-delivery execution results.
Operator ReadsSort fields, sort directions, and cursor kinds for cursor-backed operator reads.

What Stays Open

These values are open vocabulary unless the contract gives you a specific enum:

  • IDs and queue names
  • environment names
  • cursors
  • cron expressions and time zones
  • release and cancellation reasons
  • provider message IDs
  • metadata keys

Public identity values are covered in Identifiers. Runlane-branded IDs and key values are opaque non-empty strings and must not contain :; treat them as whole values, not parseable prefix paths.

Provider-specific and business-domain error codes also stay out of Runlane enums. Store them in meta on the relevant failure record so operator tooling can branch on ErrorCode and still show domain detail.

On this page