Index
Eventarc
(interface)Channel
(message)Channel.State
(enum)ChannelConnection
(message)CloudRun
(message)CreateChannelConnectionRequest
(message)CreateChannelRequest
(message)CreateTriggerRequest
(message)DeleteChannelConnectionRequest
(message)DeleteChannelRequest
(message)DeleteTriggerRequest
(message)Destination
(message)EventFilter
(message)EventType
(message)FilteringAttribute
(message)GKE
(message)GetChannelConnectionRequest
(message)GetChannelRequest
(message)GetGoogleChannelConfigRequest
(message)GetProviderRequest
(message)GetTriggerRequest
(message)GoogleChannelConfig
(message)ListChannelConnectionsRequest
(message)ListChannelConnectionsResponse
(message)ListChannelsRequest
(message)ListChannelsResponse
(message)ListProvidersRequest
(message)ListProvidersResponse
(message)ListTriggersRequest
(message)ListTriggersResponse
(message)OperationMetadata
(message)Provider
(message)Pubsub
(message)StateCondition
(message)Transport
(message)Trigger
(message)UpdateChannelRequest
(message)UpdateGoogleChannelConfigRequest
(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.
CreateChannel |
---|
Create a new channel in a particular project and location.
|
CreateChannelConnection |
---|
Create a new ChannelConnection in a particular project and location.
|
CreateTrigger |
---|
Create a new trigger in a particular project and location.
|
DeleteChannel |
---|
Delete a single channel.
|
DeleteChannelConnection |
---|
Delete a single ChannelConnection.
|
DeleteTrigger |
---|
Delete a single trigger.
|
GetChannel |
---|
Get a single Channel.
|
GetChannelConnection |
---|
Get a single ChannelConnection.
|
GetGoogleChannelConfig |
---|
Get a GoogleChannelConfig
|
GetProvider |
---|
Get a single Provider.
|
GetTrigger |
---|
Get a single trigger.
|
ListChannelConnections |
---|
List channel connections.
|
ListChannels |
---|
List channels.
|
ListProviders |
---|
List providers.
|
ListTriggers |
---|
List triggers.
|
UpdateChannel |
---|
Update a single channel.
|
UpdateGoogleChannelConfig |
---|
Update a single GoogleChannelConfig
|
UpdateTrigger |
---|
Update a single trigger.
|
Channel
A representation of the Channel resource. A Channel is a resource on which event providers publish their events. The published events are delivered through the transport associated with the channel. Note that a channel is associated with exactly one event provider.
Fields | |
---|---|
name |
Required. The resource name of the channel. Must be unique within the location on the project and must be in |
uid |
Output only. Server assigned unique identifier for the channel. 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. |
provider |
The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: |
state |
Output only. The state of a Channel. |
activation_token |
Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing. |
crypto_key_name |
Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern |
Union field
|
|
pubsub_topic |
Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: |
State
State lists all the possible states of a Channel
Enums | |
---|---|
STATE_UNSPECIFIED |
Default value. This value is unused. |
PENDING |
The PENDING state indicates that a Channel has been created successfully and there is a new activation token available for the subscriber to use to convey the Channel to the provider in order to create a Connection. |
ACTIVE |
The ACTIVE state indicates that a Channel has been successfully connected with the event provider. An ACTIVE Channel is ready to receive and route events from the event provider. |
INACTIVE |
The INACTIVE state indicates that the Channel cannot receive events permanently. There are two possible cases this state can happen:
To re-establish a Connection with a provider, the subscriber should create a new Channel and give it to the provider. |
ChannelConnection
A representation of the ChannelConnection resource. A ChannelConnection is a resource which event providers create during the activation process to establish a connection between the provider and the subscriber channel.
Fields | |
---|---|
name |
Required. The name of the connection. |
uid |
Output only. Server assigned ID of the resource. The server guarantees uniqueness and immutability until deleted. |
channel |
Required. The name of the connected subscriber Channel. This is a weak reference to avoid cross project and cross accounts references. This must be in |
create_time |
Output only. The creation time. |
update_time |
Output only. The last-modified time. |
activation_token |
Input only. Activation token for the channel. The token will be used during the creation of ChannelConnection to bind the channel with the provider project. This field will not be stored in the provider resource. |
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. |
CreateChannelConnectionRequest
The request message for the CreateChannelConnection method.
Fields | |
---|---|
parent |
Required. The parent collection in which to add this channel connection. Authorization requires the following IAM permission on the specified resource
|
channel_connection |
Required. Channel connection to create. |
channel_connection_id |
Required. The user-provided ID to be assigned to the channel connection. |
CreateChannelRequest
The request message for the CreateChannel method.
Fields | |
---|---|
parent |
Required. The parent collection in which to add this channel. Authorization requires the following IAM permission on the specified resource
|
channel |
Required. The channel to create. |
channel_id |
Required. The user-provided ID to be assigned to the channel. |
validate_only |
Required. If set, validate the request and preview the review, but do not post it. |
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. |
DeleteChannelConnectionRequest
The request message for the DeleteChannelConnection method.
Fields | |
---|---|
name |
Required. The name of the channel connection to delete. Authorization requires the following IAM permission on the specified resource
|
DeleteChannelRequest
The request message for the DeleteChannel method.
Fields | |
---|---|
name |
Required. The name of the channel to be deleted. Authorization requires the following IAM permission on the specified resource
|
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. |
cloud_function |
The Cloud Function resource name. Only Cloud Functions V2 is supported. Format: 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 |
A GKE service capable of receiving events. The service should be running in the same project as the trigger. |
workflow |
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: |
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. |
operator |
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 |
EventType
A representation of the event type resource.
Fields | |
---|---|
type |
Output only. The full name of the event type (for example, "google.cloud.storage.object.v1.finalized"). In the form of {provider-specific-prefix}.{resource}.{version}.{verb}. Types MUST be versioned and event schemas are guaranteed to remain backward compatible within one version. Note that event type versions and API versions do not need to match. |
description |
Output only. Human friendly description of what the event type is about. For example "Bucket created in Cloud Storage". |
filtering_attributes[] |
Output only. Filtering attributes for the event type. |
event_schema_uri |
Output only. URI for the event schema. For example "https://github.com/googleapis/google-cloudevents/blob/master/proto/google/events/cloud/storage/v1/events.proto" |
FilteringAttribute
A representation of the FilteringAttribute resource. Filtering attributes are per event type.
Fields | |
---|---|
attribute |
Output only. Attribute used for filtering the event type. |
description |
Output only. Description of the purpose of the attribute. |
required |
Output only. If true, the triggers for this provider should always specify a filter on these attributes. Trigger creation will fail otherwise. |
path_pattern_supported |
Output only. If true, the attribute accepts matching expressions in the Eventarc PathPattern format. |
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". |
GetChannelConnectionRequest
The request message for the GetChannelConnection method.
Fields | |
---|---|
name |
Required. The name of the channel connection to get. Authorization requires the following IAM permission on the specified resource
|
GetChannelRequest
The request message for the GetChannel method.
Fields | |
---|---|
name |
Required. The name of the channel to get. Authorization requires the following IAM permission on the specified resource
|
GetGoogleChannelConfigRequest
The request message for the GetGoogleChannelConfig method.
Fields | |
---|---|
name |
Required. The name of the config to get. Authorization requires the following IAM permission on the specified resource
|
GetProviderRequest
The request message for the GetProvider method.
Fields | |
---|---|
name |
Required. The name of the provider to get. Authorization requires the following IAM permission on the specified resource
|
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
|
GoogleChannelConfig
A GoogleChannelConfig is a resource that stores the custom settings respected by Eventarc first-party triggers in the matching region. Once configured, first-party event data will be protected using the specified custom managed encryption key instead of Google-managed encryption keys.
Fields | |
---|---|
name |
Required. The resource name of the config. Must be in the format of, |
update_time |
Output only. The last-modified time. |
crypto_key_name |
Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern |
ListChannelConnectionsRequest
The request message for the ListChannelConnections method.
Fields | |
---|---|
parent |
Required. The parent collection from which to list channel connections. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of channel connections to return on each page. Note: The service may send fewer responses. |
page_token |
The page token; provide the value from the When paginating, all other parameters provided to |
ListChannelConnectionsResponse
The response message for the ListChannelConnections
method.
Fields | |
---|---|
channel_connections[] |
The requested channel connections, up to the number specified in |
next_page_token |
A page token that can be sent to |
unreachable[] |
Unreachable resources, if any. |
ListChannelsRequest
The request message for the ListChannels method.
Fields | |
---|---|
parent |
Required. The parent collection to list channels on. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of channels 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 |
ListChannelsResponse
The response message for the ListChannels
method.
Fields | |
---|---|
channels[] |
The requested channels, up to the number specified in |
next_page_token |
A page token that can be sent to |
unreachable[] |
Unreachable resources, if any. |
ListProvidersRequest
The request message for the ListProviders method.
Fields | |
---|---|
parent |
Required. The parent of the provider to get. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of providers to return on each page. |
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 oder is ascending. To specify descending order for a field, append a |
filter |
The filter field that the list request will filter on. |
ListProvidersResponse
The response message for the ListProviders
method.
Fields | |
---|---|
providers[] |
The requested providers, up to the number specified in |
next_page_token |
A page token that can be sent to |
unreachable[] |
Unreachable resources, if any. |
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 |
filter |
Filter field. Used to filter the Triggers to be listed. Possible filters are described in https://google.aip.dev/160. For example, using "?filter=destination:gke" would list only Triggers with a gke destination. |
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 |
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. |
Provider
A representation of the Provider resource.
Fields | |
---|---|
name |
Output only. In |
display_name |
Output only. Human friendly name for the Provider. For example "Cloud Storage". |
event_types[] |
Output only. Event types for this provider. |
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: |
StateCondition
A condition that is part of the trigger state computation.
Fields | |
---|---|
code |
The canonical code of the condition. |
message |
Human-readable message. |
Transport
Represents the transport intermediaries created for the trigger to deliver events.
Fields | |
---|---|
Union field
|
|
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. Unordered list. 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 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 |
Optional. User labels attached to the triggers that can be used to group resources. |
channel |
Optional. The name of the channel associated with the trigger in |
conditions |
Output only. The reason(s) why a trigger is in FAILED state. |
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. |
UpdateChannelRequest
The request message for the UpdateChannel method.
Fields | |
---|---|
channel |
The channel 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 "*". |
validate_only |
Required. If set, validate the request and preview the review, but do not post it. |
UpdateGoogleChannelConfigRequest
The request message for the UpdateGoogleChannelConfig method.
Fields | |
---|---|
google_channel_config |
Required. The config 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 "*". |
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. |