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,
    ...
  },
  "channel": string,
  "conditions": {
    string: {
      object (StateCondition)
    },
    ...
  },
  "eventDataContentType": 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. Unordered list. 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 iam.serviceAccounts.actAs permission must be granted on the service account to allow a principal to impersonate the service account. For more information, see the Roles and permissions page specific to the trigger destination.
destination

object (Destination)

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

object (Transport)

Optional. To deliver messages, Eventarc might use other Google Cloud 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" }.
channel

string

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.
conditions

map (key: string, value: object (StateCondition))

Output only. The reason(s) why a trigger is in FAILED state.

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

string

Optional. EventDataContentType specifies the type of payload in MIME format that is expected from the CloudEvent data field. This is set to application/json if the value is not defined.
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,
  "operator": string
}
Fields
attribute

string

Required. The name of a CloudEvents attribute. Currently, only a subset of attributes are supported for filtering. You can retrieve a specific provider's supported event types.

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

string

Required. The value for the attribute.
operator

string

Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is match-path-pattern.

Destination

Represents a target of an invocation over HTTP.

JSON representation 
{

  // Union field descriptor can be only one of the following:
  "cloudRun": {
    object (CloudRun)
  },
  "cloudFunction": string,
  "gke": {
    object (GKE)
  },
  "workflow": string
  // 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.
cloudFunction

string

The Cloud Function resource name. Only Cloud Functions V2 is supported. Format: projects/{project}/locations/{location}/functions/{function}

This is a read-only field. Creating Cloud Functions V2 triggers is only supported via the Cloud Functions product. An error will be returned if the user sets this value.
gke

object (GKE)

A GKE service capable of receiving events. The service should be running in the same project as the trigger.
workflow

string

The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the trigger. Format: projects/{project}/locations/{location}/workflows/{workflow}

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 
{

  // Union field intermediary can be only one of the following:
  "pubsub": {
    object (Pubsub)
  }
  // End of list of possible types for union field intermediary.
}
Fields

Union field intermediary.

intermediary can be only one of the following:
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.