https.HttpsOptions interface

可以在 onRequest HTTPS 函數上設定的選項。

簽名:

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

擴充:省略< GlobalOptions ,「區域」>

特性

財產類型描述
並發性數量 |表達<數字> |重置值函數一次可以處理的請求數。
科爾斯字串|布爾 |正規表示式|數組<字串|正規表示式>如果為 true,則允許對此函數的請求使用 CORS。如果這是一個stringRegExp ,則允許來自與提供的值相符的域的請求。如果這是一個Array ,則允許來自與該數組的至少一個匹配的域的請求。對於https.CallableFunction預設為 true,否則預設為 false。
中央處理器數量 | “gcf_gen1”分配給函數的 CPU 分數。
入口設置選項.IngressSetting |重置值控制從何處呼叫此函數的入口設定。
呼叫者「公共」| 「私人」|字串|細繩[]呼叫者設定 https 函數的存取控制。
標籤記錄<字串,字串>在函數上設定的使用者標籤。
最大實例數數量 |表達<數字> |重置值並行運行的最大實例數。
記憶選項.MemoryOption |表達<數字> |重置值分配給函數的記憶體量。
最小實例數數量 |表達<數字> |重置值在給定時間運行的最小實際實例數。
忽略布爾 |表達<布林值>如果為 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。如果這是一個stringRegExp ,允許來自與所提供值相符的網域的請求。如果這是一個Array ,允許來自與數組的至少一個條目匹配的域的請求。對於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?: options.MemoryOption | Expression<number> | ResetValue;

https.HttpsOptions.minInstances

在給定時間運行的最小實際實例數。

實例將根據空閒時的記憶體分配和 10% 的 CPU 分配進行計費。

簽名:

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

https.HttpsOptions.omit

如果為 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;