Конструктор запланированных функций на базе Google Pub/Sub и Cloud Scheduler. Описывает задание облачного планировщика, которое развертывается для запуска запланированной функции с заданной частотой. Дополнительную информацию см. в разделе [Функции расписания](/docs/functions/schedule-functions).
Доступ через functions.pubsub.schedule() .
Подпись:
export declare class ScheduleBuilder
Конструкторы
| Конструктор | Модификаторы | Описание |
|---|---|---|
| (конструктор) (triggerResource, параметры) | Создает новый экземпляр класса ScheduleBuilder . |
Методы
| Метод | Модификаторы | Описание |
|---|---|---|
| onRun (обработчик) | Обработчик событий для запланированных функций. Запускается всякий раз, когда связанное задание планировщика отправляет сообщение Pub/Sub. | |
| повторная конфигурация (конфигурация) | ||
| часовой пояс (часовой пояс) |
pubsub.ScheduleBuilder.(конструктор)
Создает новый экземпляр класса ScheduleBuilder .
Подпись:
constructor(triggerResource: () => string, options: DeploymentOptions);
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| триггерРесурс | () => строка | |
| параметры | Параметры развертывания |
pubsub.ScheduleBuilder.onRun()
Обработчик событий для запланированных функций. Запускается всякий раз, когда связанное задание планировщика отправляет сообщение Pub/Sub.
Подпись:
onRun(handler: (context: EventContext) => PromiseLike<any> | any): CloudFunction<unknown>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| обработчик | (контекст: EventContext ) => PromiseLike<любой> | любой | Обработчик, который срабатывает всякий раз, когда связанное задание планировщика отправляет сообщение Pub/Sub. |
Возврат:
Облачная функция <неизвестно>
Функция, которую можно экспортировать и развернуть.
pubsub.ScheduleBuilder.retryConfig()
Подпись:
retryConfig(config: ScheduleRetryConfig): ScheduleBuilder;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| конфигурация | РасписаниеRetryConfig |
Возврат:
pubsub.ScheduleBuilder.timeZone()
Подпись:
timeZone(timeZone: string): ScheduleBuilder;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| часовой пояс | нить |
Возврат: