排程函式的建構工具，採用 Google Pub/Sub 和 Cloud Scheduler。描述了部署的 Cloud Scheduler 工作，此工作會按照指定頻率觸發排程函式。詳情請參閱 [排程函式](/docs/functions/schedule-functions)。
透過 functions.pubsub.schedule()存取。
簽名：
export declare class ScheduleBuilder
建構函式
| 建構函式 | 修飾符 | 說明 |
|---|---|---|
| (buildor)(triggerResource, options) | 建構 ScheduleBuilder 類別的新例項 |
方法
| 方法 | 修飾符 | 說明 |
|---|---|---|
| onRun(處理常式) | 排程函式的事件處理常式。相關聯的排程器工作傳送 Pub/Sub 訊息時觸發。 | |
| retryConfig(config) | ||
| timeZone(timeZone) |
pubsub.ScheduleBuilder.(建構函式)
建構 ScheduleBuilder 類別的新例項
簽名：
constructor(triggerResource: () => string, options: DeploymentOptions);
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 觸發事件資源 | () =>字串 | |
| 選項 | DeploymentOptions |
pubsub.ScheduleBuilder.onRun()
排程函式的事件處理常式。相關聯的排程器工作傳送 Pub/Sub 訊息時觸發。
簽名：
onRun(handler: (context: EventContext) => PromiseLike<any> | any): CloudFunction<unknown>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| handler | (背景資訊：EventContext) =>承諾<任何>|任何 | 每當相關聯的排程器工作傳送 Pub/Sub 訊息時，就會觸發這個處理常式。 |
傳回：
CloudFunction<unknown>
可匯出及部署的函式。
pubsub.ScheduleBuilder.retryConfig()
簽名：
retryConfig(config: ScheduleRetryConfig): ScheduleBuilder;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| config | Schedule 重試 Config |
傳回：
pubsub.ScheduleBuilder.timeZone()
簽名：
timeZone(timeZone: string): ScheduleBuilder;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 時區 | 字串 |
傳回：