SchedulerServiceTaskScheduleDefinitionConfig.frequency

Home > @backstage/backend-plugin-api > SchedulerServiceTaskScheduleDefinitionConfig > frequency

How often you want the task to run. The system does its best to avoid overlapping invocations.

Signature:

frequency: {
        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';
    };

Remarks

This is the best effort value; under some circumstances there can be deviations. For example, if the task runtime is longer than the frequency and the timeout has not been given or not been exceeded yet, the next invocation of this task will be delayed until after the previous one finishes.

This is a required field.