SchedulerServiceTaskScheduleDefinitionConfig
Home > @backstage/backend-plugin-api > SchedulerServiceTaskScheduleDefinitionConfig
Config options for SchedulerServiceTaskScheduleDefinition that control the scheduling of a task.
Signature:
export interface SchedulerServiceTaskScheduleDefinitionConfig
Properties
|
Property |
Modifiers |
Type |
Description |
|---|---|---|---|
|
{ cron: string; } | string | 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. | ||
|
string | HumanDuration |
(Optional) The amount of time that should pass before the first invocation happens. | ||
|
'global' | 'local' |
(Optional) Sets the scope of concurrency control / locking to apply for invocations of this task. | ||
|
string | 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). |