GlobalOptions interface

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

簽名:

export interface GlobalOptions 

特性

財產類型描述
並發編號 |表達式<數字> |重置值函數一次可以處理的請求數。
中央處理器編號 | “gcf_gen1”分配給函數的 CPU 小數。
執行AppCheck布爾值確定是否強制執行 Firebase AppCheck。默認為假。
入口設置入口設置|重置值控制從何處調用此函數的入口設置。
調用者“公共” | “私人” |字符串 |細繩[]對 https 函數設置訪問控制的調用程序。
標籤記錄<字符串,字符串>要在函數上設置的用戶標籤。
最大實例編號 |表達式<數字> |重置值要並行運行的最大實例數。
記憶內存選項|表達式<數字> |重置值分配給函數的內存量。
最小實例編號 |表達式<數字> |重置值在給定時間運行的實際實例的最小數量。
忽略布爾 |表達式<布爾值>如果為真,則不要部署或模擬此功能。
保留外部更改布爾值控制是否保留在函數源之外修改的函數配置。默認為假。
地區支持地區|細繩應部署功能的區域。
秘密(字符串 | SecretParam)[]
服務帳號字符串 |重置值要運行的函數的特定服務帳戶。
超時秒數編號 |表達式<數字> |重置值該函數的超時時間(以秒為單位),可能的值為 0 到 540。HTTPS 函數可以指定更高的超時時間。
vpc連接器字符串 |表達式<字符串> |重置值將雲功能連接到指定的 VPC 連接器。
vpcConnectorEgressSettings VpcEgressSetting |重置值VPC 連接器的出口設置。

GlobalOptions.concurrency

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

只能應用於在 Cloud Functions v2 上運行的函數。 null 值恢復默認並發(當 CPU > = 1, 否則為 1)。如果cpu小於 1,則不能將並發設置為 1 以外的任何值。並發的最大值為 1,000。

簽名:

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

全局選項.cpu

分配給函數的 CPU 小數。

對於帶有 < 的函數默認為 1 = 2GB RAM 並隨著內存的增加而增加。這不同於使用 gcloud 實用程序時的默認值,也不同於第 1 代 Google Cloud Functions 中分配的固定數量。要恢復到 gcloud 或第 1 代 Cloud Functions 中使用的 CPU 數量,請將其設置為值“gcf_gen1”

簽名:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

確定是否強制執行 Firebase AppCheck。默認為假。

為真時,帶有無效令牌的請求會自動響應 401(未授權)錯誤。如果為 false,帶有無效令牌的請求會將 event.app 設置為 undefiend。

簽名:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

控制從何處調用此函數的入口設置。

簽名:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.invoker

對 https 函數設置訪問控制的調用程序。

簽名:

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

全局選項.labels

要在函數上設置的用戶標籤。

簽名:

labels?: Record<string, string>;

GlobalOptions.maxInstances

要並行運行的最大實例數。

簽名:

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

全局選項.memory

分配給函數的內存量。

簽名:

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

GlobalOptions.minInstances

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

實例將按內存分配和閒置時 10% 的 CPU 分配收費。

簽名:

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

全局選項.omit

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

簽名:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

控制是否保留在函數源之外修改的函數配置。默認為假。

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

簽名:

preserveExternalChanges?: boolean;

全局選項.region

應部署功能的區域。

簽名:

region?: SupportedRegion | string;

全局選項.secrets

簽名:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

要運行的函數的特定服務帳戶。

簽名:

serviceAccount?: string | ResetValue;

GlobalOptions.timeoutSeconds

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

第 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;