eventarc.EventarcTriggerOptions interface

可在 Eventarc 触发器上设置的选项。

签名：

export interface EventarcTriggerOptions extends options.EventHandlerOptions

扩展： options.EventHandlerOptions

属性

属性 类型 说明
channel 字符串 渠道的 ID。可以是：* 完全限定渠道资源名称：projects/{project}/locations/{location}/channels/{channel-id} * 包含位置和渠道 ID 的部分资源名称，在这种情况下将使用函数的运行时项目 ID：locations/{location}/channels/{channel-id} * 部分渠道 ID，在这种情况下，将使用函数的运行时项目 ID 和 us-central1 作为位置：{channel-id}如果未指定，系统将使用默认的 Firebase 渠道：projects/{project}/locations/us-central1/channels/firebase
并发 数字 |表达式<数字>|重置值 一个函数一次可以处理的请求数量。
CPU 数字 |“gcf_gen1” 要分配给函数的 CPU 数量（小数部分）。
eventType 字符串 要触发的事件类型。
过滤条件 记录<字符串, 字符串> Eventarc 事件完全匹配过滤条件。
ingressSettings options.IngressSetting |重置值 入站流量设置，用于控制从何处调用此函数。
标签 记录<字符串, 字符串> 要在函数上设置的用户标签。
maxInstances 数字 |表达式<数字>|重置值 要并行运行的实例数上限。
内存 options.MemoryOption |表达式<数字>|重置值 要分配给函数的内存量。
minInstances 数字 |表达式<数字>|重置值 在指定时间运行的最小实际实例数。
省略 布尔值 |表达式<布尔值> 如果为 true，请勿部署或模拟此函数。
区域 options.SupportedRegion |字符串 |表达式<string>|重置值 应部署函数的区域。
重试 布尔值 |表达式<布尔值>|重置值 是否应再次传送失败的执行作业。
Secret （字符串 | SecretParam）[]
serviceAccount 字符串 |表达式<string>|重置值 运行函数时所用的特定服务账号。
timeoutSeconds 数字 |表达式<数字>|重置值 函数的超时时长（以秒为单位），可能的值为 0 到 540。HTTPS 函数可以指定更长的超时。
vpcConnector 字符串 |表达式<string>|重置值 将 Cloud Functions 函数连接到指定的 VPC 连接器。
vpcConnectoregressSettings options.VpcegressSetting |重置值 VPC 连接器的出站流量设置。

eventarc.EventarcTriggerOptions.channel

渠道的 ID。可以是以下任何一项：* 完全限定渠道资源名称：projects/{project}/locations/{location}/channels/{channel-id} * 包含位置和渠道 ID 的部分资源名称，在这种情况下将使用函数的运行时项目 ID：locations/{location}/channels/{channel-id} * 部分渠道 ID，在这种情况下将使用函数的运行时项目 ID，并将 us-central1 作为位置：{channel-id}

如果未指定，将使用默认的 Firebase 渠道：projects/{project}/locations/us-central1/channels/firebase

签名：

channel?: string;

eventarc.EventarcTriggerOptions.concurrency

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

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

签名：

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

eventarc.EventarcTriggerOptions.cpu

要分配给函数的 CPU 数量（小数部分）。

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

签名：

cpu?: number | "gcf_gen1";

eventarc.EventarcTriggerOptions.eventType

要触发的事件类型。

签名：

eventType: string;

eventarc.EventarcTriggerOptions.filters

Eventarc 事件完全匹配过滤条件。

签名：

filters?: Record<string, string>;

eventarc.EventarcTriggerOptions.ingressSettings

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

签名：

ingressSettings?: options.IngressSetting | ResetValue;

eventarc.EventarcTriggerOptions.labels

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

签名：

labels?: Record<string, string>;

eventarc.EventarcTriggerOptions.maxInstances

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

签名：

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

eventarc.EventarcTriggerOptions.memory

要分配给函数的内存量。

签名：

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

eventarc.EventarcTriggerOptions.minInstances

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

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

签名：

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

eventarc.EventarcTriggerOptions.omit

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

签名：

omit?: boolean | Expression<boolean>;

eventarc.EventarcTriggerOptions.region

应部署函数的区域。

签名：

region?: options.SupportedRegion | string | Expression<string> | ResetValue;

eventarc.EventarcTriggerOptions.retry

是否应再次传送失败的执行作业。

签名：

retry?: boolean | Expression<boolean> | ResetValue;

eventarc.EventarcTriggerOptions.secrets

签名：

secrets?: (string | SecretParam)[];

eventarc.EventarcTriggerOptions.serviceAccount

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

签名：

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

eventarc.EventarcTriggerOptions.timeoutSeconds

函数的超时时长（以秒为单位），可能的值为 0 到 540。HTTPS 函数可以指定更长的超时。

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

签名：

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

eventarc.EventarcTriggerOptions.vpcConnector

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

签名：

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

eventarc.EventarcTriggerOptions.vpcConnectoregressSettings

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

签名：

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;