pubsub.ScheduleBuilder class

計劃功能的建構器,由 Google Pub/Sub 和 Cloud Scheduler 提供支援。描述部署以按提供的頻率觸發計劃功能的 Cloud Scheduler 作業。有關更多信息,請參閱[計劃函數](/docs/functions/schedule-functions)。

透過functions.pubsub.schedule()訪問

簽名:

export declare class ScheduleBuilder 

建構函數

建構函數修飾符描述
(建構函數)(觸發資源,選項)建構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;

參數

範圍類型描述
配置計劃重試配置

返回:

時間表產生器

pubsub.ScheduleBuilder.timeZone()

簽名:

timeZone(timeZone: string): ScheduleBuilder;

參數

範圍類型描述
時區細繩

返回:

時間表產生器