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)
  },
  "labels": {
    string: string,
    ...
  },
  "etag": string
}
Fields
name

string

Required. The resource name of the trigger. Must be unique within the location of 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 are 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 the 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. To create Audit Log triggers, the service account should also have the roles/eventarc.eventReceiver IAM role.

destination

object (Destination)

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

transport

object (Transport)

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

labels

map (key: string, value: string)

Optional. User labels attached to the triggers that can be used to group resources.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

etag

string

Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that 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
{

  // Union field descriptor can be only one of the following:
  "cloudRun": {
    object (CloudRun)
  },
  "gke": {
    object (GKE)
  }
  // End of list of possible types for union field descriptor.
}
Fields

Union field descriptor.

descriptor can be only one of the following:

cloudRun

object (CloudRun)

Cloud Run fully-managed resource that receives the events. The resource should be in the same project as the trigger.

gke

object (GKE)

A GKE service capable of receiving events. The service should be running in the same project as 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 as 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 a 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.

GKE

Represents a GKE destination.

JSON representation
{
  "cluster": string,
  "location": string,
  "namespace": string,
  "service": string,
  "path": string
}
Fields
cluster

string

Required. The name of the cluster the GKE service is running in. The cluster must be running in the same project as the trigger being created.

location

string

Required. The name of the Google Compute Engine in which the cluster resides, which can either be compute zone (for example, us-central1-a) for the zonal clusters or region (for example, us-central1) for regional clusters.

namespace

string

Required. The namespace the GKE service is running in.

service

string

Required. Name of the GKE service.

path

string

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

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

Transport

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

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

object (Pubsub)

The Pub/Sub topic and subscription used by Eventarc as a transport 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 as a transport for the event delivery. Format: projects/{PROJECT_ID}/topics/{TOPIC_NAME}.

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

subscription

string

Output only. The name of the Pub/Sub subscription created and managed by Eventarc 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.