feat: Add export config protos to API

Google APIs · copybara-github · commit 154b4102b773 · 2022-08-18T06:30:15.000-07:00
PiperOrigin-RevId: 468442481
diff --git a/google/cloud/pubsublite/v1/BUILD.bazel b/google/cloud/pubsublite/v1/BUILD.bazel
@@ -33,6 +33,7 @@ proto_library(
         "//google/api:client_proto",
         "//google/api:field_behavior_proto",
         "//google/api:resource_proto",
+        "//google/rpc:status_proto",
         "//google/longrunning:operations_proto",
         "@com_google_protobuf//:duration_proto",
         "@com_google_protobuf//:empty_proto",
@@ -130,6 +131,7 @@ go_proto_library(
     protos = [":pubsublite_proto"],
     deps = [
         "//google/api:annotations_go_proto",
+        "//google/rpc:status_go_proto",
         "//google/longrunning:longrunning_go_proto",
     ],
 )
diff --git a/google/cloud/pubsublite/v1/common.proto b/google/cloud/pubsublite/v1/common.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -16,9 +16,11 @@ syntax = "proto3";
 
 package google.cloud.pubsublite.v1;
 
+import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
+import "google/rpc/status.proto";
 
 option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.PubSubLite.V1";
@@ -225,6 +227,79 @@ message Subscription {
 
   // The settings for this subscription's message delivery.
   DeliveryConfig delivery_config = 3;
+
+  // If present, messages are automatically written from the Pub/Sub Lite topic
+  // associated with this subscription to a destination.
+  ExportConfig export_config = 4;
+}
+
+// Configuration for a Pub/Sub Lite subscription that writes messages to a
+// destination. User subscriber clients must not connect to this subscription.
+message ExportConfig {
+  // An export state.
+  enum State {
+    // Default value. This value is unused.
+    STATE_UNSPECIFIED = 0;
+
+    // Messages are being exported.
+    ACTIVE = 1;
+
+    // Exporting messages is suspended.
+    PAUSED = 2;
+  }
+
+  // The export status of a partition.
+  message PartitionStatus {
+    // The partition number.
+    int64 partition = 1;
+
+    // If the export for a partition is healthy and the desired state is
+    // `ACTIVE`, the status code will be `OK` (zero). If the desired state of
+    // the export is `PAUSED`, the status code will be `CANCELLED`.
+    //
+    // If the export has been suspended due to an error, the status will be
+    // populated with an error code and details. The service will automatically
+    // retry after a period of time, and will update the status code to `OK` if
+    // export subsequently succeeds.
+    google.rpc.Status status = 2;
+  }
+
+  // Configuration for exporting to a Pub/Sub topic.
+  message PubSubConfig {
+    // The name of the Pub/Sub topic.
+    // Structured like: projects/{project_number}/topics/{topic_id}.
+    // The topic may be changed.
+    string topic = 1;
+  }
+
+  // The desired state of this export.
+  State desired_state = 1;
+
+  // Output only. The export statuses of each partition. This field is output only.
+  repeated PartitionStatus statuses = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not
+  // be exported to the destination. For example, the message can not be
+  // published to the Pub/Sub service because it does not satisfy the
+  // constraints documented at https://cloud.google.com/pubsub/docs/publisher.
+  //
+  // Structured like:
+  // projects/{project_number}/locations/{location}/topics/{topic_id}.
+  // Must be within the same project and location as the subscription. The topic
+  // may be changed or removed.
+  string dead_letter_topic = 5 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = {
+      type: "pubsublite.googleapis.com/Topic"
+    }
+  ];
+
+  // The destination to export to. Required.
+  oneof destination {
+    // Messages are automatically written from the Pub/Sub Lite topic associated
+    // with this subscription to a Pub/Sub topic.
+    PubSubConfig pubsub_config = 3;
+  }
 }
 
 // A target publish or event time. Can be used for seeking to or retrieving the
diff --git a/google/cloud/pubsublite/v1/pubsublite_v1.yaml b/google/cloud/pubsublite/v1/pubsublite_v1.yaml
@@ -10,6 +10,7 @@ apis:
 - name: google.cloud.pubsublite.v1.PublisherService
 - name: google.cloud.pubsublite.v1.SubscriberService
 - name: google.cloud.pubsublite.v1.TopicStatsService
+- name: google.longrunning.Operations
 
 types:
 - name: google.cloud.pubsublite.v1.OperationMetadata
