feat: add ingestion_data_source_settings field to Topic

Google APIs · copybara-github · commit 708f769ea398 · 2024-01-23T07:45:50.000-08:00
PiperOrigin-RevId: 600786127
diff --git a/google/pubsub/v1/pubsub.proto b/google/pubsub/v1/pubsub.proto
@@ -171,6 +171,71 @@ message SchemaSettings {
   string last_revision_id = 4;
 }
 
+// Settings for an ingestion data source on a topic.
+message IngestionDataSourceSettings {
+  // Ingestion settings for Amazon Kinesis Data Streams.
+  message AwsKinesis {
+    // Possible states for managed ingestion from Amazon Kinesis Data Streams.
+    enum State {
+      // Default value. This value is unused.
+      STATE_UNSPECIFIED = 0;
+
+      // Ingestion is active.
+      ACTIVE = 1;
+
+      // Permission denied encountered while consuming data from Kinesis.
+      // This can happen if:
+      //   - The provided `aws_role_arn` does not exist or does not have the
+      //     appropriate permissions attached.
+      //   - The provided `aws_role_arn` is not set up properly for Identity
+      //     Federation using `gcp_service_account`.
+      //   - The Pub/Sub SA is not granted the
+      //     `iam.serviceAccounts.getOpenIdToken` permission on
+      //     `gcp_service_account`.
+      KINESIS_PERMISSION_DENIED = 2;
+
+      // Permission denied encountered while publishing to the topic. This can
+      // happen due to Pub/Sub SA has not been granted the [appropriate publish
+      // permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
+      PUBLISH_PERMISSION_DENIED = 3;
+
+      // The Kinesis stream does not exist.
+      STREAM_NOT_FOUND = 4;
+
+      // The Kinesis consumer does not exist.
+      CONSUMER_NOT_FOUND = 5;
+    }
+
+    // Output only. An output-only field that indicates the state of the Kinesis
+    // ingestion source.
+    State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Required. The Kinesis stream ARN to ingest data from.
+    string stream_arn = 2 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. The Kinesis consumer ARN to used for ingestion in Enhanced
+    // Fan-Out mode. The consumer must be already created and ready to be used.
+    string consumer_arn = 3 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. AWS role ARN to be used for Federated Identity authentication
+    // with Kinesis. Check the Pub/Sub docs for how to set up this role and the
+    // required permissions that need to be attached to it.
+    string aws_role_arn = 4 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. The GCP service account to be used for Federated Identity
+    // authentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for
+    // the provided role). The `aws_role_arn` must be set up with
+    // `accounts.google.com:sub` equals to this service account number.
+    string gcp_service_account = 5 [(google.api.field_behavior) = REQUIRED];
+  }
+
+  // Only one source type can have settings set.
+  oneof source {
+    // Optional. Amazon Kinesis Data Streams.
+    AwsKinesis aws_kinesis = 1 [(google.api.field_behavior) = OPTIONAL];
+  }
+}
+
 // A topic resource.
 message Topic {
   option (google.api.resource) = {
@@ -179,6 +244,20 @@ message Topic {
     pattern: "_deleted-topic_"
   };
 
+  // The state of the topic.
+  enum State {
+    // Default value. This value is unused.
+    STATE_UNSPECIFIED = 0;
+
+    // The topic does not have any persistent errors.
+    ACTIVE = 1;
+
+    // Ingestion from the data source has encountered a permanent error.
+    // See the more detailed error state in the corresponding ingestion
+    // source configuration.
+    INGESTION_RESOURCE_ERROR = 2;
+  }
+
   // Required. The name of the topic. It must have the format
   // `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
   // and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
@@ -218,6 +297,14 @@ message Topic {
   // not set, message retention is controlled by settings on individual
   // subscriptions. Cannot be more than 31 days or less than 10 minutes.
   google.protobuf.Duration message_retention_duration = 8;
+
+  // Output only. An output-only field indicating the state of the topic.
+  State state = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. Settings for managed ingestion from a data source into this
+  // topic.
+  IngestionDataSourceSettings ingestion_data_source_settings = 10
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // A message that is published by publishers and consumed by subscribers. The
