data.proto

// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

package google.events.cloud.eventarc.v1;

import "google/protobuf/timestamp.proto";
import "google/rpc/code.proto";

option csharp_namespace = "Google.Events.Protobuf.Cloud.Eventarc.V1";
option php_namespace = "Google\\Events\\Cloud\\Eventarc\\V1";
option ruby_package = "Google::Events::Cloud::Eventarc::V1";

// 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.
message Channel {
  // State lists all the possible states of a Channel
  enum State {
    // Default value. This value is unused.
    STATE_UNSPECIFIED = 0;

    // 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.
    PENDING = 1;

    // 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.
    ACTIVE = 2;

    // 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.
    INACTIVE = 3;
  }

  // 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 name = 1;

  // 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.
  string uid = 2;

  // Output only. The creation time.
  google.protobuf.Timestamp create_time = 5;

  // Output only. The last-modified time.
  google.protobuf.Timestamp update_time = 6;

  // 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}`.
  string provider = 7;

  oneof transport {
    // 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}`.
    string pubsub_topic = 8;
  }

  // Output only. The state of a Channel.
  State state = 9;

  // Output only. The activation token for the channel. The token must be used
  // by the provider to register the channel for publishing.
  string activation_token = 10;

  // 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/*`.
  string crypto_key_name = 11;
}

// 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.
message ChannelConnection {
  // Required. The name of the connection.
  string name = 1;

  // Output only. Server assigned ID of the resource.
  // The server guarantees uniqueness and immutability until deleted.
  string uid = 2;

  // 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.
  string channel = 5;

  // Output only. The creation time.
  google.protobuf.Timestamp create_time = 6;

  // Output only. The last-modified time.
  google.protobuf.Timestamp update_time = 7;
}

// A representation of the trigger resource.
message Trigger {
  // 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 name = 1;

  // 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.
  string uid = 2;

  // Output only. The creation time.
  google.protobuf.Timestamp create_time = 5;

  // Output only. The last-modified time.
  google.protobuf.Timestamp update_time = 6;

  // 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.
  repeated EventFilter event_filters = 8;

  // 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.
  string service_account = 9;

  // Required. Destination specifies where the events should be sent to.
  Destination destination = 10;

  // 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.
  Transport transport = 11;

  // Optional. User labels attached to the triggers that can be used to group
  // resources.
  map<string, string> labels = 12;

  // 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.
  string channel = 13;

  // Output only. The reason(s) why a trigger is in FAILED state.
  map<string, StateCondition> conditions = 15;

  // 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 event_data_content_type = 16;

  // 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.
  string etag = 99;
}

// Filters events based on exact matches on the CloudEvents attributes.
message EventFilter {
  // 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 attribute = 1;

  // Required. The value for the attribute.
  string value = 2;

  // 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`.
  string operator = 3;
}

// A condition that is part of the trigger state computation.
message StateCondition {
  // The canonical code of the condition.
  google.rpc.Code code = 1;

  // Human-readable message.
  string message = 2;
}

// Represents a target of an invocation over HTTP.
message Destination {
  oneof descriptor {
    // Cloud Run fully-managed resource that receives the events. The resource
    // should be in the same project as the trigger.
    CloudRun cloud_run = 1;

    // 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.
    string cloud_function = 2;

    // A GKE service capable of receiving events. The service should be running
    // in the same project as the trigger.
    GKE gke = 3;

    // 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}`
    string workflow = 4;
  }
}

// Represents the transport intermediaries created for the trigger to
// deliver events.
message Transport {
  oneof intermediary {
    // The Pub/Sub topic and subscription used by Eventarc as a transport
    // intermediary.
    Pubsub pubsub = 1;
  }
}

// Represents a Cloud Run destination.
message CloudRun {
  // 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 service = 1;

  // 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 path = 2;

  // Required. The region the Cloud Run service is deployed in.
  string region = 3;
}

// Represents a GKE destination.
message GKE {
  // 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 cluster = 1;

  // 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 location = 2;

  // Required. The namespace the GKE service is running in.
  string namespace = 3;

  // Required. Name of the GKE service.
  string service = 4;

  // 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".
  string path = 5;
}

// Represents a Pub/Sub transport.
message Pubsub {
  // 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 topic = 1;

  // 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}`.
  string subscription = 2;
}

// The data within all Trigger events.
message TriggerEventData {
  // The Trigger event payload.
  Trigger payload = 1;
}

// The data within all Channel events.
message ChannelEventData {
  // The Channel event payload.
  Channel payload = 1;
}

// The data within all ChannelConnection events.
message ChannelConnectionEventData {
  // The ChannelConnection event payload.
  ChannelConnection payload = 1;
}