scheduler namespace
Functions
| Function | Description |
|---|---|
| onSchedule(schedule, handler) | Handler for scheduled functions. Triggered whenever the associated scheduler job sends a http request. |
| onSchedule(options, handler) | Handler for scheduled functions. Triggered whenever the associated scheduler job sends a http request. |
Interfaces
| Interface | Description |
|---|---|
| ScheduledEvent | Interface representing a ScheduleEvent that is passed to the function handler. |
| ScheduleFunction | The Cloud Function type for Schedule triggers. |
| ScheduleOptions | Options that can be set on a Schedule trigger. |
scheduler.onSchedule()
Handler for scheduled functions. Triggered whenever the associated scheduler job sends a http request.
Signature:
exportdeclarefunctiononSchedule(schedule:string,handler:(event:ScheduledEvent)=>void|Promise<void>):ScheduleFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| schedule | string | The schedule, in Unix Crontab or AppEngine syntax. |
| handler | (event:ScheduledEvent) => void | Promise<void> | A function to execute when triggered. |
Returns:
A function that you can export and deploy.
scheduler.onSchedule()
Handler for scheduled functions. Triggered whenever the associated scheduler job sends a http request.
Signature:
exportdeclarefunctiononSchedule(options:ScheduleOptions,handler:(event:ScheduledEvent)=>void|Promise<void>):ScheduleFunction;Parameters
| Parameter | Type | Description |
|---|---|---|
| options | ScheduleOptions | Options to set on scheduled functions. |
| handler | (event:ScheduledEvent) => void | Promise<void> | A function to execute when triggered. |
Returns:
A function that you can export and deploy.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-04-18 UTC.