RuntimeOptions interface

実行時に適用できる関数の構成オプション。

サイン:

export interface RuntimeOptions 

プロパティ

財産タイプ説明
消費AppCheckTokenブール値Firebase App Check トークンがリクエストに応じて消費されるかどうかを決定します。デフォルトは false です。
AppCheck を強制するブール値Firebase AppCheck を強制するかどうかを決定します。
失敗ポリシー失敗ポリシー|ブール値関数の失敗ポリシー。ブール値true空の再試行オブジェクトを提供するのと同じです。
イングレス設定( INGRESS_SETTINGS_OPTIONSのタイプ)[数値] |リセット値この関数をどこから呼び出せるかを制御するイングレス設定。
呼び出し者"パブリック" | "プライベート" |文字列 |弦[] https 関数にアクセス制御を設定する呼び出し元。
ラベルレコード<文字列、文字列>関数に設定するユーザーラベル。
最大インスタンス数番号 |表現<数値> |リセット値並行して実行できる実際のインスタンスの最大数。
メモリ( VALID_MEMORY_OPTIONSのタイプ)[数値] |表現<数値> |リセット値関数に割り当てるメモリの量。
最小インスタンス数番号 |表現<数値> |リセット値特定の時間に実行される実際のインスタンスの最小数。
外部変更を保存するブール値関数ソースの外部で変更された関数構成を保存するかどうかを制御します。デフォルトは false です。
秘密(文字列 | SecretParam)[]
サービスアカウント"デフォルト" |文字列 |表現<文字列> |リセット値関数を実行するための特定のサービス アカウント。
タイムアウト秒番号 |表現<数値> |リセット値関数のタイムアウト (秒単位)。可能な値は 0 ~ 540 です。
vpcコネクタ文字列 |表現<文字列> |リセット値指定した VPC コネクタにクラウド機能を接続します。
vpcConnectorEgressSettings ( VPC_EGRESS_SETTINGS_OPTIONSのタイプ)[数値] |リセット値VPC コネクタの送信設定。

RuntimeOptions.consumeAppCheckToken

Firebase App Check トークンがリクエストに応じて消費されるかどうかを決定します。デフォルトは false です。

これを true に設定すると、呼び出し可能なリクエストで App Check トークンを消費することで App Check リプレイ保護機能が有効になります。すでに消費されていることが判明したトークンのrequest.app.alreadyConsumedプロパティは true に設定されます。

トークンは、このオプションを true に設定して App Check サービスに送信された場合にのみ消費されたとみなされます。トークンのその他の使用ではトークンは消費されません。

このリプレイ保護機能では、App Check バックエンドへの追加のネットワーク呼び出しが必要であり、クライアントは選択した証明書プロバイダーから新しい証明書を取得する必要があります。したがって、これはパフォーマンスに悪影響を及ぼす可能性があり、構成証明プロバイダーのクォータをより早く使い果たす可能性があります。この機能は、少量の操作、セキュリティが重要な操作、またはコストのかかる操作を保護する場合にのみ使用してください。

このオプションは、 enforceAppCheckオプションには影響しません。後者を true に設定すると、リクエストに無効な App Check トークンが含まれている場合、呼び出し可能関数は自動的に 401 Unauthorized ステータス コードで応答します。リクエストに有効ではあるが消費された App Check トークンが含まれている場合、リクエストは自動的に拒否されません。代わりに、 request.app.alreadyConsumedプロパティが true に設定され、追加のセキュリティ チェックの要求やリクエストの拒否など、さらなる決定を行うためにハンドラー コードに実行が渡されます。

サイン:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Firebase AppCheck を強制するかどうかを決定します。

true の場合、無効なトークンを含むリクエストは 401 (Unauthorized) エラーで自動応答します。 false の場合、無効なトークンを含むリクエストは context.app を undefiend に設定します。

サイン:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

関数の失敗ポリシー。ブール値true空の再試行オブジェクトを提供するのと同じです。

サイン:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

この関数をどこから呼び出せるかを制御するイングレス設定。

サイン:

ingressSettings?: (typeof INGRESS_SETTINGS_OPTIONS)[number] | ResetValue;

RuntimeOptions.invoker

https 関数にアクセス制御を設定する呼び出し元。

サイン:

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

RuntimeOptions.labels

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

サイン:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

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

サイン:

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

RuntimeOptions.memory

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

サイン:

memory?: (typeof VALID_MEMORY_OPTIONS)[number] | Expression<number> | ResetValue;

RuntimeOptions.minInstances

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

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

サイン:

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

RuntimeOptions.preserveExternalChanges

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

Firebase Functions SDK ではまだ利用できない、基盤となるプラットフォームで利用可能な構成を設定する場合は、 preserveExternalChangestrueに設定することを強くお勧めします。 。そうしないと、Firebase Functions SDK が不足している構成をサポートする新しいバージョンの SDK をリリースしたときに、関数の手動で構成された設定が誤って消去される可能性があります。

サイン:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

サイン:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

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

サイン:

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

RuntimeOptions.timeoutSeconds

関数のタイムアウト (秒単位)。可能な値は 0 ~ 540 です。

サイン:

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

RuntimeOptions.vpcConnector

指定した VPC コネクタにクラウド機能を接続します。

サイン:

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

RuntimeOptions.vpcConnectorEgressSettings

VPC コネクタの送信設定。

サイン:

vpcConnectorEgressSettings?: (typeof VPC_EGRESS_SETTINGS_OPTIONS)[number] | ResetValue;

