pubsub.ScheduleBuilder class

Google Pub/Sub と Cloud Scheduler を利用する、スケジュール設定された関数のビルダー。指定された頻度でスケジュール設定された関数をトリガーするようにデプロイされる Cloud Scheduler ジョブを記述します。詳しくは、[関数のスケジュール設定](/docs/functions/schedule-functions)をご覧ください。

functions.pubsub.schedule() でアクセス。

署名:

export declare class ScheduleBuilder 

コンストラクタ

メソッド

pubsub.ScheduleBuilder.(コンストラクタ)

ScheduleBuilder クラスの新しいインスタンスを作成します。

署名:

constructor(triggerResource: () => string, options: DeploymentOptions);

パラメータ

pubsub.ScheduleBuilder.onRun()

スケジュール設定された関数のイベント ハンドラ。関連するスケジューラ ジョブが Pub/Sub メッセージを送信するたびにトリガーされます。

署名:

onRun(handler: (context: EventContext) => PromiseLike<any> | any): CloudFunction<unknown>;

パラメータ

戻り値:

CloudFunction<不明>

エクスポートしてデプロイできる関数。

pubsub.ScheduleBuilder.retryConfig()

署名:

retryConfig(config: ScheduleRetryConfig): ScheduleBuilder;

パラメータ

戻り値:

ScheduleBuilder

pubsub.ScheduleBuilder.timeZone()

署名:

timeZone(timeZone: string): ScheduleBuilder;

パラメータ

戻り値:

ScheduleBuilder