alerts.FirebaseAlertOptions interface

Firebase アラート関数の構成。

署名:

export interface FirebaseAlertOptions extends options.EventHandlerOptions

拡張: options.EventHandlerOptions

プロパティ

プロパティ 型 説明
alertType AlertType アラートタイプでトリガーするハンドラのスコープを設定します。
appId 文字列 特定のアプリケーションでトリガーするように関数のスコープを設定します。
同時実行 数値 |式<number>|値をリセット 関数が一度に処理できるリクエストの数。Cloud Functions v2 で実行される関数にのみ適用できます。値を null にすると、デフォルトの同時実行数が復元されます（CPU >= 1 の場合は 80、それ以外の場合は 1）。cpu が 1 未満の場合、同時実行を 1 以外の値に設定することはできません。同時実行の最大値は 1,000 です。
CPU 数値 |「gcf_gen1」 関数に割り当てる CPU の小数点数。<= RAM が 2 GB の関数のデフォルトは 1 で、メモリサイズが大きいほど増加します。これは、gcloud ユーティリティを使用する際のデフォルトとは異なり、第 1 世代の Google Cloud Functions に割り当てられた固定数とは異なります。gcloud または Cloud Functions（第 1 世代）で使用されている CPU 量に戻すには、この値を「gcf_gen1」に設定します
ingressSettings options.IngressSetting |値をリセット この関数をどこから呼び出せるかを制御する上り（内向き）設定。値を null にすると、上り（内向き）設定がオフになります。
labels レコード<文字列, 文字列> 関数に設定するユーザーラベル。
maxInstances 数値 |式<number>|値をリセット 並行して実行するインスタンスの最大数。値を null にすると、デフォルトの最大インスタンス数が復元されます。
メモリ options.MemoryOption |式<number>|値をリセット 関数に割り当てるメモリの量。値を null にすると、デフォルトの 256 MB に戻ります。
minInstances 数値 |式<number>|値をリセット 特定の時間に実行される実際のインスタンスの最小数。インスタンスは、アイドル状態のときにメモリ割り当てと CPU 割り当ての 10% に対して課金されます。値を null にすると、デフォルトの最小インスタンス数が復元されます。
省略 ブール値 |式<boolean> true の場合、この関数をデプロイまたはエミュレートしないでください。
region options.SupportedRegion |文字列 |式<string>|値をリセット 関数をデプロイするリージョン。
再試行 ブール値 |式<boolean>|値をリセット 失敗した実行を再度配信するかどうか。
シークレット （文字列 | SecretParam)[]
serviceAccount 文字列 |式<string>|値をリセット 関数を実行する特定のサービス アカウント。値を null にすると、デフォルトのサービス アカウントが復元されます。
timeoutSeconds 数値 |式<number>|値をリセット 関数のタイムアウト（秒）。有効な値は 0 ～ 540 です。HTTPS 関数では、より高いタイムアウトを指定できます。値を null にすると、デフォルトの 60 秒に戻ります。第 2 世代の関数の最小タイムアウトは 1 秒です。関数の最大タイムアウトは関数のタイプによって異なります。イベント処理関数の最大タイムアウトは 540 秒（9 分）です。HTTPS 関数と呼び出し可能関数の最大タイムアウトは 36,00 秒（1 時間）です。タスクキュー関数のタイムアウトの最大値は 1,800 秒（30 分）です。
vpcConnector 文字列 |式<string>|値をリセット 指定された VPC コネクタに Cloud Functions の関数を接続します。値が null の場合、VPC コネクタが削除されます。
vpcConnectorEgressSettings options.VpcEgressSetting |値をリセット VPC コネクタの下り（外向き）設定。値を null にすると、VPC コネクタの下り（外向き）設定がオフになります

alert.FirebaseAlertOptions.alertType

アラートタイプでトリガーするハンドラのスコープを設定します。

署名:

alertType: AlertType;

alert.FirebaseAlertOptions.appId

特定のアプリケーションでトリガーするように関数のスコープを設定します。

署名:

appId?: string;

alert.FirebaseAlertOptions.concurrency

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

署名:

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

alert.FirebaseAlertOptions.cpu

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

署名:

cpu?: number | "gcf_gen1";

alert.FirebaseAlertOptions.ingressSettings

この関数をどこから呼び出せるかを制御する上り（内向き）設定。値を null にすると、上り（内向き）設定がオフになります。

署名:

ingressSettings?: options.IngressSetting | ResetValue;

alert.FirebaseAlertOptions.labels

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

署名:

labels?: Record<string, string>;

alert.FirebaseAlertOptions.maxInstances

並行して実行するインスタンスの最大数。値を null にすると、デフォルトの最大インスタンス数が復元されます。

署名:

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

alert.FirebaseAlertOptions.memory.

関数に割り当てるメモリの量。値を null にすると、デフォルトの 256 MB に戻ります。

署名:

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

alert.FirebaseAlertOptions.minInstances

特定の時間に実行される実際のインスタンスの最小数。インスタンスは、アイドル状態のときにメモリ割り当てと CPU 割り当ての 10% に対して課金されます。値を null にすると、デフォルトの最小インスタンス数が復元されます。

署名:

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

alert.FirebaseAlertOptions.omit

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

署名:

omit?: boolean | Expression<boolean>;

alert.FirebaseAlertOptions.region

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

署名:

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

alert.FirebaseAlertOptions.retry

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

署名:

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

alert.FirebaseAlertOptions.secrets

署名:

secrets?: (string | SecretParam)[];

alert.FirebaseAlertOptions.serviceAccount

関数を実行する特定のサービス アカウント。値を null にすると、デフォルトのサービス アカウントが復元されます。

署名:

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

alert.FirebaseAlertOptions.timeoutSeconds

関数のタイムアウト（秒）。有効な値は 0 ～ 540 です。HTTPS 関数では、より高いタイムアウトを指定できます。値を null にすると、デフォルトの 60 秒に戻ります。第 2 世代の関数の最小タイムアウトは 1 秒です。関数の最大タイムアウトは関数のタイプによって異なります。イベント処理関数の最大タイムアウトは 540 秒（9 分）です。HTTPS 関数と呼び出し可能関数の最大タイムアウトは 36,00 秒（1 時間）です。タスクキュー関数のタイムアウトの最大値は 1,800 秒（30 分）です。

署名:

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

alert.FirebaseAlertOptions.vpcConnector

指定された VPC コネクタに Cloud Functions の関数を接続します。値が null の場合、VPC コネクタが削除されます。

署名:

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

alert.FirebaseAlertOptions.vpcConnectorEgressSettings

VPC コネクタの下り（外向き）設定。値を null にすると、VPC コネクタの下り（外向き）設定がオフになります

署名:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;