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。

当设置在适用于 Cloud Functions 的 Firebase SDK 中尚不可用的底层平台中可用的配置时，我们建议将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;