実行時に適用できる関数の構成オプション。

サイン:

export interface RuntimeOptions 

プロパティ

財産タイプ説明
消費AppCheckTokenブール値Firebase App Check トークンがリクエストに応じて消費されるかどうかを決定します。デフォルトは false です。
AppCheck を強制するブール値Firebase AppCheck を強制するかどうかを決定します。
失敗ポリシー失敗ポリシー|ブール値関数の失敗ポリシー。ブール値true空の再試行オブジェクトを提供するのと同じです。
イングレス設定( INGRESS_SETTINGS_OPTIONSのタイプ)[数値] |リセット値この関数をどこから呼び出せるかを制御するイングレス設定。
呼び出し者"パブリック" | "プライベート" |文字列 |弦[] https 関数にアクセス制御を設定する呼び出し元。
ラベルレコード<文字列、文字列>関数に設定するユーザーラベル。
最大インスタンス数番号 |表現<数値> |リセット値並行して実行できる実際のインスタンスの最大数。
メモリ( VALID_MEMORY_OPTIONSのタイプ)[数値] |表現<数値> |リセット値関数に割り当てるメモリの量。
最小インスタンス数番号 |表現<数値> |リセット値特定の時間に実行される実際のインスタンスの最小数。
外部変更を保存するブール値関数ソースの外部で変更された関数構成を保存するかどうかを制御します。デフォルトは false です。
秘密(文字列 | SecretParam)[]
サービスアカウント"デフォルト" |文字列 |表現<文字列> |リセット値関数を実行するための特定のサービス アカウント。
タイムアウト秒番号 |表現<数値> |リセット値関数のタイムアウト (秒単位)。可能な値は 0 ~ 540 です。
vpcコネクタ文字列 |表現<文字列> |リセット値指定した VPC コネクタにクラウド機能を接続します。
vpcConnectorEgressSettings ( VPC_EGRESS_SETTINGS_OPTIONSのタイプ)[数値] |リセット値VPC コネクタの送信設定。

RuntimeOptions.consumeAppCheckToken

Firebase App Check トークンがリクエストに応じて消費されるかどうかを決定します。デフォルトは false です。

これを true に設定すると、呼び出し可能なリクエストで App Check トークンを消費することで App Check リプレイ保護機能が有効になります。すでに消費されていることが判明したトークンのrequest.app.alreadyConsumedプロパティは true に設定されます。

トークンは、このオプションを true に設定して App Check サービスに送信された場合にのみ消費されたとみなされます。トークンのその他の使用ではトークンは消費されません。

このリプレイ保護機能では、App Check バックエンドへの追加のネットワーク呼び出しが必要であり、クライアントは選択した証明書プロバイダーから新しい証明書を取得する必要があります。したがって、これはパフォーマンスに悪影響を及ぼす可能性があり、構成証明プロバイダーのクォータをより早く使い果たす可能性があります。この機能は、少量の操作、セキュリティが重要な操作、またはコストのかかる操作を保護する場合にのみ使用してください。

このオプションは、 enforceAppCheckオプションには影響しません。後者を true に設定すると、リクエストに無効な App Check トークンが含まれている場合、呼び出し可能関数は自動的に 401 Unauthorized ステータス コードで応答します。リクエストに有効ではあるが消費された App Check トークンが含まれている場合、リクエストは自動的に拒否されません。代わりに、 request.app.alreadyConsumedプロパティが true に設定され、追加のセキュリティ チェックの要求やリクエストの拒否など、さらなる決定を行うためにハンドラー コードに実行が渡されます。

サイン:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Firebase AppCheck を強制するかどうかを決定します。

true の場合、無効なトークンを含むリクエストは 401 (Unauthorized) エラーで自動応答します。 false の場合、無効なトークンを含むリクエストは context.app を undefiend に設定します。

サイン:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

関数の失敗ポリシー。ブール値true空の再試行オブジェクトを提供するのと同じです。

サイン:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

この関数をどこから呼び出せるかを制御するイングレス設定。

サイン:

ingressSettings?: (typeof INGRESS_SETTINGS_OPTIONS)[number] | ResetValue;

RuntimeOptions.invoker

https 関数にアクセス制御を設定する呼び出し元。

サイン:

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

RuntimeOptions.labels

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

サイン:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

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

サイン:

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

RuntimeOptions.memory

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

サイン:

memory?: (typeof VALID_MEMORY_OPTIONS)[number] | Expression<number> | ResetValue;

RuntimeOptions.minInstances

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

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

サイン:

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

RuntimeOptions.preserveExternalChanges

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

Firebase Functions SDK ではまだ利用できない、基盤となるプラットフォームで利用可能な構成を設定する場合は、 preserveExternalChangestrueに設定することを強くお勧めします。 。そうしないと、Firebase Functions SDK が不足している構成をサポートする新しいバージョンの SDK をリリースしたときに、関数の手動で構成された設定が誤って消去される可能性があります。

サイン:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

サイン:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

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

サイン:

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

RuntimeOptions.timeoutSeconds

関数のタイムアウト (秒単位)。可能な値は 0 ~ 540 です。

サイン:

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

RuntimeOptions.vpcConnector

指定した VPC コネクタにクラウド機能を接続します。

サイン:

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

RuntimeOptions.vpcConnectorEgressSettings

VPC コネクタの送信設定。

サイン:

vpcConnectorEgressSettings?: (typeof VPC_EGRESS_SETTINGS_OPTIONS)[number] | ResetValue;