GlobalOptions
是可在整个项目中设置的选项。这些选项是 HTTPS 和事件处理函数通用的选项。
签名:
export interface GlobalOptions
属性
属性 | 类型 | 说明 |
---|---|---|
并发 | 数字 |表达式<数字>|重置值 | 一个函数一次可以处理的请求数量。 |
CPU | 数字 |“gcf_gen1” | 要分配给函数的 CPU 数量(小数部分)。 |
enforceAppCheck | 布尔值 | 确定是否强制执行 Firebase App Check。默认值为 false。 |
ingressSettings | IngressSetting |重置值 | 入站流量设置,用于控制从何处调用此函数。 |
invoker | “public”|“private”|字符串 |字符串 [] | 用于设置对 HTTPS 函数的访问权限控制的调用器。 |
标签 | 记录<字符串, 字符串> | 要在函数上设置的用户标签。 |
maxInstances | 数字 |表达式<数字>|重置值 | 可并行运行的实例数上限。 |
内存 | MemoryOption |表达式<数字>|重置值 | 要分配给函数的内存量。 |
minInstances | 数字 |表达式<数字>|重置值 | 在指定时间运行的最小实际实例数。 |
省略 | 布尔值 |表达式<布尔值> | 如果为 true,请勿部署或模拟此函数。 |
preserveExternalChanges | 布尔值 | 控制是否保留在函数源之外修改的函数配置。默认值为 false。 |
区域 | SupportedRegion |字符串 |表达式<string>|重置值 | 应部署函数的区域。 |
Secret | (字符串 | SecretParam)[] | |
serviceAccount | 字符串 |表达式<string>|重置值 | 运行函数时所用的特定服务账号。 |
timeoutSeconds | 数字 |表达式<数字>|重置值 | 函数的超时时长(以秒为单位),可能的值为 0 到 540。HTTPS 函数可以指定更长的超时。 |
vpcConnector | 字符串 |表达式<string>|重置值 | 将函数连接到指定的 VPC 连接器。 |
vpcConnectoregressSettings | VpcegressSetting |重置值 | VPC 连接器的出站流量设置。 |
GlobalOptions.concurrency
一个函数一次可以处理的请求数量。
只能应用于在 Cloud Functions (第 2 代) 上运行的函数。值为 null 时恢复默认并发设置(当 CPU >= 1 时,并发为 80,否则为 1)。如果 cpu
小于 1,则不能将并发设置为 1 以外的任何值。最大并发值为 1,000。
签名:
concurrency?: number | Expression<number> | ResetValue;
GlobalOptions.cpu
要分配给函数的 CPU 数量(小数部分)。
对于 RAM 小于 = 2GB 的函数,默认值为 1;对于内存大小更大的函数,默认值为 1。这不同于使用 gcloud 实用程序时的默认值,也不同于 Cloud Functions (第 1 代) 中分配的固定金额。如需还原为 gcloud 或 Cloud Functions(第 1 代)中使用的 CPU 数量,请将此值设为“gcf_gen1”
签名:
cpu?: number | "gcf_gen1";
GlobalOptions.enforceAppCheck
确定是否强制执行 Firebase App Check。默认值为 false。
如果为 true,包含无效令牌的请求会自动响应 401(未授权)错误。如果为 false,包含无效令牌的请求会将 event.app
设置为 undefined
。
签名:
enforceAppCheck?: boolean;
GlobalOptions.ingressSettings
入站流量设置,用于控制从何处调用此函数。
签名:
ingressSettings?: IngressSetting | ResetValue;
GlobalOptions.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
在指定时间运行的最小实际实例数。
实例在空闲时按内存分配以及 CPU 分配的 10% 计费。
签名:
minInstances?: number | Expression<number> | ResetValue;
GlobalOptions.omit
如果为 true,请勿部署或模拟此函数。
签名:
omit?: boolean | Expression<boolean>;
GlobalOptions.preserveExternalChanges
控制是否保留在函数源之外修改的函数配置。默认值为 false。
如果要在 Firebase SDK for Cloud Functions 中尚未提供的底层平台中设置可用配置,我们建议将 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 和 Callable 函数的最大超时时间为 36,00 秒(1 小时)。任务队列函数的超时时长上限为 1800 秒(30 分钟)。
签名:
timeoutSeconds?: number | Expression<number> | ResetValue;
GlobalOptions.vpcConnector
将函数连接到指定的 VPC 连接器。
签名:
vpcConnector?: string | Expression<string> | ResetValue;
GlobalOptions.vpcConnectoregressSettings
VPC 连接器的出站流量设置。
签名:
vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;