bg_jobs/scheduled_job

Types

DateError

pub type DateError {
  DateError(tempo.DateOutOfBoundsError)
  TimeError(tempo.TimeOutOfBoundsError)
  OutOfBoundsError(String)
  RangeError(String)
}

Constructors

```
DateError(tempo.DateOutOfBoundsError)
```
```
TimeError(tempo.TimeOutOfBoundsError)
```
```
OutOfBoundsError(String)
```
```
RangeError(String)
```

DateSchedule

</>

pub type DateSchedule {
  DateSchedule(
    second: TimeValue,
    minute: TimeValue,
    hour: TimeValue,
    day_of_month: TimeValue,
    month: TimeValue,
    day_of_week: TimeValue,
  )
}

Constructors

DateSchedule(
  second: TimeValue,
  minute: TimeValue,
  hour: TimeValue,
  day_of_month: TimeValue,
  month: TimeValue,
  day_of_week: TimeValue,
)

DateScheduleBuilder

</>

pub type DateScheduleBuilder {
  DateScheduleBuilder(
    second: TimeValue,
    minute: TimeValue,
    hour: TimeValue,
    day_of_month: TimeValue,
    month: TimeValue,
    day_of_week: TimeValue,
  )
}

Constructors

DateScheduleBuilder(
  second: TimeValue,
  minute: TimeValue,
  hour: TimeValue,
  day_of_month: TimeValue,
  month: TimeValue,
  day_of_week: TimeValue,
)

Duration

</>

pub type Duration {
  Millisecond(Int)
  Second(Int)
  Minute(Int)
  Hour(Int)
  Day(Int)
  Week(Int)
}

Constructors

```
Millisecond(Int)
```
```
Second(Int)
```
```
Minute(Int)
```
```
Hour(Int)
```
```
Day(Int)
```
```
Week(Int)
```

Schedule

</>

pub type Schedule {
  Interval(Duration)
  Schedule(DateSchedule)
}

Constructors

```
Interval(Duration)
```
```
Schedule(DateSchedule)
```

ScheduleBuilder

</>

pub type ScheduleBuilder {
  IntervalBuilder(Duration)
  ScheduleBuilder(DateScheduleBuilder)
}

Constructors

```
IntervalBuilder(Duration)
```
```
ScheduleBuilder(DateScheduleBuilder)
```

Spec

</>

pub type Spec {
  Spec(
    schedule: Schedule,
    worker: jobs.Worker,
    max_retries: Int,
    init_timeout: Int,
    poll_interval: Int,
    event_listeners: List(events.EventListener),
  )
}

Constructors

Spec(
  schedule: Schedule,
  worker: jobs.Worker,
  max_retries: Int,
  init_timeout: Int,
  poll_interval: Int,
  event_listeners: List(events.EventListener),
)

SpecBuilder

</>

pub type SpecBuilder {
  SpecBuilder(
    schedule_builder: ScheduleBuilder,
    worker: jobs.Worker,
    max_retries: Int,
    init_timeout: Int,
    poll_interval: Int,
    event_listeners: List(events.EventListener),
  )
}

Constructors

SpecBuilder(
  schedule_builder: ScheduleBuilder,
  worker: jobs.Worker,
  max_retries: Int,
  init_timeout: Int,
  poll_interval: Int,
  event_listeners: List(events.EventListener),
)

TimeSelection

</>

pub type TimeSelection {
  Value(Int)
  Range(Int, Int)
}

Constructors

```
Value(Int)
```
```
Range(Int, Int)
```

TimeValue

</>

pub type TimeValue {
  Every
  Specific(List(TimeSelection))
}

Constructors

```
Every
```
```
Specific(List(TimeSelection))
```

Functions

between_day_of_months

</>

pub fn between_day_of_months(
  self: ScheduleBuilder,
  start: Int,
  end: Int,
) -> ScheduleBuilder

Sets a range of days of the month during which the schedule should trigger.

between_day_of_weeks

</>

pub fn between_day_of_weeks(
  self: ScheduleBuilder,
  start: Int,
  end: Int,
) -> ScheduleBuilder

Sets a range of days of the week during which the schedule should trigger.

between_hours

</>

pub fn between_hours(
  self: ScheduleBuilder,
  start: Int,
  end: Int,
) -> ScheduleBuilder

Sets a range of hours during which the schedule should trigger.

between_minutes

</>

pub fn between_minutes(
  self: ScheduleBuilder,
  start: Int,
  end: Int,
) -> ScheduleBuilder

Sets a range of minutes during which the schedule should trigger.

between_months

</>

pub fn between_months(
  self: ScheduleBuilder,
  start: Int,
  end: Int,
) -> ScheduleBuilder

Sets a range of months during which the schedule should trigger.

between_seconds

</>

pub fn between_seconds(
  self: ScheduleBuilder,
  start: Int,
  end: Int,
) -> ScheduleBuilder

Sets a range of seconds during which the schedule should trigger.

build

</>

pub fn build(
  db_adapter db_adapter: DbAdapter,
  spec spec: Spec,
) -> Result(Subject(Message), StartError)

build_schedule

</>

pub fn build_schedule(
  schedule_in: ScheduleBuilder,
) -> Result(Schedule, DateError)

Validate and create Schedule from scheduleBuilder

every_second

</>

pub fn every_second(self: ScheduleBuilder) -> ScheduleBuilder

