GlobalOptions interface

GlobalOptions は、プロジェクト全体に設定できるオプションです。これらのオプションは、HTTPS とイベント処理関数に共通です。

署名:

export interface GlobalOptions 

プロパティ

GlobalOptions.concurrency

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

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

署名:

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

GlobalOptions.cpu

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

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

署名:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

Firebase App Check を適用するかどうかを決定します。デフォルトは false です。

true の場合、無効なトークンを含むリクエストには 401（Unauthorized）エラーが自動的に返されます。false の場合、無効なトークンを含むリクエストでは、event.app が undefined に設定されます。

署名:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

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

署名:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.invoker

HTTPS 関数のアクセス制御を設定するための起動元。

署名:

invoker?: "public" | "private" | string | string[];

GlobalOptions.labels

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

署名:

labels?: Record<string, string>;

GlobalOptions.maxInstances

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

署名:

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

GlobalOptions.memory

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

署名:

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

GlobalOptions.minInstances

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

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

署名:

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

GlobalOptions.omit

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

署名:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

関数のソースの外部で変更された関数の設定を保持するかどうかを制御します。デフォルトは false です。

Firebase SDK for Cloud Functions でまだ使用できない、基盤となるプラットフォームで利用可能な構成を設定する場合は、preserveExternalChanges を true に設定することをおすすめします。そうしないと、欠落している構成をサポートする新しいバージョンの SDK がリリースされたときに、手動で設定した関数の設定が意図せず消去される可能性があります。

署名:

preserveExternalChanges?: boolean;

GlobalOptions.region

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

署名:

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

GlobalOptions.secrets

署名:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

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

署名:

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

GlobalOptions.timeoutSeconds

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

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

署名:

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

GlobalOptions.vpcConnector

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

署名:

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

GlobalOptions.vpcConnectorEgressSettings

VPC コネクタの下り（外向き）設定。

署名:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;