https.HttpsOptions interface

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

签名:

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

扩展:省略 < GlobalOptions

特性

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

https.HttpsOptions.concurrency

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

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

签名:

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

https.HttpsOptions.cors

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

签名:

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

https.HttpsOptions.cpu

分配给函数的 CPU 小数。

对于带有 < 的函数默认为 1 = 2GB RAM 并随着内存的增加而增加。这不同于使用 gcloud 实用程序时的默认值,也不同于第 1 代 Google Cloud Functions 中分配的固定数量。要恢复到 gcloud 或第 1 代 Cloud Functions 中使用的 CPU 数量,请将其设置为值“gcf_gen1”

签名:

cpu?: number | "gcf_gen1";

https.HttpsOptions.ingressSettings

控制从何处调用此函数的入口设置。

签名:

ingressSettings?: options.IngressSetting | ResetValue;

https.HttpsOptions.调用者

对 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

如果为真,则不要部署或模拟此功能。

签名:

omit?: boolean | Expression<boolean>;

https.HttpsOptions.region

HTTP 函数可以覆盖全局选项并可以指定要部署到的多个区域。

签名:

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

https.HttpsOptions.secrets

签名:

secrets?: (string | SecretParam)[];

https.HttpsOptions.serviceAccount

要运行的函数的特定服务帐户。

签名:

serviceAccount?: 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;