GlobalOptions interface

GlobalOptions 是可在整個專案中設定的選項。這些選項在 HTTPS 和事件處理函式中很常見。

簽名:

export interface GlobalOptions 

屬性

屬性 類型 說明
並行 數字 |運算式<數字>|重設值 函式可同時提供的要求數量。
CPU 數字 |「gcf_gen1」 要分配給函式的 CPU 數量 (以比例為單位)。
enforceAppCheck 布林值 決定是否要強制執行 Firebase App Check。預設值為 false。
ingressSettings IngressSettings |重設值 輸入設定,控管可以從何處呼叫這個函式。
叫用者 「公開」|「私人」|字串 |字串 [] 叫用來設定 HTTPS 函式的存取權控管。
標籤 錄音<字串, 字串> 要在函式上設定的使用者標籤。
maxInstances 數字 |運算式<數字>|重設值 可以同時執行的執行個體數量上限。
記憶體 MemoryOption |運算式<數字>|重設值 要分配給函式的記憶體量。
minInstances 數字 |運算式<數字>|重設值 在指定時間運作的實際執行個體數量下限。
省略 布林值 |運算式<boolean> 若為 true,請勿部署或模擬此函式。
preserveExternalChanges 布林值 控管是否要保留在函式來源以外修改的函式設定。預設值為 false。
region [區域] 支援的區域 |字串 |運算式<字串>|重設值 應部署函式的區域。
秘密 (字串 | SecretParam)[]
serviceAccount 字串 |運算式<字串>|重設值 要做為函式執行的特定服務帳戶。
逾時秒數 數字 |運算式<數字>|重設值 函式的逾時時間 (以秒為單位),可能的值為 0 到 540。HTTPS 函式可以指定較長的逾時時間。
vpcConnector 字串 |運算式<字串>|重設值 將函式連線至指定的虛擬私有雲連接器。
vpcConnectoregressSettings VpcegressSetting |重設值 虛擬私有雲連接器的輸出設定。

GlobalOptions.concurrency

函式可同時提供的要求數量。

只能套用至在 Cloud Functions (第 2 代) 上執行的函式。值為空值會還原預設並行 (CPU >= 1 時為 80,否則為 1)。如果 cpu 小於 1,並行就無法設為 1 以外的任何值。並行的最大值為 1,000。

簽名:

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

全域選項.cpu

要分配給函式的 CPU 數量 (以比例為單位)。

如果函式中的 RAM = 2 GB,預設值為 1;記憶體容量越大,則會增加。這與使用 gcloud 公用程式時的預設值不同,與 Cloud Functions (第 1 代) 中指派的固定金額不同。如要還原為 gcloud 或 Cloud Functions (第 1 代) 中使用的 CPU 數量,請將這個值設為「gcf_gen1」

簽名:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

決定是否要強制執行 Firebase App Check。預設值為 false。

如果設為 true,包含無效權杖的要求將自動回應,並顯示 401 (Unauthorized) 錯誤。如果設為 False,含有無效權杖的要求會將 event.app 設為 undefined

簽名:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

輸入設定,控管可以從何處呼叫這個函式。

簽名:

ingressSettings?: IngressSetting | ResetValue;

全域選項.invoker

叫用來設定 HTTPS 函式的存取權控管。

簽名:

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

GlobalOptions.labels

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

簽名:

labels?: Record<string, string>;

GlobalOptions.maxInstances

可以同時執行的執行個體數量上限。

簽名:

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

GlobalOptions.memory

要分配給函式的記憶體量。

簽名:

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

GlobalOptions.minInstances

在指定時間運作的實際執行個體數量下限。

執行個體為閒置記憶體配置和 10% 的 CPU 分配量計費。

簽名:

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

GlobalOptions.omit

若為 true,請勿部署或模擬此函式。

簽名:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

控管是否要保留在函式來源以外修改的函式設定。預設值為 false。

如果基礎平台尚未在 Cloud Functions 提供的 Firebase SDK 中提供相關設定,建議您將 preserveExternalChanges 設為 true。否則,當 Google 發布新版 SDK,並支援缺少的設定時,可能會無意間清除函式的手動設定設定。

簽名:

preserveExternalChanges?: boolean;

GlobalOptions.region

應部署函式的區域。

簽名:

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

GlobalOptions.secrets

簽名:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

要做為函式執行的特定服務帳戶。

簽名:

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

GlobalOptions.timeoutSeconds

函式的逾時時間 (以秒為單位),可能的值為 0 到 540。HTTPS 函式可以指定較長的逾時時間。

第 2 代函式的逾時時間下限為 1 秒。函式的逾時時間上限取決於函式類型:事件處理函式的逾時時間上限為 540 秒 (9 分鐘),HTTPS 和可呼叫函式的逾時時間上限為 36,00 秒 (1 小時)。工作佇列函式的逾時時間上限為 1,800 秒 (30 分鐘),

簽名:

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

全域選項.vpcConnector

將函式連線至指定的虛擬私有雲連接器。

簽名:

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

GlobalOptions.vpcConnectoregressSettings

虛擬私有雲連接器的輸出設定。

簽名:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;