package google.events.cloud.eventarc.v1

Get desktop application:
View/edit binary Protocol Buffers messages

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.

Used in: ChannelEventData

• string name = 1

  Required. The resource name of the channel. Must be unique within the location on the project and must be in `projects/{project}/locations/{location}/channels/{channel_id}` format.

• string uid = 2

  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.

• optional protobuf.Timestamp create_time = 5

  Output only. The creation time.

• optional protobuf.Timestamp update_time = 6

  Output only. The last-modified time.

• string provider = 7

  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: `projects/{project}/locations/{location}/providers/{provider_id}`.

• oneof transport

  • string pubsub_topic = 8

    Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: `projects/{project}/topics/{topic_id}`.

• Channel.State state = 9

  Output only. The state of a Channel.

• string activation_token = 10

  Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.

• string crypto_key_name = 11

  Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.

State lists all the possible states of a Channel

Used in: Channel

• STATE_UNSPECIFIED = 0

  Default value. This value is unused.

• PENDING = 1

  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 = 2

  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 = 3

  The INACTIVE state indicates that the Channel cannot receive events permanently. There are two possible cases this state can happen: 1. The SaaS provider disconnected from this Channel. 2. The Channel activation token has expired but the SaaS provider wasn't connected. To re-establish a Connection with a provider, the subscriber should create a new Channel and give it to the provider.

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.

Used in: ChannelConnectionEventData

• string name = 1

  Required. The name of the connection.

• string uid = 2

  Output only. Server assigned ID of the resource. The server guarantees uniqueness and immutability until deleted.

• string channel = 5

  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 `projects/{project}/location/{location}/channels/{channel_id}` format.

• optional protobuf.Timestamp create_time = 6

  Output only. The creation time.

• optional protobuf.Timestamp update_time = 7

  Output only. The last-modified time.

The CloudEvent raised when a ChannelConnection is created.

• optional ChannelConnectionEventData data = 1

  The data associated with the event.

The CloudEvent raised when a ChannelConnection is deleted.

• optional ChannelConnectionEventData data = 1

  The data associated with the event.

The data within all ChannelConnection events.

Used in: ChannelConnectionCreatedEvent, ChannelConnectionDeletedEvent

• optional ChannelConnection payload = 1

  The ChannelConnection event payload.

The CloudEvent raised when a Channel is created.

• optional ChannelEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Channel is deleted.

• optional ChannelEventData data = 1

  The data associated with the event.

The data within all Channel events.

Used in: ChannelCreatedEvent, ChannelDeletedEvent, ChannelUpdatedEvent

• optional Channel payload = 1

  The Channel event payload.

The CloudEvent raised when a Channel is updated.

• optional ChannelEventData data = 1

  The data associated with the event.

Represents a Cloud Run destination.

Used in: Destination

• string service = 1

  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.

• string path = 2

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

• string region = 3

  Required. The region the Cloud Run service is deployed in.

Represents a target of an invocation over HTTP.

Used in: Trigger

• oneof descriptor

  • CloudRun cloud_run = 1

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

  • string cloud_function = 2

    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 gke = 3

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

  • string workflow = 4

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

Filters events based on exact matches on the CloudEvents attributes.

Used in: Trigger

• string attribute = 1

  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.

• string value = 2

  Required. The value for the attribute.

• string operator = 3

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

Represents a GKE destination.

Used in: Destination

• string cluster = 1

  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.

• string location = 2

  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.

• string namespace = 3

  Required. The namespace the GKE service is running in.

• string service = 4

  Required. Name of the GKE service.

• string path = 5

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

Represents a Pub/Sub transport.

Used in: Transport

• string topic = 1

  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.

• string subscription = 2

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

A condition that is part of the trigger state computation.

Used in: Trigger

• rpc.Code code = 1

  The canonical code of the condition.

• string message = 2

  Human-readable message.

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

Used in: Trigger

• oneof intermediary

  • Pubsub pubsub = 1

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

A representation of the trigger resource.

Used in: TriggerEventData

• string name = 1

  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.

• string uid = 2

  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.

• optional protobuf.Timestamp create_time = 5

  Output only. The creation time.

• optional protobuf.Timestamp update_time = 6

  Output only. The last-modified time.

• repeated EventFilter event_filters = 8

  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.

• string service_account = 9

  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.

• optional Destination destination = 10

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

• optional Transport transport = 11

  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.

• map<string, string> labels = 12

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

• string channel = 13

  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.

• map<string, StateCondition> conditions = 15

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

• string event_data_content_type = 16

  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.

• string etag = 99

  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.

The CloudEvent raised when a Trigger is created.

• optional TriggerEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Trigger is deleted.

• optional TriggerEventData data = 1

  The data associated with the event.

The data within all Trigger events.

Used in: TriggerCreatedEvent, TriggerDeletedEvent, TriggerUpdatedEvent

• optional Trigger payload = 1

  The Trigger event payload.

The CloudEvent raised when a Trigger is updated.

• optional TriggerEventData data = 1

  The data associated with the event.