Oban.Pro.Workers.Workflow behaviour (Oban Pro v1.5.0-rc.7)

This behaviour is deprecated. Use Oban.Pro.Workflow instead.

A dedicated worker for linking the execution of jobs.

This worker is deprecated in favor of Oban.Pro.Workflow, which is more flexible and supports more options.

Summary

Callbacks

add(t, name, changeset, add_opts)
after_cancelled(cancel_reason, t)
all_workflow_jobs(t, fetch_opts)
append_workflow(arg1, append_opts)
gen_id()
new_workflow(new_opts)
stream_workflow_jobs(t, fetch_opts)
to_dot(t)

Callbacks

Link to this callback

add(t, name, changeset, add_opts)

@callback add(
  Oban.Pro.Workflow.t(),
  Oban.Pro.Workflow.name(),
  Oban.Job.changeset(),
  Oban.Pro.Workflow.add_opts()
) :: Oban.Pro.Workflow.t()
Link to this callback

after_cancelled(cancel_reason, t)

(optional) 
@callback after_cancelled(Oban.Pro.Workflow.cancel_reason(), Oban.Job.t()) :: :ok
Link to this callback

all_workflow_jobs(t, fetch_opts)

@callback all_workflow_jobs(Oban.Job.t(), Oban.Pro.Workflow.fetch_opts()) :: [
  Oban.Job.t()
]
Link to this callback

append_workflow(arg1, append_opts)

@callback append_workflow(Oban.Job.t() | [Oban.Job.t()], Oban.Pro.Workflow.append_opts()) ::
  Oban.Pro.Workflow.t()
Link to this callback

gen_id()

@callback gen_id() :: String.t()
Link to this callback

new_workflow(new_opts)

@callback new_workflow(Oban.Pro.Workflow.new_opts()) :: Oban.Pro.Workflow.t()
Link to this callback

stream_workflow_jobs(t, fetch_opts)

@callback stream_workflow_jobs(Oban.Job.t(), Oban.Pro.Workflow.fetch_opts()) :: Enum.t()
Link to this callback

to_dot(t)

@callback to_dot(Oban.Pro.Workflow.t()) :: String.t()