Deprecate DataProfileResult and DataQualityResult for Dataplex Datasc…

…ans. (GoogleCloudPlatform#8593)
ron-gal · Aug 17, 2023 · fbb3dae · fbb3dae
1 parent edd6e87
commit fbb3dae
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/mmv1/products/dataplex/Datascan.yaml b/mmv1/products/dataplex/Datascan.yaml
@@ -416,6 +416,7 @@ properties:
   - !ruby/object:Api::Type::NestedObject
     name: 'dataQualityResult'
     output: true
+    deprecation_message: "dataQualityResult will be removed from Terraform output fields in 5.0.0"
     description: |
       The result of the data quality scan.
     properties:
@@ -642,6 +643,7 @@ properties:
   - !ruby/object:Api::Type::NestedObject
     name: 'dataProfileResult'
     output: true
+    deprecation_message: "dataProfileResult will be removed from Terraform output fields in 5.0.0"
     custom_flatten: templates/terraform/custom_flatten/dataplex_datascan_ignore_profile_result.go.erb
     description: |
       The result of the data profile scan.

diff --git a/mmv1/third_party/terraform/website/docs/guides/version_5_upgrade.html.markdown b/mmv1/third_party/terraform/website/docs/guides/version_5_upgrade.html.markdown
@@ -190,6 +190,12 @@ These two unsupported fields were introduced incorrectly. They are now removed.
 
 This unsupported field was introduced incorrectly. It is now removed.
 
+## Resource: `google_dataplex_datascan`
+
+### `dataQualityResult` and `dataProfileResult` output fields are now removed 
+
+`dataQualityResult` and `dataProfileResult` were output-only fields which listed results for the latest job created under a Datascan. These were problematic fields that are unlikely to be relevant in a Terraform context. Removing them reduces the likelihood of additional parsing errors, and reduces maintenance overhead for the API surface.
+
 ## Resource: `google_compute_router_nat`
 
 ### `enable_endpoint_independent_mapping` now defaults to API's default value which is `FALSE`