Google Pub/Sub と Cloud Scheduler を利用したスケジュールされた関数のビルダー。指定された頻度でスケジュールされた機能をトリガーするためにデプロイされる Cloud Scheduler ジョブについて説明します。詳細については、「スケジュール関数」(/docs/functions/schedule-functions) を参照してください。
functions.pubsub.schedule()経由でアクセス。
サイン：
export declare class ScheduleBuilder
コンストラクター
| コンストラクタ | 修飾子 | 説明 |
|---|---|---|
| (コンストラクター)(トリガーリソース、オプション) | ScheduleBuilderクラスの新しいインスタンスを構築します。 |
メソッド
| 方法 | 修飾子 | 説明 |
|---|---|---|
| onRun(ハンドラー) | スケジュールされた関数のイベント ハンドラー。関連付けられたスケジューラ ジョブが Pub/Sub メッセージを送信するたびにトリガーされます。 | |
| retryConfig(構成) | ||
| タイムゾーン(タイムゾーン) |
pubsub.ScheduleBuilder.(コンストラクター)
ScheduleBuilderクラスの新しいインスタンスを構築します。
サイン：
constructor(triggerResource: () => string, options: DeploymentOptions);
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| トリガーリソース | () => 文字列 | |
| オプション | 導入オプション |
pubsub.ScheduleBuilder.onRun()
スケジュールされた関数のイベント ハンドラー。関連付けられたスケジューラ ジョブが Pub/Sub メッセージを送信するたびにトリガーされます。
サイン：
onRun(handler: (context: EventContext) => PromiseLike<any> | any): CloudFunction<unknown>;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| ハンドラ | (コンテキスト:イベントコンテキスト) => PromiseLike<任意> |どれでも | 関連付けられたスケジューラ ジョブが Pub/Sub メッセージを送信するたびに起動されるハンドラ。 |
戻り値：
クラウドファンクション<不明>
エクスポートしてデプロイできる機能。
pubsub.ScheduleBuilder.retryConfig()
サイン：
retryConfig(config: ScheduleRetryConfig): ScheduleBuilder;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| 構成 | スケジュール再試行構成 |
戻り値：
pubsub.ScheduleBuilder.timeZone()
サイン：
timeZone(timeZone: string): ScheduleBuilder;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| タイムゾーン | 弦 |
戻り値：