pubsub.PubSubOptions interface

PubSubOptions は EventHandlerOptions を拡張しますが、トピックを含める必要があります。

署名:

export interface PubSubOptions extends options.EventHandlerOptions 

拡張: options.EventHandlerOptions

プロパティ

プロパティ 説明
同時実行 数値 |式<number>|値をリセット 関数が一度に処理できるリクエストの数。
CPU 数値 |「gcf_gen1」 関数に割り当てる CPU の小数点数。
ingressSettings options.IngressSetting |値をリセット この関数をどこから呼び出せるかを制御する上り(内向き)設定。
labels レコード<文字列, 文字列> 関数に設定するユーザーラベル。
maxInstances 数値 |式<number>|値をリセット 並行して実行するインスタンスの最大数。
メモリ options.MemoryOption |<number>|値をリセット 関数に割り当てるメモリの量。
minInstances 数値 |式<number>|値をリセット 特定の時間に実行される実際のインスタンスの最小数。
省略 ブール値 |式<boolean> true の場合、この関数をデプロイまたはエミュレートしないでください。
region options.SupportedRegion |文字列 |<string>|値をリセット 関数をデプロイするリージョン。
再試行 ブール値 |式<boolean>|値をリセット 失敗した実行を再度配信するかどうか。
シークレット (文字列 | SecretParam)[]
serviceAccount 文字列 |式<string>|値をリセット 関数を実行する特定のサービス アカウント。
timeoutSeconds 数値 |式<number>|値をリセット 関数のタイムアウト(秒)。有効な値は 0 ~ 540 です。HTTPS 関数では、より高いタイムアウトを指定できます。
トピック 文字列 メッセージ イベントを監視する Pub/Sub トピック
vpcConnector 文字列 |式<string>|値をリセット 指定された VPC コネクタに Cloud Functions の関数を接続します。
vpcConnectorEgressSettings options.VpcEgressSetting |値をリセット VPC コネクタの下り(外向き)設定。

pubsub.PubSubOptions.concurrency

関数が一度に処理できるリクエストの数。

Cloud Functions v2 で実行される関数にのみ適用できます。値を null にすると、デフォルトの同時実行数が復元されます(CPU >= 1 の場合は 80、それ以外の場合は 1)。cpu が 1 未満の場合、同時実行を 1 以外の値に設定することはできません。同時実行の最大値は 1,000 です。

署名:

concurrency?: number | Expression<number> | ResetValue;

pubsub.PubSubOptions.cpu

関数に割り当てる CPU の小数点数。

<= RAM が 2 GB の関数のデフォルトは 1 で、メモリサイズが大きいほど増加します。これは、gcloud ユーティリティを使用する際のデフォルトとは異なり、第 1 世代の Google Cloud Functions に割り当てられた固定数とは異なります。gcloud または Cloud Functions(第 1 世代)で使用されている CPU 量に戻すには、この値を「gcf_gen1」に設定します

署名:

cpu?: number | "gcf_gen1";

pubsub.PubSubOptions.ingressSettings

この関数をどこから呼び出せるかを制御する上り(内向き)設定。

署名:

ingressSettings?: options.IngressSetting | ResetValue;

pubsub.PubSubOptions.labels

関数に設定するユーザーラベル。

署名:

labels?: Record<string, string>;

pubsub.PubSubOptions.maxInstances

並行して実行するインスタンスの最大数。

署名:

maxInstances?: number | Expression<number> | ResetValue;

pubsub.PubSubOptions.memory

関数に割り当てるメモリの量。

署名:

memory?: options.MemoryOption | Expression<number> | ResetValue;

pubsub.PubSubOptions.minInstances

特定の時間に実行される実際のインスタンスの最小数。

インスタンスは、アイドル状態のときにメモリ割り当てと CPU 割り当ての 10% に対して課金されます。

署名:

minInstances?: number | Expression<number> | ResetValue;

pubsub.PubSubOptions.omit

true の場合、この関数をデプロイまたはエミュレートしないでください。

署名:

omit?: boolean | Expression<boolean>;

pubsub.PubSubOptions.region

関数をデプロイするリージョン。

署名:

region?: options.SupportedRegion | string | Expression<string> | ResetValue;

pubsub.PubSubOptions.retry

失敗した実行を再度配信するかどうか。

署名:

retry?: boolean | Expression<boolean> | ResetValue;

pubsub.PubSubOptions.secrets

署名:

secrets?: (string | SecretParam)[];

pubsub.PubSubOptions.serviceAccount

関数を実行する特定のサービス アカウント。

署名:

serviceAccount?: string | Expression<string> | ResetValue;

pubsub.PubSubOptions.timeoutSeconds

関数のタイムアウト(秒)。有効な値は 0 ~ 540 です。HTTPS 関数では、より高いタイムアウトを指定できます。

第 2 世代の関数の最小タイムアウトは 1 秒です。関数の最大タイムアウトは関数のタイプによって異なります。イベント処理関数の最大タイムアウトは 540 秒(9 分)です。HTTPS 関数と呼び出し可能関数の最大タイムアウトは 36,00 秒(1 時間)です。タスクキュー関数のタイムアウトの最大値は 1,800 秒(30 分)です。

署名:

timeoutSeconds?: number | Expression<number> | ResetValue;

pubsub.PubSubOptions.topic

メッセージ イベントを監視する Pub/Sub トピック

署名:

topic: string;

pubsub.PubSubOptions.vpcConnector

指定された VPC コネクタに Cloud Functions の関数を接続します。

署名:

vpcConnector?: string | Expression<string> | ResetValue;

pubsub.PubSubOptions.vpcConnectorEgressSettings

VPC コネクタの下り(外向き)設定。

署名:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;