GlobalOptions interface

GlobalOptions是可以在整個專案中設定的選項。這些選項對於 HTTPS 和事件處理函數是通用的。

簽名:

export interface GlobalOptions 

特性

財產類型描述
並發性數量 |表達<數字> |重置值函數一次可以處理的請求數。
中央處理器數量 | “gcf_gen1”分配給函數的 CPU 分數。
強制應用程式檢查布林值確定是否強制執行 Firebase 應用程式檢查。預設為 false。
入口設置入口設定|重置值控制從何處呼叫此函數的入口設定。
呼叫者「公共」| 「私人」|字串|細繩[]用於設定 HTTPS 功能存取控制的呼叫程式。
標籤記錄<字串,字串>在函數上設定的使用者標籤。
最大實例數數量 |表達<數字> |重置值可以並行運行的最大實例數。
記憶內存選項|表達<數字> |重置值分配給函數的記憶體量。
最小實例數數量 |表達<數字> |重置值在給定時間運行的最小實際實例數。
忽略布爾 |表達<布林值>如果為 true,則不要部署或模擬此功能。
保留外部更改布林值控制是否保留在函數來源外部修改的函數配置。預設為 false。
地區支援地區|字串|表達<字串> |重置值需要部署功能的區域。
秘密(字串 | SecretParam)[]
服務帳戶字串|表達<字串> |重置值執行該函數的特定服務帳戶。
超時秒數數量 |表達<數字> |重置值函數的超時時間(以秒為單位),可能的值為 0 到 540。HTTPS 函數可以指定更高的超時時間。
vpc連接器字串|表達<字串> |重置值將函數連接到指定的 VPC 連接器。
vpcConnectorEgressSettings VpcEgress 設定|重置值VPC 連接器的出口設定。

GlobalOptions.concurrency

函數一次可以處理的請求數。

僅適用於在 Cloud Functions(第二代)上執行的函數。 null 值恢復預設並發性(當 CPU > 時為 80) = 1, 1 否則)。如果cpu小於 1,則並發數不能設定為 1 以外的任何值。並發數的最大值為 1,000。

簽名:

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

全域選項.cpu

分配給函數的 CPU 分數。

對於帶有 < 的函數,預設為 1 = 2GB RAM 並增加更大的記憶體大小。這與使用 gcloud 公用程式時的預設值不同,也與 Cloud Functions(第一代)中指派的固定金額不同。若要恢復為 gcloud 或 Cloud Functions(第一代)中使用的 CPU 數量,請將其設為值“gcf_gen1”

簽名:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

確定是否強制執行 Firebase 應用程式檢查。預設為 false。

如果為 true,則具有無效令牌的請求會自動回應 401(未經授權)錯誤。當 false 時,帶有無效令牌的請求會將event.app設為undefined

簽名:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

控制從何處呼叫此函數的入口設定。

簽名:

ingressSettings?: IngressSetting | ResetValue;

全域選項.invoker

用於設定 HTTPS 功能存取控制的呼叫程式。

簽名:

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

全域選項.labels

在函數上設定的使用者標籤。

簽名:

labels?: Record<string, string>;

全域選項.maxInstances

可以並行運行的最大實例數。

簽名:

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

全域選項.內存

分配給函數的記憶體量。

簽名:

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

全域選項.minInstances

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

實例在空閒時按記憶體分配和 10% 的 CPU 分配計費。

簽名:

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

全域選項.omit

如果為 true,則不要部署或模擬此功能。

簽名:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

控制是否保留在函數來源外部修改的函數配置。預設為 false。

當設定在 Firebase SDK for Cloud Functions 中尚不可用的底層平台中可用的配置時,我們建議將preserveExternalChanges設為true 。否則,當 Google 發布支援缺失配置的新版 SDK 時,您的函數手動配置的設定可能會無意中被清除。

簽名:

preserveExternalChanges?: boolean;

全域選項.region

需要部署功能的區域。

簽名:

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

全域選項.secrets

簽名:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

執行該函數的特定服務帳戶。

簽名:

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

GlobalOptions.timeoutSeconds

函數的超時時間(以秒為單位),可能的值為 0 到 540。HTTPS 函數可以指定更高的超時時間。

第二代函數的最小超時為 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;