APICronConfig class

The cron section of the API config.

cron:
  enabled: true
  check_interval: 30s
  history_days: 90
  jobs:
    <name>:
      path: /module/route
      schedule: "30 23 * * *"
      time_zone: Europe/Paris

Constructors

APICronConfig({bool enabled = false, Duration checkInterval = const Duration(seconds: 30), int historyDays = 90, Map<String, Map> jobs = const {}})

const

APICronConfig.fromMap(Map? config)

factory

Properties

checkInterval → Duration

How often the scheduler checks the due jobs.

final

enabled → bool

final

hashCode → int

The hash code for this object.

no setter, inherited

historyDays → int

The days the run history is kept (0: forever).

final

jobs → Map<String, Map>

The jobs config, by job name.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited