Oban.Pro.Workers.Batch behaviour (Oban Pro v1.5.0)

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

A dedicated worker for grouping the execution of jobs.

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

Summary

Callbacks

all_batch_jobs(t, list)

@callback all_batch_jobs(Oban.Job.t(), [keyword()]) :: Enum.t()

gen_id()

@callback gen_id() :: String.t()

handle_attempted(t)

(optional)
@callback handle_attempted(Oban.Job.t()) :: Oban.Worker.result()

handle_cancelled(t)

(optional)
@callback handle_cancelled(Oban.Job.t()) :: Oban.Worker.result()

handle_completed(t)

(optional)
@callback handle_completed(Oban.Job.t()) :: Oban.Worker.result()

handle_discarded(t)

(optional)
@callback handle_discarded(Oban.Job.t()) :: Oban.Worker.result()

handle_exhausted(t)

(optional)
@callback handle_exhausted(Oban.Job.t()) :: Oban.Worker.result()

handle_retryable(t)

(optional)
@callback handle_retryable(Oban.Job.t()) :: Oban.Worker.result()

new_batch(list, list)

@callback new_batch([Oban.Job.t() | Oban.Job.args()], [keyword()]) :: Oban.Pro.Batch.t()

stream_batch_jobs(t, list)

@callback stream_batch_jobs(Oban.Job.t(), [keyword()]) :: Enum.t()