https.HttpsOptions interface

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

签名:

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

扩展:省略< GlobalOptions ,“区域”>

特性

财产类型描述
并发性数量 |表达<数字> |重置值函数一次可以处理的请求数。
科尔斯字符串 |布尔 |正则表达式|数组<字符串|正则表达式>如果为 true,则允许对此函数的请求使用 CORS。如果这是一个stringRegExp ,则允许来自与提供的值匹配的域的请求。如果这是一个Array ,则允许来自与该数组的至少一项匹配的域的请求。对于https.CallableFunction默认为 true,否则默认为 false。
中央处理器数量 | “gcf_gen1”分配给函数的 CPU 分数。
入口设置选项.IngressSetting |重置值控制从何处调用此函数的入口设置。
调用者“公共”| “私人”|字符串 |细绳[]调用者设置 https 函数的访问控制。
标签记录<字符串,字符串>在函数上设置的用户标签。
最大实例数数量 |表达<数字> |重置值并行运行的最大实例数。
记忆选项.MemoryOption |表达<数字> |重置值分配给函数的内存量。
最小实例数数量 |表达<数字> |重置值在给定时间运行的最小实际实例数。
忽略布尔 |表达<布尔值>如果为 true,则不要部署或模拟此功能。
地区支持地区|字符串 |数组< SupportedRegion |字符串> |表达<字符串> |重置值HTTP 函数可以覆盖全局选项,并且可以指定要部署到的多个区域。
秘密(字符串 | SecretParam)[]
服务帐户字符串 |表达<字符串> |重置值运行该函数的特定服务帐户。
超时秒数数量 |表达<数字> |重置值函数的超时时间(以秒为单位),可能的值为 0 到 540。HTTPS 函数可以指定更高的超时时间。
vpc连接器字符串 |表达<字符串> |重置值将云功能连接到指定的VPC连接器。
vpcConnectorEgressSettings选项.VpcEgressSetting |重置值VPC 连接器的出口设置。

https.HttpsOptions.concurrency

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

仅适用于在 Cloud Functions v2 上运行的函数。 null 值恢复默认并发性(当 CPU > 时为 80) = 1, 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 分数。

对于带有 < 的函数,默认为 1 = 2GB RAM 并增加更大的内存大小。这与使用 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?: 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 和可调用函数的最大超时为 36,00 秒(1 小时)。任务队列函数的最大超时时间为 1,800 秒(30 分钟)

签名:

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

https.HttpsOptions.vpcConnector

将云功能连接到指定的VPC连接器。

签名:

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

https.HttpsOptions.vpcConnectorEgressSettings

VPC 连接器的出口设置。

签名:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;