Index
Eventarc
(interface)CloudRun
(message)CreateTriggerRequest
(message)DeleteTriggerRequest
(message)Destination
(message)EventFilter
(message)GKE
(message)GetTriggerRequest
(message)ListTriggersRequest
(message)ListTriggersResponse
(message)OperationMetadata
(message)Pubsub
(message)Transport
(message)Trigger
(message)UpdateTriggerRequest
(message)
Eventarc
Eventarc allows users to subscribe to various events that are provided by Google Cloud services and forward them to supported destinations.
CreateTrigger | |
---|---|
Create a new trigger in a particular project and location.
|
DeleteTrigger | |
---|---|
Delete a single trigger.
|
GetTrigger | |
---|---|
Get a single trigger.
|
ListTriggers | |
---|---|
List triggers.
|
UpdateTrigger | |
---|---|
Update a single trigger.
|
CloudRun
Represents a Cloud Run destination.
Fields | |
---|---|
service |
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 |
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 |
Required. The region the Cloud Run service is deployed in. |
CreateTriggerRequest
The request message for the CreateTrigger method.
Fields | |
---|---|
parent |
Required. The parent collection in which to add this trigger. Authorization requires the following IAM permission on the specified resource
|
trigger |
Required. The trigger to create. |
trigger_id |
Required. The user-provided ID to be assigned to the trigger. |
validate_only |
Required. If set, validate the request and preview the review, but do not post it. |
DeleteTriggerRequest
The request message for the DeleteTrigger method.
Fields | |
---|---|
name |
Required. The name of the trigger to be deleted. Authorization requires the following IAM permission on the specified resource
|
etag |
If provided, the trigger will only be deleted if the etag matches the current etag on the resource. |
allow_missing |
If set to true, and the trigger is not found, the request will succeed but no action will be taken on the server. |
validate_only |
Required. If set, validate the request and preview the review, but do not post it. |
Destination
Represents a target of an invocation over HTTP.
Fields | ||
---|---|---|
Union field
|
||
cloud_run |
Cloud Run fully-managed resource that receives the events. The resource should be in the same project as the trigger. |
|
gke |
A GKE service capable of receiving events. The service should be running in the same project as the trigger. |
EventFilter
Filters events based on exact matches on the CloudEvents attributes.
Fields | |
---|---|
attribute |
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 |
Required. The value for the attribute. |
GKE
Represents a GKE destination.
Fields | |
---|---|
cluster |
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 |
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 |
Required. The namespace the GKE service is running in. |
service |
Required. Name of the GKE service. |
path |
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". |
GetTriggerRequest
The request message for the GetTrigger method.
Fields | |
---|---|
name |
Required. The name of the trigger to get. Authorization requires the following IAM permission on the specified resource
|
ListTriggersRequest
The request message for the ListTriggers method.
Fields | |
---|---|
parent |
Required. The parent collection to list triggers on. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of triggers to return on each page. Note: The service may send fewer. |
page_token |
The page token; provide the value from the When paginating, all other parameters provided to |
order_by |
The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a |
ListTriggersResponse
The response message for the ListTriggers
method.
Fields | |
---|---|
triggers[] |
The requested triggers, up to the number specified in |
next_page_token |
A page token that can be sent to ListTriggers to request the next page. If this is empty, then there are no more pages. |
unreachable[] |
Unreachable resources, if any. |
OperationMetadata
Represents the metadata of the long-running operation.
Fields | |
---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
target |
Output only. Server-defined resource path for the target of the operation. |
verb |
Output only. Name of the verb executed by the operation. |
status_message |
Output only. Human-readable status of the operation, if any. |
requested_cancellation |
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a |
api_version |
Output only. API version used to start the operation. |
Pubsub
Represents a Pub/Sub transport.
Fields | |
---|---|
topic |
Optional. The name of the Pub/Sub topic created and managed by Eventarc as a transport for the event delivery. Format: You can set an existing topic for triggers of the type |
subscription |
Output only. The name of the Pub/Sub subscription created and managed by Eventarc as a transport for the event delivery. Format: |
Transport
Represents the transport intermediaries created for the trigger to deliver events.
Fields | |
---|---|
pubsub |
The Pub/Sub topic and subscription used by Eventarc as a transport intermediary. |
Trigger
A representation of the trigger resource.
Fields | |
---|---|
name |
Required. The resource name of the trigger. Must be unique within the location of the project and must be in |
uid |
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. |
create_time |
Output only. The creation time. |
update_time |
Output only. The last-modified time. |
event_filters[] |
Required. The list of filters that applies to event attributes. Only events that match all the provided filters are sent to the destination. |
service_account |
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 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 |
destination |
Required. Destination specifies where the events should be sent to. |
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 |
Optional. User labels attached to the triggers that can be used to group resources. |
etag |
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. |
UpdateTriggerRequest
The request message for the UpdateTrigger method.
Fields | |
---|---|
trigger |
The trigger to be updated. Authorization requires the following IAM permission on the specified resource
|
update_mask |
The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*". |
allow_missing |
If set to true, and the trigger is not found, a new trigger will be created. In this situation, |
validate_only |
Required. If set, validate the request and preview the review, but do not post it. |