Adding support for log_linked_dataset_query_user_email attribute for BigQuery Analytics Hub listings. (#14225) (#10177)

[upstream:cf25ab930f3bb6688ee4210ab137142b69c4da70]

Signed-off-by: Modular Magician <[email protected]>

Author: modular-magician

.changelog/14225.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+bigqueryanalyticshub: added `log_linked_dataset_query_user_email` field to `google_bigquery_analytics_hub_listing` resource
+```

google-beta/services/bigqueryanalyticshub/resource_bigquery_analytics_hub_listing.go

@@ -157,6 +157,12 @@ func ResourceBigqueryAnalyticsHubListing() *schema.Resource {
 				Optional:    true,
 				Description: `Base64 encoded image representing the listing.`,
 			},
+			"log_linked_dataset_query_user_email": {
+				Type:        schema.TypeBool,
+				Optional:    true,
+				ForceNew:    true,
+				Description: `If true, subscriber email logging is enabled and all queries on the linked dataset will log the email address of the querying user.`,
+			},
 			"primary_contact": {
 				Type:        schema.TypeString,
 				Optional:    true,
@@ -302,6 +308,12 @@ func resourceBigqueryAnalyticsHubListingCreate(d *schema.ResourceData, meta inte
 	} else if v, ok := d.GetOkExists("restricted_export_config"); !tpgresource.IsEmptyValue(reflect.ValueOf(restrictedExportConfigProp)) && (ok || !reflect.DeepEqual(v, restrictedExportConfigProp)) {
 		obj["restrictedExportConfig"] = restrictedExportConfigProp
 	}
+	logLinkedDatasetQueryUserEmailProp, err := expandBigqueryAnalyticsHubListingLogLinkedDatasetQueryUserEmail(d.Get("log_linked_dataset_query_user_email"), d, config)
+	if err != nil {
+		return err
+	} else if v, ok := d.GetOkExists("log_linked_dataset_query_user_email"); !tpgresource.IsEmptyValue(reflect.ValueOf(logLinkedDatasetQueryUserEmailProp)) && (ok || !reflect.DeepEqual(v, logLinkedDatasetQueryUserEmailProp)) {
+		obj["logLinkedDatasetQueryUserEmail"] = logLinkedDatasetQueryUserEmailProp
+	}
 
 	url, err := tpgresource.ReplaceVars(d, config, "{{BigqueryAnalyticsHubBasePath}}projects/{{project}}/locations/{{location}}/dataExchanges/{{data_exchange_id}}/listings?listing_id={{listing_id}}")
 	if err != nil {
@@ -427,6 +439,9 @@ func resourceBigqueryAnalyticsHubListingRead(d *schema.ResourceData, meta interf
 	if err := d.Set("restricted_export_config", flattenBigqueryAnalyticsHubListingRestrictedExportConfig(res["restrictedExportConfig"], d, config)); err != nil {
 		return fmt.Errorf("Error reading Listing: %s", err)
 	}
+	if err := d.Set("log_linked_dataset_query_user_email", flattenBigqueryAnalyticsHubListingLogLinkedDatasetQueryUserEmail(res["logLinkedDatasetQueryUserEmail"], d, config)); err != nil {
+		return fmt.Errorf("Error reading Listing: %s", err)
+	}
 
 	return nil
 }
@@ -808,6 +823,10 @@ func flattenBigqueryAnalyticsHubListingRestrictedExportConfigRestrictQueryResult
 	return v
 }
 
+func flattenBigqueryAnalyticsHubListingLogLinkedDatasetQueryUserEmail(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
+	return v
+}
+
 func expandBigqueryAnalyticsHubListingDisplayName(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
 	return v, nil
 }
@@ -1004,3 +1023,7 @@ func expandBigqueryAnalyticsHubListingRestrictedExportConfigRestrictDirectTableA
 func expandBigqueryAnalyticsHubListingRestrictedExportConfigRestrictQueryResult(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
 	return v, nil
 }
+
+func expandBigqueryAnalyticsHubListingLogLinkedDatasetQueryUserEmail(v interface{}, d tpgresource.TerraformResourceData, config *transport_tpg.Config) (interface{}, error) {
+	return v, nil
+}

google-beta/services/bigqueryanalyticshub/resource_bigquery_analytics_hub_listing_generated_meta.yaml

@@ -20,6 +20,7 @@ fields:
     provider_only: true
   - field: 'location'
     provider_only: true
+  - field: 'log_linked_dataset_query_user_email'
   - field: 'name'
   - field: 'primary_contact'
   - field: 'publisher.name'

google-beta/services/bigqueryanalyticshub/resource_bigquery_analytics_hub_listing_generated_test.go

@@ -235,6 +235,62 @@ EOF
 `, context)
 }
 
