scheduler.ScheduledEvent interface
Stay organized with collections
Save and categorize content based on your preferences.
Interface representing a ScheduleEvent that is passed to the function handler.
Signature:
export interface ScheduledEvent
Properties
| Property |
Type |
Description |
| jobName |
string |
The Cloud Scheduler job name. Populated via the X-CloudScheduler-JobName header.If invoked manually, this field is undefined. |
| scheduleTime |
string |
For Cloud Scheduler jobs specified in the unix-cron format, this is the job schedule time in RFC3339 UTC "Zulu" format. Populated via the X-CloudScheduler-ScheduleTime header.If the schedule is manually triggered, this field will be the function execution time. |
scheduler.ScheduledEvent.jobName
The Cloud Scheduler job name. Populated via the X-CloudScheduler-JobName header.
If invoked manually, this field is undefined.
Signature:
jobName?: string;
scheduler.ScheduledEvent.scheduleTime
For Cloud Scheduler jobs specified in the unix-cron format, this is the job schedule time in RFC3339 UTC "Zulu" format. Populated via the X-CloudScheduler-ScheduleTime header.
If the schedule is manually triggered, this field will be the function execution time.
Signature:
scheduleTime: string;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-03-21 UTC.
[null,null,["Last updated 2023-03-21 UTC."],[],[],null,["# scheduler.ScheduledEvent interface\n\nInterface representing a ScheduleEvent that is passed to the function handler.\n\n**Signature:** \n\n export interface ScheduledEvent \n\nProperties\n----------\n\n| Property | Type | Description |\n|------------------------------------------------------------------------------------------------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [jobName](./firebase-functions.scheduler.scheduledevent.md#schedulerscheduledeventjobname) | string | The Cloud Scheduler job name. Populated via the X-CloudScheduler-JobName header.If invoked manually, this field is undefined. |\n| [scheduleTime](./firebase-functions.scheduler.scheduledevent.md#schedulerscheduledeventscheduletime) | string | For Cloud Scheduler jobs specified in the unix-cron format, this is the job schedule time in RFC3339 UTC \"Zulu\" format. Populated via the X-CloudScheduler-ScheduleTime header.If the schedule is manually triggered, this field will be the function execution time. |\n\nscheduler.ScheduledEvent.jobName\n--------------------------------\n\nThe Cloud Scheduler job name. Populated via the X-CloudScheduler-JobName header.\n\nIf invoked manually, this field is undefined.\n\n**Signature:** \n\n jobName?: string;\n\nscheduler.ScheduledEvent.scheduleTime\n-------------------------------------\n\nFor Cloud Scheduler jobs specified in the unix-cron format, this is the job schedule time in RFC3339 UTC \"Zulu\" format. Populated via the X-CloudScheduler-ScheduleTime header.\n\nIf the schedule is manually triggered, this field will be the function execution time.\n\n**Signature:** \n\n scheduleTime: string;"]]
