Odyssey.Workflow (odyssey v0.1.6)

View Source

A workflow is a sequence of phases that are executed in order.

Summary

Types

id()
t()

Functions

jump_to(id, phase)
run_next_phase(workflow_run)
runs(statuses, limit \\ 100)
start(workflow, name \\ nil, state)
stop(id)

Types

id()

@type id() :: term()

t()

@type t() :: [Odyssey.Phase.t()]

Functions

jump_to(id, phase)

@spec jump_to(id(), non_neg_integer()) :: Odyssey.DB.WorkflowRun.t() | nil

run_next_phase(workflow_run)

@spec run_next_phase(Odyssey.DB.WorkflowRun.t()) :: Odyssey.DB.WorkflowRun.t()

runs(statuses, limit \\ 100)

@spec runs([Odyssey.DB.WorkflowRun.status()] | :all, non_neg_integer()) :: [
  Odyssey.DB.WorkflowRun.t()
]

start(workflow, name \\ nil, state)

@spec start(t(), String.t() | nil, Odyssey.State.t()) :: Odyssey.DB.WorkflowRun.t()

stop(id)

@spec stop(id()) :: Odyssey.DB.WorkflowRun.t() | nil