Package google.cloud.eventarc.v1

Stay organized with collections Save and categorize content based on your preferences.

Index

Eventarc

Eventarc allows users to subscribe to various events that are provided by Google Cloud services and forward them to supported destinations.

CreateTrigger

rpc CreateTrigger(CreateTriggerRequest) returns (Operation)

Create a new trigger in a particular project and location.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteTrigger

rpc DeleteTrigger(DeleteTriggerRequest) returns (Operation)

Delete a single trigger.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetTrigger

rpc GetTrigger(GetTriggerRequest) returns (Trigger)

Get a single trigger.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListTriggers

rpc ListTriggers(ListTriggersRequest) returns (ListTriggersResponse)

List triggers.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateTrigger

rpc UpdateTrigger(UpdateTriggerRequest) returns (Operation)

Update a single trigger.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CloudRun

Represents a Cloud Run destination.

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.

CreateTriggerRequest

The request message for the CreateTrigger method.

Fields
parent

string

Required. The parent collection in which to add this trigger.

Authorization requires the following IAM permission on the specified resource parent:

  • eventarc.triggers.create
trigger

Trigger

Required. The trigger to create.

trigger_id

string

Required. The user-provided ID to be assigned to the trigger.

validate_only

bool

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

string

Required. The name of the trigger to be deleted.

Authorization requires the following IAM permission on the specified resource name:

  • eventarc.triggers.delete
etag

string

If provided, the trigger will only be deleted if the etag matches the current etag on the resource.

allow_missing

bool

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

bool

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

descriptor can be only one of the following:

cloud_run

CloudRun

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

gke

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

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.

GKE

Represents a GKE destination.

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

GetTriggerRequest

The request message for the GetTrigger method.

Fields
name

string

Required. The name of the trigger to get.

Authorization requires the following IAM permission on the specified resource name:

  • eventarc.triggers.get

ListTriggersRequest

The request message for the ListTriggers method.

Fields
parent

string

Required. The parent collection to list triggers on.

Authorization requires the following IAM permission on the specified resource parent:

  • eventarc.triggers.list
page_size

int32

The maximum number of triggers to return on each page. Note: The service may send fewer.

page_token

string

The page token; provide the value from the next_page_token field in a previous ListTriggers call to retrieve the subsequent page.

When paginating, all other parameters provided to ListTriggers must match the call that provided the page token.

order_by

string

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 desc suffix; for example: name desc, trigger_id.

ListTriggersResponse

The response message for the ListTriggers method.

Fields
triggers[]

Trigger

The requested triggers, up to the number specified in page_size.

next_page_token

string

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[]

string

Unreachable resources, if any.

OperationMetadata

Represents the metadata of the long-running operation.

Fields
create_time

Timestamp

Output only. The time the operation was created.

end_time

Timestamp

Output only. The time the operation finished running.

target

string

Output only. Server-defined resource path for the target of the operation.

verb

string

Output only. Name of the verb executed by the operation.

status_message

string

Output only. Human-readable status of the operation, if any.

requested_cancellation

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

api_version

string

Output only. API version used to start the operation.

Pubsub

Represents a Pub/Sub transport.

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

Transport

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

Fields
pubsub

Pubsub

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

Trigger

A representation of the trigger resource.

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.

create_time

Timestamp

Output only. The creation time.

update_time

Timestamp

Output only. The last-modified time.

event_filters[]

EventFilter

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

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

Destination

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

transport

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<string, string>

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

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.

UpdateTriggerRequest

The request message for the UpdateTrigger method.

Fields
trigger

Trigger

The trigger to be updated.

Authorization requires the following IAM permission on the specified resource trigger:

  • eventarc.triggers.update
update_mask

FieldMask

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

bool

If set to true, and the trigger is not found, a new trigger will be created. In this situation, update_mask is ignored.

validate_only

bool

Required. If set, validate the request and preview the review, but do not post it.