+func TestAccBigqueryAnalyticsHubListing_bigqueryAnalyticshubListingLogLinkedDatasetQueryUserExample(t *testing.T) {
+	t.Parallel()
+
+	context := map[string]interface{}{
+		"random_suffix": acctest.RandString(t, 10),
+	}
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccCheckBigqueryAnalyticsHubListingDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testAccBigqueryAnalyticsHubListing_bigqueryAnalyticshubListingLogLinkedDatasetQueryUserExample(context),
+			},
+			{
+				ResourceName:            "google_bigquery_analytics_hub_listing.listing",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"data_exchange_id", "listing_id", "location"},
+			},
+		},
+	})
+}
+
+func testAccBigqueryAnalyticsHubListing_bigqueryAnalyticshubListingLogLinkedDatasetQueryUserExample(context map[string]interface{}) string {
+	return acctest.Nprintf(`
+resource "google_bigquery_analytics_hub_data_exchange" "listing_log_email" {
+  location         = "US"
+  data_exchange_id = "tf_test_tf_test_log_email_de%{random_suffix}" 
+  display_name     = "tf_test_tf_test_log_email_de%{random_suffix}" 
+  description      = "Example for log email test%{random_suffix}"
+}
+
+resource "google_bigquery_analytics_hub_listing" "listing" {
+  location         = "US"
+  data_exchange_id = google_bigquery_analytics_hub_data_exchange.listing_log_email.data_exchange_id
+  listing_id       = "tf_test_tf_test_log_email_listing%{random_suffix}" 
+  display_name     = "tf_test_tf_test_log_email_listing%{random_suffix}" 
+  description      = "Example for log email test%{random_suffix}"
+  log_linked_dataset_query_user_email = true
+
+  bigquery_dataset {
+    dataset = google_bigquery_dataset.listing_log_email.id
+  }
+}
+
+resource "google_bigquery_dataset" "listing_log_email" {
+  dataset_id                  = "tf_test_tf_test_log_email_ds%{random_suffix}" 
+  friendly_name               = "tf_test_tf_test_log_email_ds%{random_suffix}" 
+  description                 = "Example for log email test%{random_suffix}"
+  location                    = "US"
+}
+`, context)
+}
+
 func testAccCheckBigqueryAnalyticsHubListingDestroyProducer(t *testing.T) func(s *terraform.State) error {
 	return func(s *terraform.State) error {
 		for name, rs := range s.RootModule().Resources {

website/docs/r/bigquery_analytics_hub_listing.html.markdown

@@ -175,6 +175,42 @@ resource "google_bigquery_table" "listing" {
 EOF
 }
 ```
+<div class = "oics-button" style="float: right; margin: 0 0 -15px">
+  <a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_image=gcr.io%2Fcloudshell-images%2Fcloudshell%3Alatest&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md&cloudshell_working_dir=bigquery_analyticshub_listing_log_linked_dataset_query_user&open_in_editor=main.tf" target="_blank">
+    <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
+  </a>
+</div>
+## Example Usage - Bigquery Analyticshub Listing Log Linked Dataset Query User
+
+
+```hcl
+resource "google_bigquery_analytics_hub_data_exchange" "listing_log_email" {
+  location         = "US"
+  data_exchange_id = "tf_test_log_email_de" 
+  display_name     = "tf_test_log_email_de" 
+  description      = "Example for log email test"
+}
+
+resource "google_bigquery_analytics_hub_listing" "listing" {
+  location         = "US"
+  data_exchange_id = google_bigquery_analytics_hub_data_exchange.listing_log_email.data_exchange_id
+  listing_id       = "tf_test_log_email_listing" 
+  display_name     = "tf_test_log_email_listing" 
+  description      = "Example for log email test"
+  log_linked_dataset_query_user_email = true
+
+  bigquery_dataset {
+    dataset = google_bigquery_dataset.listing_log_email.id
+  }
+}
+
+resource "google_bigquery_dataset" "listing_log_email" {
+  dataset_id                  = "tf_test_log_email_ds" 
+  friendly_name               = "tf_test_log_email_ds" 
+  description                 = "Example for log email test"
+  location                    = "US"
+}
+```
 
 ## Argument Reference
 
@@ -263,6 +299,10 @@ The following arguments are supported:
   If set, restricted export configuration will be propagated and enforced on the linked dataset.
   Structure is [documented below](#nested_restricted_export_config).
 
+* `log_linked_dataset_query_user_email` -
+  (Optional)
+  If true, subscriber email logging is enabled and all queries on the linked dataset will log the email address of the querying user.
+
 * `project` - (Optional) The ID of the project in which the resource belongs.
     If it is not provided, the provider project is used.