Skip to main content

SchedulerService

Home > @backstage/backend-plugin-api > SchedulerService

Deals with the scheduling of distributed tasks, for a given plugin.

See the service documentation for more details.

Signature:

export interface SchedulerService 

Methods

Method

Description

createScheduledTaskRunner(schedule)

Creates a scheduled but dormant recurring task, ready to be launched at a later time.

getScheduledTasks()

Returns all scheduled tasks registered to this scheduler.

scheduleTask(task)

Schedules a task function for recurring runs.

triggerTask(id)

Manually triggers a task by ID.

If the task doesn't exist, a NotFoundError is thrown. If the task is currently running, a ConflictError is thrown.