https.HttpsOptions interface

onRequest HTTPS 関数で設定できるオプション。

サイン:

export interface HttpsOptions extends Omit<GlobalOptions, "region"> 

拡張:省略< GlobalOptions 、「地域」>

プロパティ

財産タイプ説明
同時実行性番号 |表現<数値> |リセット値関数が一度に処理できるリクエストの数。
コルス文字列 |ブール値 |正規表現 |配列<文字列 |正規表現> true の場合、この関数へのリクエストで CORS が許可されます。これがstringまたはRegExpの場合、指定された値に一致するドメインからのリクエストが許可されます。これがArrayの場合、配列の少なくとも 1 つのエントリに一致するドメインからのリクエストを許可します。 https.CallableFunctionのデフォルトは true、それ以外の場合は false。
CPU番号 | 「gcf_gen1」関数に割り当てる CPU の小数。
イングレス設定オプション.IngressSetting |リセット値この関数をどこから呼び出せるかを制御するイングレス設定。
呼び出し者"パブリック" | "プライベート" |文字列 |弦[] https 関数にアクセス制御を設定する呼び出し元。
ラベルレコード<文字列、文字列>関数に設定するユーザーラベル。
最大インスタンス数番号 |表現<数値> |リセット値並行して実行するインスタンスの最大数。
メモリオプション.メモリオプション|表現<数値> |リセット値関数に割り当てるメモリの量。
最小インスタンス数番号 |表現<数値> |リセット値特定の時間に実行される実際のインスタンスの最小数。
省略ブール値 |表現<ブール値> true の場合、この関数をデプロイまたはエミュレートしません。
地域サポートされている地域|文字列 |配列< SupportedRegion |文字列> |表現<文字列> |リセット値HTTP 関数はグローバル オプションをオーバーライドでき、デプロイ先の複数のリージョンを指定できます。
秘密(文字列 | SecretParam)[]
サービスアカウント文字列 |表現<文字列> |リセット値関数を実行するための特定のサービス アカウント。
タイムアウト秒番号 |表現<数値> |リセット値関数のタイムアウト (秒単位)。可能な値は 0 ~ 540 です。HTTPS 関数では、より長いタイムアウトを指定できます。
vpcコネクタ文字列 |表現<文字列> |リセット値指定した VPC コネクタにクラウド機能を接続します。
vpcConnectorEgressSettingsオプション.VpcEgressSetting |リセット値VPC コネクタの下り設定。

https.HttpsOptions.concurrency

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

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

サイン:

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

https.HttpsOptions.cors

true の場合、この関数へのリクエストで CORS が許可されます。これがstringまたはRegExpの場合、指定された値と一致するドメインからのリクエストを許可します。これがArrayの場合、配列の少なくとも 1 つのエントリに一致するドメインからのリクエストを許可します。 https.CallableFunctionのデフォルトは true、それ以外の場合は false。

サイン:

cors?: string | boolean | RegExp | Array<string | RegExp>;

https.HttpsOptions.cpu

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

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

サイン:

cpu?: number | "gcf_gen1";

https.HttpsOptions.ingressSettings

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

サイン:

ingressSettings?: options.IngressSetting | ResetValue;

https.HttpsOptions.invoker

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

サイン:

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

https.HttpsOptions.labels

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

サイン:

labels?: Record<string, string>;

https.HttpsOptions.maxInstances

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

サイン:

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

https.HttpsOptions.memory

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

サイン:

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

https.HttpsOptions.minInstances

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

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

サイン:

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

https.HttpsOptions.省略

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

サイン:

omit?: boolean | Expression<boolean>;

https.HttpsOptions.region

HTTP 関数はグローバル オプションをオーバーライドでき、デプロイ先の複数のリージョンを指定できます。

サイン:

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

https.HttpsOptions.secrets

サイン:

secrets?: (string | SecretParam)[];

https.HttpsOptions.serviceAccount

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

サイン:

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

https.HttpsOptions.timeoutSeconds

関数のタイムアウト (秒単位)。可能な値は 0 ~ 540 です。HTTPS 関数では、より長いタイムアウトを指定できます。

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

サイン:

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

https.HttpsOptions.vpcConnector

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

サイン:

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

https.HttpsOptions.vpcConnectorEgressSettings

VPC コネクタの下り設定。

サイン:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;