Sets the schedule to trigger every second.

map_schedule_builder

</>

pub fn map_schedule_builder(
  schedule: ScheduleBuilder,
  f: fn(DateScheduleBuilder) -> DateScheduleBuilder,
) -> ScheduleBuilder

new

</>

pub fn new(
  worker worker: Worker,
  schedule schedule: ScheduleBuilder,
) -> SpecBuilder

new_interval_days

</>

pub fn new_interval_days(days: Int) -> ScheduleBuilder

Create interval schedule in days

new_interval_hours

</>

pub fn new_interval_hours(hours: Int) -> ScheduleBuilder

Create interval schedule in hours

new_interval_milliseconds

</>

pub fn new_interval_milliseconds(
  milliseconds: Int,
) -> ScheduleBuilder

Create interval schedule in milliseconds

new_interval_minutes

</>

pub fn new_interval_minutes(minutes: Int) -> ScheduleBuilder

Create interval schedule in minutes

new_interval_seconds

</>

pub fn new_interval_seconds(seconds: Int) -> ScheduleBuilder

Create interval schedule in seconds

new_interval_weeks

</>

pub fn new_interval_weeks(weeks: Int) -> ScheduleBuilder

Create interval schedule in weeks

new_schedule

</>

pub fn new_schedule() -> ScheduleBuilder

Create a new schedule that runs on the first second every minut

on_aprils

</>

pub fn on_aprils(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger in April.

on_augusts

</>

pub fn on_augusts(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger in August.

on_day_of_month

</>

pub fn on_day_of_month(
  self: ScheduleBuilder,
  value: Int,
) -> ScheduleBuilder

Adds a specific day of the month on which the schedule should trigger. If other specific days are already set, appends the given day.

on_day_of_week

</>

pub fn on_day_of_week(
  self: ScheduleBuilder,
  value: Int,
) -> ScheduleBuilder

Adds a specific day of the week on which the schedule should trigger. If other specific days are already set, appends the given day.

on_decembers

</>

pub fn on_decembers(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger in December.

on_februaries

</>

pub fn on_februaries(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger in February.

on_fridays

</>

pub fn on_fridays(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger on Fridays.

on_hour

</>

pub fn on_hour(
  self: ScheduleBuilder,
  value: Int,
) -> ScheduleBuilder

Adds a specific hour at which the schedule should trigger. If other specific hours are already set, appends the given hour.

on_januaries

</>

pub fn on_januaries(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger in January.

on_julies

</>

pub fn on_julies(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger in July.

on_junes

</>

pub fn on_junes(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger in June.

on_marches

</>

pub fn on_marches(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger in March.

on_mays

</>

pub fn on_mays(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger in May.

on_minute

</>

pub fn on_minute(
  self: ScheduleBuilder,
  value: Int,
) -> ScheduleBuilder

Adds a specific minute at which the schedule should trigger. If other specific minutes are already set, appends the given minute.

on_mondays

</>

pub fn on_mondays(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger on Mondays.

on_month

</>

pub fn on_month(
  self: ScheduleBuilder,
  value: Int,
) -> ScheduleBuilder

Adds a specific month in which the schedule should trigger. If other specific months are already set, appends the given month.

on_novembers

</>

pub fn on_novembers(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger in November.

on_octobers

</>

pub fn on_octobers(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger in October.

on_saturdays

</>

pub fn on_saturdays(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger on Saturdays.

on_second

</>

pub fn on_second(
  self: ScheduleBuilder,
  second: Int,
) -> ScheduleBuilder

Adds a specific second at which the schedule should trigger. If other specific seconds are already set, appends the given second.

Note: the default value is to trigger on second 0 so you would need to set it to every second first and then to a specific to only get that

on_septembers

</>

pub fn on_septembers(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger in September.

on_sundays

</>

pub fn on_sundays(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger on Sundays.

on_thuesdays

</>

pub fn on_thuesdays(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger on Thuesdays.

on_thursdays

</>

pub fn on_thursdays(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger on Thursdays.

on_wednesdays

</>

pub fn on_wednesdays(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger on Wednesdays.

on_weekdays

</>

pub fn on_weekdays(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger on weekdays (Monday through Friday).

on_weekends

</>

pub fn on_weekends(self: ScheduleBuilder) -> ScheduleBuilder

Shortcut function to set the schedule to trigger on weekends (Saturday and Sunday).

to_bg_jobs_error

</>

pub fn to_bg_jobs_error(date_error: DateError) -> BgJobError

with_event_listeners

</>

pub fn with_event_listeners(
  spec: SpecBuilder,
  event_listeners: List(fn(Event) -> Nil),
) -> SpecBuilder

Set event listeners for the queue NOTE: This will override previously added workers

with_init_timeout

</>

pub fn with_init_timeout(
  spec: SpecBuilder,
  init_timeout: Int,
) -> SpecBuilder

Amount of time in milli seconds the queue is given to start

with_max_retries

</>

pub fn with_max_retries(
  spec: SpecBuilder,
  max_retries: Int,
) -> SpecBuilder

Maximum times a job will be retried before being considered failed and moved to the failed_jobs table

with_poll_interval_ms

</>

pub fn with_poll_interval_ms(
  spec: SpecBuilder,
  poll_interval: Int,
) -> SpecBuilder

Time in milli seconds to wait in between checking for new jobs