GlobalOptions interface

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

サイン：

export interface GlobalOptions

プロパティ

財産タイプ説明
同時実行性番号 |表現<数値> |リセット値関数が一度に処理できるリクエストの数。
CPU番号 | 「gcf_gen1」関数に割り当てる CPU の小数。
AppCheck を強制するブール値Firebase App Check を強制するかどうかを決定します。デフォルトは false です。
イングレス設定イングレス設定|リセット値この関数をどこから呼び出せるかを制御するイングレス設定。
呼び出し者"パブリック" | "プライベート" |文字列 |弦[] HTTPS 関数にアクセス制御を設定する呼び出し元。
ラベルレコード<文字列、文字列>関数に設定するユーザーラベル。
最大インスタンス数番号 |表現<数値> |リセット値並行して実行できるインスタンスの最大数。
メモリメモリオプション|表現<数値> |リセット値関数に割り当てるメモリの量。
最小インスタンス数番号 |表現<数値> |リセット値特定の時間に実行される実際のインスタンスの最小数。
省略ブール値 |表現<ブール値> true の場合、この関数をデプロイまたはエミュレートしません。
外部変更を保存するブール値関数ソースの外部で変更された関数構成を保存するかどうかを制御します。デフォルトは false です。
地域サポートされている地域|文字列 |表現<文字列> |リセット値機能をデプロイする必要があるリージョン。
秘密(文字列 | SecretParam)[]
サービスアカウント文字列 |表現<文字列> |リセット値関数を実行するための特定のサービス アカウント。
タイムアウト秒番号 |表現<数値> |リセット値関数のタイムアウト (秒単位)。可能な値は 0 ～ 540 です。HTTPS 関数では、より長いタイムアウトを指定できます。
vpcコネクタ文字列 |表現<文字列> |リセット値関数を指定された VPC コネクタに接続します。
vpcConnectorEgressSettings VpcEgress設定|リセット値VPC コネクタの送信設定。

GlobalOptions.同時実行性

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

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

サイン：

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

GlobalOptions.cpu

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

< を含む関数のデフォルトは 1 です。 = 2GB RAM で、メモリ サイズが大きくなると増加します。これは、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.省略

true の場合、この関数をデプロイまたはエミュレートしません。

サイン：

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

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

Cloud Functions の Firebase SDK ではまだ利用できない、基盤となるプラットフォームで利用可能な構成を設定する場合は、 preserveExternalChangesをtrueに設定することをお勧めします。 。そうしないと、Google が欠落している構成をサポートする新しいバージョンの 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;