Schedule interface
Stay organized with collections
Save and categorize content based on your preferences.
Configuration options for scheduled functions.
Signature:
export interface Schedule
Properties
Property |
Type |
Description |
retryConfig |
ScheduleRetryConfig |
Settings that determine the retry behavior. |
schedule |
string |
Describes the schedule on which the job will be executed.The schedule can be either of the following types:1. Crontab2. English-like schedule |
timeZone |
string | ResetValue |
Specifies the time zone to be used in interpreting Schedule.schedule.The value of this field must be a time zone name from the tz database. |
Schedule.retryConfig
Settings that determine the retry behavior.
Signature:
retryConfig?: ScheduleRetryConfig;
Schedule.schedule
Describes the schedule on which the job will be executed.
The schedule can be either of the following types:
Crontab
English-like schedule
Signature:
schedule: string;
Example
// Crontab schedule
schedule: "0 9 * * 1"` // Every Monday at 09:00 AM
// English-like schedule
schedule: "every 5 minutes"
Schedule.timeZone
Specifies the time zone to be used in interpreting Schedule.schedule.
The value of this field must be a time zone name from the tz database.
Signature:
timeZone?: string | ResetValue;
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 2022-10-14 UTC.
[null,null,["Last updated 2022-10-14 UTC."],[],[],null,["# Schedule interface\n\nConfiguration options for scheduled functions.\n\n**Signature:** \n\n export interface Schedule \n\nProperties\n----------\n\n| Property | Type | Description |\n|---------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [retryConfig](./firebase-functions.schedule.md#scheduleretryconfig) | [ScheduleRetryConfig](./firebase-functions.scheduleretryconfig.md#scheduleretryconfig_interface) | Settings that determine the retry behavior. |\n| [schedule](./firebase-functions.schedule.md#scheduleschedule) | string | Describes the schedule on which the job will be executed.The schedule can be either of the following types:1. [Crontab](https://en.wikipedia.org/wiki/Cron#Overview)2. English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) |\n| [timeZone](./firebase-functions.schedule.md#scheduletimezone) | string \\| ResetValue | Specifies the time zone to be used in interpreting [Schedule.schedule](./firebase-functions.schedule.md#scheduleschedule).The value of this field must be a time zone name from the tz database. |\n\nSchedule.retryConfig\n--------------------\n\nSettings that determine the retry behavior.\n\n**Signature:** \n\n retryConfig?: ScheduleRetryConfig;\n\nSchedule.schedule\n-----------------\n\nDescribes the schedule on which the job will be executed.\n\nThe schedule can be either of the following types:\n\n1. [Crontab](https://en.wikipedia.org/wiki/Cron#Overview)\n\n2. English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)\n\n**Signature:** \n\n schedule: string;\n\n### Example\n\n // Crontab schedule\n schedule: \"0 9 * * 1\"` // Every Monday at 09:00 AM\n\n // English-like schedule\n schedule: \"every 5 minutes\"\n\nSchedule.timeZone\n-----------------\n\nSpecifies the time zone to be used in interpreting [Schedule.schedule](./firebase-functions.schedule.md#scheduleschedule).\n\nThe value of this field must be a time zone name from the tz database.\n\n**Signature:** \n\n timeZone?: string | ResetValue;"]]