View Source Quantum.Job (Quantum v3.5.3)

This Struct defines a Job.

Usage

The struct should never be defined by hand. Use Quantum.new_job/1 to create a new job and use the setters mentioned below to mutate the job.

This is to ensure type safety.

Summary

Types

name()

schedule()

state()

t()

task()

timezone()

Functions

set_name(job, name)

Sets a job's name.

set_overlap(job, overlap?)

Sets a job's overlap.

set_run_strategy(job, run_strategy)

Sets a job's run strategy.

set_schedule(job, schedule)

Sets a job's schedule.

set_state(job, atom)

Sets a job's state.

set_task(job, task)

Sets a job's task.

set_timezone(job, timezone)

Sets a job's timezone.

Types

name()

@type name() :: atom() | reference()

schedule()

@type schedule() :: Crontab.CronExpression.t()

state()

@type state() :: :active | :inactive

t()

@type t() :: %Quantum.Job{
  name: name(),
  overlap: boolean(),
  run_strategy: Quantum.RunStrategy.NodeList,
  schedule: schedule() | nil,
  state: state(),
  task: task() | nil,
  timezone: timezone()
}

task()

@type task() :: {atom(), atom(), [any()]} | (-> any())

timezone()

@type timezone() :: :utc | String.t()

Functions

set_name(job, name)

@spec set_name(t(), atom()) :: t()

Sets a job's name.

Parameters

job - The job struct to modify
name - The name to set

Examples

iex> Acme.Scheduler.new_job()
...> |> Quantum.Job.set_name(:name)
...> |> Map.get(:name)
:name

set_overlap(job, overlap?)

@spec set_overlap(t(), boolean()) :: t()

Sets a job's overlap.

Parameters

job - The job struct to modify
overlap - Enable / Disable Overlap

Examples

iex> Acme.Scheduler.new_job()
...> |> Quantum.Job.set_overlap(false)
...> |> Map.get(:overlap)
false

set_run_strategy(job, run_strategy)

@spec set_run_strategy(t(), Quantum.RunStrategy.NodeList) :: t()

Sets a job's run strategy.

Parameters

job - The job struct to modify
run_strategy - The run strategy to set

Examples

iex> Acme.Scheduler.new_job()
...> |> Quantum.Job.run_strategy(%Quantum.RunStrategy.All{nodes: [:one, :two]})
...> |> Map.get(:run_strategy)
[:one, :two]

set_schedule(job, schedule)

@spec set_schedule(t(), Crontab.CronExpression.t()) :: t()

Sets a job's schedule.

Parameters

job - The job struct to modify
schedule - The schedule to set. May only be of type %Crontab.CronExpression{}

Examples

iex> Acme.Scheduler.new_job()
...> |> Quantum.Job.set_schedule(Crontab.CronExpression.Parser.parse!("*/7"))
...> |> Map.get(:schedule)
Crontab.CronExpression.Parser.parse!("*/7")

set_state(job, atom)

@spec set_state(t(), state()) :: t()

Sets a job's state.

Parameters

job - The job struct to modify
state - The state to set

Examples

iex> Acme.Scheduler.new_job()
...> |> Quantum.Job.set_state(:active)
...> |> Map.get(:state)
:active

set_task(job, task)

@spec set_task(t(), task()) :: t()

Sets a job's task.

Parameters

job - The job struct to modify
task - The function to be performed, ex: {Heartbeat, :send, []} or fn -> :something end

Examples

iex> Acme.Scheduler.new_job()
...> |> Quantum.Job.set_task({Backup, :backup, []})
...> |> Map.get(:task)
{Backup, :backup, []}

set_timezone(job, timezone)

@spec set_timezone(t(), String.t() | :utc) :: t()

Sets a job's timezone.

Parameters

job - The job struct to modify
timezone - The timezone to set.

Examples

iex> Acme.Scheduler.new_job()
...> |> Quantum.Job.set_timezone("Europe/Zurich")
...> |> Map.get(:timezone)
"Europe/Zurich"