https.HttpsOptions interface

可在 onRequest HTTPS 函数上设置的选项。

签名

export interface HttpsOptions extends Omit<GlobalOptions, "region"> 

扩展:Omit<GlobalOptions, "region">

属性

属性 类型 说明
并发 数字 |表达式<数字>|重置值 一个函数一次可以处理的请求数量。
Cors 字符串 |布尔值 |正则表达式 |数组<字符串 |正则表达式> 如果为 true,则允许对针对此函数的请求进行 CORS。如果此值为 stringRegExp,则允许来自与所提供值匹配的网域的请求。如果此值为 Array,则允许来自与数组的至少一个条目匹配的网域的请求。对于 https.CallableFunction,默认值为 true,否则,默认为 false。
CPU 数字 |“gcf_gen1” 要分配给函数的 CPU 数量(小数部分)。
ingressSettings options.IngressSetting |重置值 入站流量设置,用于控制从何处调用此函数。
invoker “public”|“private”|字符串 |字符串 [] 用于设置对 https 函数访问权限控制的调用方。
标签 记录<字符串, 字符串> 要在函数上设置的用户标签。
maxInstances 数字 |表达式<数字>|重置值 要并行运行的实例数上限。
内存 options.MemoryOption |表达式<数字>|重置值 要分配给函数的内存量。
minInstances 数字 |表达式<数字>|重置值 在指定时间运行的最小实际实例数。
省略 布尔值 |表达式<布尔值> 如果为 true,请勿部署或模拟此函数。
区域 SupportedRegion |字符串 |数组<SupportedRegion |字符串>|表达式<string>|重置值 HTTP 函数可以替换全局选项,并且可以指定要部署到的多个区域。
Secret (字符串 | SecretParam)[]
serviceAccount 字符串 |表达式<string>|重置值 运行函数时所用的特定服务账号。
timeoutSeconds 数字 |表达式<数字>|重置值 函数的超时时长(以秒为单位),可能的值为 0 到 540。HTTPS 函数可以指定更长的超时。
vpcConnector 字符串 |表达式<string>|重置值 将 Cloud Functions 函数连接到指定的 VPC 连接器。
vpcConnectoregressSettings options.VpcegressSetting |重置值 VPC 连接器的出站流量设置。

https.HttpsOptions.concurrency

一个函数一次可以处理的请求数量。

只能应用于在 Cloud Functions v2 上运行的函数。值为 null 时恢复默认并发设置(当 CPU >= 1 时,并发为 80,否则为 1)。如果 cpu 小于 1,则不能将并发设置为 1 以外的任何值。最大并发值为 1,000。

签名

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

https.HttpsOptions.cors

如果为 true,则允许对针对此函数的请求进行 CORS。如果这是 stringRegExp,则允许来自与所提供值匹配的网域的请求。如果此值为 Array,则允许来自与数组的至少一个条目匹配的网域的请求。对于 https.CallableFunction,默认值为 true,否则,默认为 false。

签名

cors?: string | boolean | RegExp | Array<string | RegExp>;

https.HttpsOptions.cpu

要分配给函数的 CPU 数量(小数部分)。

对于 RAM 小于 = 2GB 的函数,默认值为 1;对于内存大小更大的函数,默认值为 1。这不同于使用 gcloud 实用程序时的默认值,也不同于 Google Cloud Functions 第 1 代中分配的固定金额。如需还原为 gcloud 或 Cloud Functions 第 1 代中使用的 CPU 数量,请将此值设为“gcf_gen1”

签名

cpu?: number | "gcf_gen1";

https.HttpsOptions.ingressSettings

入站流量设置,用于控制从何处调用此函数。

签名

ingressSettings?: options.IngressSetting | ResetValue;

https.HttpsOptions.invoker

用于设置对 https 函数访问权限控制的调用方。

签名

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

https.HttpsOptions.labels

要在函数上设置的用户标签。

签名

labels?: Record<string, string>;

https.HttpsOptions.maxInstances

要并行运行的实例数上限。

签名

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

https.HttpsOptions.memory

要分配给函数的内存量。

签名

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

https.HttpsOptions.minInstances

在指定时间运行的最小实际实例数。

实例在空闲时将为内存分配和 10% 的 CPU 分配付费。

签名

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

https.HttpsOptions.omit

如果为 true,请勿部署或模拟此函数。

签名

omit?: boolean | Expression<boolean>;

https.HttpsOptions.region

HTTP 函数可以替换全局选项,并且可以指定要部署到的多个区域。

签名

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

https.HttpsOptions.secrets

签名

secrets?: (string | SecretParam)[];

https.HttpsOptions.serviceAccount

运行函数时所用的特定服务账号。

签名

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

https.HttpsOptions.timeoutSeconds

函数的超时时长(以秒为单位),可能的值为 0 到 540。HTTPS 函数可以指定更长的超时。

第 2 代函数的最短超时时间为 1 秒。函数的最长超时时间取决于函数的类型:事件处理函数的最长超时时间为 540 秒(9 分钟)。HTTPS 和 Callable 函数的最大超时时间为 36,00 秒(1 小时)。任务队列函数的超时时长上限为 1800 秒(30 分钟)

签名

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

https.HttpsOptions.vpcConnector 中的链接

将 Cloud Functions 函数连接到指定的 VPC 连接器。

签名

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

https.HttpsOptions.vpcConnectoregressSettings

VPC 连接器的出站流量设置。

签名

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;