TaskScheduleDefinition
Home > @backstage/backend-tasks > TaskScheduleDefinition
Warning: This API is now obsolete.
Please import
SchedulerServiceTaskScheduleDefinitionfrom@backstage/backend-plugin-apiinstead
Options that control the scheduling of a task.
Signature:
export interface TaskScheduleDefinition
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| frequency | { cron: string; } | Duration | HumanDuration /** * This task will only run when manually triggered with the `triggerTask` method; no automatic * scheduling. This is useful for locking of global tasks that should not be run concurrently. */ | { trigger: 'manual'; } | How often you want the task to run. The system does its best to avoid overlapping invocations. | |
| initialDelay? | Duration | HumanDuration | (Optional) The amount of time that should pass before the first invocation happens. | |
| scope? | 'global' | 'local' | (Optional) Sets the scope of concurrency control / locking to apply for invocations of this task. | |
| timeout | Duration | HumanDuration | The maximum amount of time that a single task invocation can take, before it's considered timed out and gets "released" such that a new invocation is permitted to take place (possibly, then, on a different worker). |