WorkflowCheckpointOptions

Parameters and properties

• storeRequired
  WorkflowCheckpointStore
  Store that grants exclusive ownership of the run and reads and writes its checkpoint, usually createWorkflowCheckpointStore().
• runIdRequired
  string
  Key of the saved run: a later start() with the same runId restores it. Blank values are rejected.
• versionRequired
  string
  Your version of task code, briefs and inputs, hashed into the checkpoint identity with the workflow name and task graph. A saved run cannot change version: start a new runId instead.
• resumeOptional
  "retry-incomplete" | undefined
  Set to retry-incomplete to reopen a checkpoint with failed, cancelled or interrupted tasks and run them again, with any side effects they already made. Without it, start() rejects such a checkpoint before running anything.

Signature

export interface WorkflowCheckpointOptions {
  readonly store: WorkflowCheckpointStore;
  readonly runId: string;
  /** Change when task implementations or workflow inputs change. */
  readonly version: string;
  /** Explicitly authorize replay of incomplete tasks and their side effects. */
  readonly resume?: "retry-incomplete";
}

Related contracts

• WorkflowCheckpointStore