REST Resource: projects.locations.triggers

Resource: Trigger

A representation of the trigger resource.

JSON representation
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "eventFilters": [
    {
      object (EventFilter)
    }
  ],
  "serviceAccount": string,
  "destination": {
    object (Destination)
  },
  "transport": {
    object (Transport)
  },
  "etag": string
}
Fields
name

string

Required. The resource name of the trigger. Must be unique within the location on the project and must be in projects/{project}/locations/{location}/triggers/{trigger} format.

uid

string

Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

createTime

string (Timestamp format)

Output only. The creation time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The last-modified time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

eventFilters[]

object (EventFilter)

Required. The list of filters that applies to event attributes. Only events that match all the provided filters will be sent to the destination.

serviceAccount

string

Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger.

The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information.

For Cloud Run destinations, this service account is used to generate identity tokens when invoking the service. See https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account for information on how to invoke authenticated Cloud Run services. In order to create Audit Log triggers, the service account should also have 'eventarc.events.receiveAuditLogV1Written' permission.

destination

object (Destination)

Required. Destination specifies where the events should be sent to.

transport

object (Transport)

Optional. In order to deliver messages, Eventarc may use other GCP products as transport intermediary. This field contains a reference to that transport intermediary. This information can be used for debugging purposes.

etag

string

Output only. This checksum is computed by the server based on the value of other fields, and may be sent only on create requests to ensure the client has an up-to-date value before proceeding.

EventFilter

Filters events based on exact matches on the CloudEvents attributes.

JSON representation
{
  "attribute": string,
  "value": string
}
Fields
attribute

string

Required. The name of a CloudEvents attribute. Currently, only a subset of attributes are supported for filtering.

All triggers MUST provide a filter for the 'type' attribute.

value

string

Required. The value for the attribute.

Destination

Represents a target of an invocation over HTTP.

JSON representation
{
  "cloudRun": {
    object (CloudRun)
  }
}
Fields
cloudRun

object (CloudRun)

Cloud Run fully-managed service that receives the events. The service should be running in the same project of the trigger.

CloudRun

Represents a Cloud Run destination.

JSON representation
{
  "service": string,
  "path": string,
  "region": string
}
Fields
service

string

Required. The name of the Cloud run service being addressed (see https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services).

Only services located in the same project of the trigger object can be addressed.

path

string

Optional. The relative path on the Cloud Run service the events should be sent to.

The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: "/route", "route", "route/subroute".

region

string

Required. The region the Cloud Run service is deployed in.

Transport

Represents the transport intermediaries created for the trigger in order to deliver events.

JSON representation
{
  "pubsub": {
    object (Pubsub)
  }
}
Fields
pubsub

object (Pubsub)

The Pub/Sub topic and subscription used by Eventarc as delivery intermediary.

Pubsub

Represents a Pub/Sub transport.

JSON representation
{
  "topic": string,
  "subscription": string
}
Fields
topic

string

Optional. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{PROJECT_ID}/topics/{TOPIC_NAME}.

You may set an existing topic for triggers of the type google.cloud.pubsub.topic.v1.messagePublished only. The topic you provide here will not be deleted by Eventarc at trigger deletion.

subscription

string

Output only. The name of the Pub/Sub subscription created and managed by Eventarc system as a transport for the event delivery. Format: projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_NAME}.

Methods

create

Create a new trigger in a particular project and location.

delete

Delete a single trigger.

get

Get a single trigger.

getIamPolicy

Gets the access control policy for a resource.

list

List triggers.

patch

Update a single trigger.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.