EventTrigger

import type { EventTrigger } from "https://googleapis.deno.dev/v1/cloudfunctions:v2.ts";

Describes EventTrigger, used to request events to be sent from another service.

interface EventTrigger {

channel?: string;

eventFilters?: EventFilter[];

eventType?: string;

pubsubTopic?: string;

retryPolicy?: "RETRY_POLICY_UNSPECIFIED" | "RETRY_POLICY_DO_NOT_RETRY" | "RETRY_POLICY_RETRY";

service?: string;

serviceAccountEmail?: string;

readonly trigger?: string;

triggerRegion?: string;

}

§Properties

channel?: string

[src]

Optional. The name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. You must provide a channel to receive events from Eventarc SaaS partners.

eventFilters?: EventFilter[]

[src]

Criteria used to filter events.

eventType?: string

[src]

Required. The type of event to observe. For example: google.cloud.audit.log.v1.written or google.cloud.pubsub.topic.v1.messagePublished.

pubsubTopic?: string

[src]

Optional. The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery. Format: projects/{project}/topics/{topic}. This is only valid for events of type google.cloud.pubsub.topic.v1.messagePublished. The topic provided here will not be deleted at function deletion.

retryPolicy?: "RETRY_POLICY_UNSPECIFIED" | "RETRY_POLICY_DO_NOT_RETRY" | "RETRY_POLICY_RETRY"

[src]

Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).

service?: string

[src]

Optional. The hostname of the service that 1st Gen function should be observed. If no string is provided, the default service implementing the API will be used. For example, storage.googleapis.com is the default for all event types in the google.storage namespace. The field is only applicable to 1st Gen functions.

serviceAccountEmail?: string

[src]

Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is run.routes.invoke. If empty, defaults to the Compute Engine default service account: {project_number}-compute@developer.gserviceaccount.com.

readonly trigger?: string

[src]

Output only. The resource name of the Eventarc trigger. The format of this field is projects/{project}/locations/{region}/triggers/{trigger}.

triggerRegion?: string

[src]

The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.