feat: Support new feature Sharing Cloud Pubsub Streams via AH (GA) and Subscriber Email logging feature

Google APIs · copybara-github · commit b64f36a8c04a · 2025-03-26T00:52:50.000-07:00
PiperOrigin-RevId: 740660889
diff --git a/google/cloud/bigquery/analyticshub/v1/BUILD.bazel b/google/cloud/bigquery/analyticshub/v1/BUILD.bazel
@@ -25,6 +25,7 @@ proto_library(
     name = "analyticshub_proto",
     srcs = [
         "analyticshub.proto",
+        "pubsub.proto",
     ],
     deps = [
         "//google/api:annotations_proto",
@@ -34,6 +35,7 @@ proto_library(
         "//google/iam/v1:iam_policy_proto",
         "//google/iam/v1:policy_proto",
         "//google/longrunning:operations_proto",
+        "@com_google_protobuf//:duration_proto",
         "@com_google_protobuf//:empty_proto",
         "@com_google_protobuf//:field_mask_proto",
         "@com_google_protobuf//:timestamp_proto",
@@ -153,6 +155,7 @@ go_gapic_library(
         "//google/longrunning:longrunning_go_proto",
         "@com_google_cloud_go_longrunning//:go_default_library",
         "@com_google_cloud_go_longrunning//autogen:go_default_library",
+        "@io_bazel_rules_go//proto/wkt:duration_go_proto",
     ],
 )
 
@@ -350,6 +353,7 @@ load(
 
 csharp_proto_library(
     name = "analyticshub_csharp_proto",
+    extra_opts = [],
     deps = [":analyticshub_proto"],
 )
 
diff --git a/google/cloud/bigquery/analyticshub/v1/analyticshub.proto b/google/cloud/bigquery/analyticshub/v1/analyticshub.proto
@@ -20,6 +20,7 @@ import "google/api/annotations.proto";
 import "google/api/client.proto";
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
+import "google/cloud/bigquery/analyticshub/v1/pubsub.proto";
 import "google/iam/v1/iam_policy.proto";
 import "google/iam/v1/policy.proto";
 import "google/longrunning/operations.proto";
@@ -43,6 +44,22 @@ option (google.api.resource_definition) = {
   type: "bigquery.googleapis.com/Table"
   pattern: "projects/{project}/datasets/{dataset}/tables/{table}"
 };
+option (google.api.resource_definition) = {
+  type: "pubsub.googleapis.com/Topic"
+  pattern: "projects/{project}/topics/{topic}"
+};
+option (google.api.resource_definition) = {
+  type: "bigquery.googleapis.com/Routine"
+  pattern: "projects/{project}/datasets/{dataset}/routines/{routine}"
+};
+option (google.api.resource_definition) = {
+  type: "servicemanagement.googleapis.com/ManagedService"
+  pattern: "services/{service}"
+};
+option (google.api.resource_definition) = {
+  type: "cloudcommerceconsumerprocurement.googleapis.com/Order"
+  pattern: "projects/{project}/orders/{order}"
+};
 
 // The `AnalyticsHubService` API facilitates data sharing within and across
 // organizations. It allows data providers to publish listings that reference
@@ -167,8 +184,8 @@ service AnalyticsHubService {
     option (google.api.method_signature) = "name";
   }
 
-  // Creates a Subscription to a Data Exchange. This is a long-running operation
-  // as it will create one or more linked datasets.
+  // Creates a Subscription to a Data Clean Room. This is a long-running
+  // operation as it will create one or more linked datasets.
   rpc SubscribeDataExchange(SubscribeDataExchangeRequest)
       returns (google.longrunning.Operation) {
     option (google.api.http) = {
@@ -314,6 +331,18 @@ enum DiscoveryType {
   DISCOVERY_TYPE_PUBLIC = 2;
 }
 
+// The underlying shared asset type shared in a listing by a publisher.
+enum SharedResourceType {
+  // Not specified.
+  SHARED_RESOURCE_TYPE_UNSPECIFIED = 0;
+
+  // BigQuery Dataset Asset.
+  BIGQUERY_DATASET = 1;
+
+  // Pub/Sub Topic Asset.
+  PUBSUB_TOPIC = 2;
+}
+
 // A data exchange is a container that lets you share data. Along with the
 // descriptive information about the data exchange, it contains listings that
 // reference shared datasets.
@@ -366,6 +395,12 @@ message DataExchange {
   // discovery_type field for all the listings under this exchange.
   optional DiscoveryType discovery_type = 9
       [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. By default, false.
+  // If true, the DataExchange has an email sharing mandate enabled.
+  // Publishers can view the logged email of the subscriber.
+  optional bool log_linked_dataset_query_user_email = 10
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Sharing environment is a behavior model for sharing data within a
@@ -423,7 +458,6 @@ message Publisher {
   string primary_contact = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
-// Contains the reference that identifies a destination bigquery dataset.
 message DestinationDatasetReference {
   // Required. A unique ID for this dataset, without the project name. The ID
   // must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
@@ -461,6 +495,13 @@ message DestinationDataset {
   string location = 5 [(google.api.field_behavior) = REQUIRED];
 }
 
+// Defines the destination Pub/Sub subscription.
+message DestinationPubSubSubscription {
+  // Required. Destination Pub/Sub subscription resource.
+  PubSubSubscription pubsub_subscription = 1
+      [(google.api.field_behavior) = REQUIRED];
+}
+
 // A listing is what gets published into a data exchange that a subscriber can
 // subscribe to. It contains a reference to the data source along with
 // descriptive information that will help subscribers find and subscribe the
@@ -479,7 +520,7 @@ message Listing {
   // the subscriber's project. A Linked dataset is an opaque, read-only BigQuery
   // dataset that serves as a _symbolic link_ to a shared dataset.
   message BigQueryDatasetSource {
-    // Resource in this dataset that are selectively shared.
+    // Resource in this dataset that is selectively shared.
     message SelectedResource {
       oneof resource {
         // Optional. Format:
@@ -513,15 +554,17 @@ message Listing {
           [(google.api.field_behavior) = OPTIONAL];
     }
 
-    // Resource name of the dataset source for this listing.
+    // Optional. Resource name of the dataset source for this listing.
     // e.g. `projects/myproject/datasets/123`
-    string dataset = 1 [(google.api.resource_reference) = {
-      type: "bigquery.googleapis.com/Dataset"
-    }];
+    string dataset = 1 [
+      (google.api.field_behavior) = OPTIONAL,
+      (google.api.resource_reference) = {
+        type: "bigquery.googleapis.com/Dataset"
+      }
+    ];
 
-    // Optional. Resources in this dataset that are selectively shared.
-    // If this field is empty, then the entire dataset (all resources) are
-    // shared. This field is only valid for data clean room exchanges.
+    // Optional. Resource in this dataset that is selectively shared.
+    // This field is required for data clean room exchanges.
     repeated SelectedResource selected_resources = 2
         [(google.api.field_behavior) = OPTIONAL];
 
@@ -531,6 +574,22 @@ message Listing {
         [(google.api.field_behavior) = OPTIONAL];
   }
 
+  // Pub/Sub topic source.
+  message PubSubTopicSource {
+    // Required. Resource name of the Pub/Sub topic source for this listing.
+    // e.g. projects/myproject/topics/topicId
+    string topic = 1 [
+      (google.api.field_behavior) = REQUIRED,
+      (google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }
+    ];
+
+    // Optional. Region hint on where the data might be published. Data affinity
+    // regions are modifiable. See https://cloud.google.com/about/locations for
+    // full listing of possible Cloud regions.
+    repeated string data_affinity_regions = 2
+        [(google.api.field_behavior) = OPTIONAL];
+  }
+
   // Restricted export config, used to configure restricted export on linked
   // dataset.
   message RestrictedExportConfig {
@@ -602,9 +661,11 @@ message Listing {
 
   // Listing source.
   oneof source {
-    // Required. Shared dataset i.e. BigQuery dataset source.
-    BigQueryDatasetSource bigquery_dataset = 6
-        [(google.api.field_behavior) = REQUIRED];
+    // Shared dataset i.e. BigQuery dataset source.
+    BigQueryDatasetSource bigquery_dataset = 6;
+
+    // Pub/Sub topic source.
+    PubSubTopicSource pubsub_topic = 16;
   }
 
   // Output only. The resource name of the listing.
@@ -663,6 +724,15 @@ message Listing {
   // Optional. Type of discovery of the listing on the discovery page.
   optional DiscoveryType discovery_type = 14
       [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. Listing shared asset type.
+  SharedResourceType resource_type = 15
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. By default, false.
+  // If true, the Listing has an email sharing mandate enabled.
+  optional bool log_linked_dataset_query_user_email = 18
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // A subscription represents a subscribers' access to a particular set of
@@ -680,7 +750,15 @@ message Subscription {
       // Output only. Name of the linked dataset, e.g.
       // projects/subscriberproject/datasets/linked_dataset
       string linked_dataset = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+      // Output only. Name of the Pub/Sub subscription, e.g.
+      // projects/subscriberproject/subscriptions/subscriptions/sub_id
+      string linked_pubsub_subscription = 3
+          [(google.api.field_behavior) = OUTPUT_ONLY];
     }
+
+    // Output only. Listing for which linked resource is created.
+    string listing = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
   }
 
   // State of the subscription.
@@ -744,6 +822,21 @@ message Subscription {
 
   // Output only. Email of the subscriber.
   string subscriber_contact = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Linked resources created in the subscription. Only contains
+  // values if state = STATE_ACTIVE.
+  repeated LinkedResource linked_resources = 11
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Listing shared asset type.
+  SharedResourceType resource_type = 12
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. By default, false.
+  // If true, the Subscriber agreed to the email sharing mandate
+  // that is enabled for DataExchange/Listing.
+  optional bool log_linked_dataset_query_user_email = 14
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
 // Message for requesting the list of data exchanges.
@@ -825,9 +918,7 @@ message CreateDataExchangeRequest {
   ];
 
   // Required. The ID of the data exchange.
-  // Must contain only Unicode letters, numbers (0-9), underscores (_).
-  // Should not use characters that require URL-escaping, or characters
-  // outside of ASCII, spaces.
+  // Must contain only ASCII letters, numbers (0-9), underscores (_).
   // Max length: 100 bytes.
   string data_exchange_id = 2 [(google.api.field_behavior) = REQUIRED];
 
@@ -912,9 +1003,7 @@ message CreateListingRequest {
   ];
 
   // Required. The ID of the listing to create.
-  // Must contain only Unicode letters, numbers (0-9), underscores (_).
-  // Should not use characters that require URL-escaping, or characters
-  // outside of ASCII, spaces.
+  // Must contain only ASCII letters, numbers (0-9), underscores (_).
   // Max length: 100 bytes.
   string listing_id = 2 [(google.api.field_behavior) = REQUIRED];
 
@@ -953,6 +1042,11 @@ message SubscribeListingRequest {
     // Input only. BigQuery destination dataset to create for the subscriber.
     DestinationDataset destination_dataset = 3
         [(google.api.field_behavior) = INPUT_ONLY];
+
+    // Input only. Destination Pub/Sub subscription to create for the
+    // subscriber.
+    DestinationPubSubSubscription destination_pubsub_subscription = 5
+        [(google.api.field_behavior) = INPUT_ONLY];
   }
 
   // Required. Resource name of the listing that you want to subscribe to.
@@ -991,6 +1085,10 @@ message SubscribeDataExchangeRequest {
     }
   ];
 
+  // Optional. BigQuery destination dataset to create for the subscriber.
+  DestinationDataset destination_dataset = 5
+      [(google.api.field_behavior) = OPTIONAL];
+
   // Required. Name of the subscription to create.
   // e.g. `subscription1`
   string subscription = 4 [(google.api.field_behavior) = REQUIRED];
@@ -1123,6 +1221,7 @@ message RevokeSubscriptionRequest {
 }
 
 // Message for response when you revoke a subscription.
+// Empty for now.
 message RevokeSubscriptionResponse {}
 
 // Message for deleting a subscription.
diff --git a/google/cloud/bigquery/analyticshub/v1/pubsub.proto b/google/cloud/bigquery/analyticshub/v1/pubsub.proto
