GlobalOptions は、プロジェクト全体で設定できるオプションです。これらのオプションは、HTTPS およびイベント処理関数に共通です。
サイン:
export interface GlobalOptions
プロパティ
財産 | タイプ | 説明 |
---|---|---|
同時性 | 数 |式<数値> |リセット値 | 関数が一度に処理できるリクエストの数。 |
CPU | 数 | "gcf_gen1" | 関数に割り当てる CPU の端数。 |
enforceAppCheck | ブール値 | Firebase AppCheck を適用するかどうかを決定します。デフォルトは false です。 |
イングレス設定 | イングレス設定|リセット値 | この関数をどこから呼び出すことができるかを制御するイングレス設定。 |
インボーカー | "パブリック" | "プライベート" |文字列 |弦[] | https 関数にアクセス制御を設定する呼び出し元。 |
ラベル | Record<string, string> | 関数に設定するユーザー ラベル。 |
最大インスタンス数 | 数 |式<数値> |リセット値 | 並行して実行するインスタンスの最大数。 |
メモリー | メモリ オプション|式<数値> |リセット値 | 関数に割り当てるメモリの量。 |
最小インスタンス数 | 数 |式<数値> |リセット値 | 特定の時間に実行される実際のインスタンスの最小数。 |
省略 | ブール値 |式<ブール値> | true の場合、この関数をデプロイまたはエミュレートしません。 |
preserveExternalChanges | ブール値 | 関数ソースの外部で変更された関数構成を保持するかどうかを制御します。デフォルトは false です。 |
領域 | サポートされている地域|弦 | 関数をデプロイするリージョン。 |
秘密 | (文字列 | SecretParam)[] | |
サービスアカウント | 文字列 |リセット値 | 関数を実行するための特定のサービス アカウント。 |
タイムアウト秒 | 数 |式<数値> |リセット値 | 関数のタイムアウト (秒単位)。有効な値は 0 ~ 540 です。HTTPS 関数では、より高いタイムアウトを指定できます。 |
vpcコネクタ | 文字列 |式<文字列> |リセット値 | 指定した VPC コネクタにクラウド機能を接続します。 |
vpcConnectorEgressSettings | VpcEgress 設定|リセット値 | VPC コネクタの下り設定。 |
GlobalOptions.concurrency
関数が一度に処理できるリクエストの数。
Cloud Functions v2 で実行されている関数にのみ適用できます。 null の値は、デフォルトの同時実行数を復元します (CPU > の場合は 80)。 = 1、それ以外の場合は 1)。 cpu
が 1 未満の場合、同時実行数を 1 以外の値に設定することはできません。同時実行数の最大値は 1,000 です。
サイン:
concurrency?: number | Expression<number> | ResetValue;
GlobalOptions.cpu
関数に割り当てる CPU の端数。
< を持つ関数のデフォルトは 1 です。 = 2GB の RAM で、メモリ サイズが大きくなると増加します。これは、gcloud ユーティリティを使用するときのデフォルトとは異なり、Google Cloud Functions 第 1 世代で割り当てられた固定量とは異なります。gcloud または Cloud Functions 第 1 世代で使用される CPU 量に戻すには、これを値「gcf_gen1」に設定します。
サイン:
cpu?: number | "gcf_gen1";
GlobalOptions.enforceAppCheck
Firebase AppCheck を適用するかどうかを決定します。デフォルトは false です。
true の場合、無効なトークンを含むリクエストは 401 (未承認) エラーで自動応答します。 false の場合、無効なトークンを含むリクエストは、event.app を未定義に設定します。
サイン:
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 Functions SDK でまだ利用できない、基盤となるプラットフォームで利用可能な構成を設定する場合は、 preserveExternalChanges
をtrue
に設定することを強くお勧めします.そうしないと、欠落している構成をサポートする新しいバージョンの SDK が Firebase Functions SDK によってリリースされたときに、関数の手動で構成された設定が誤って消去される可能性があります。
サイン:
preserveExternalChanges?: boolean;
GlobalOptions.region
関数をデプロイするリージョン。
サイン:
region?: SupportedRegion | string;
GlobalOptions.secrets
サイン:
secrets?: (string | SecretParam)[];
GlobalOptions.serviceAccount
関数を実行するための特定のサービス アカウント。
サイン:
serviceAccount?: string | ResetValue;
GlobalOptions.timeoutSeconds
関数のタイムアウト (秒単位)。有効な値は 0 ~ 540 です。HTTPS 関数では、より高いタイムアウトを指定できます。
gen 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;