google-cloud-dataplex-v1 2.7.0 → 2.8.1

data/proto_docs/google/cloud/dataplex/v1/data_documentation.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Dataplex
+      module V1
+        # DataDocumentation scan related spec.
+        class DataDocumentationSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The output of a DataDocumentation scan.
+        # @!attribute [r] table_result
+        #   @return [::Google::Cloud::Dataplex::V1::DataDocumentationResult::TableResult]
+        #     Output only. Table result for insights.
+        class DataDocumentationResult
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Generated metadata about the table.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. The service-qualified full resource name of the cloud
+          #     resource. Ex:
+          #     //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
+          # @!attribute [r] overview
+          #   @return [::String]
+          #     Output only. Generated description of the table.
+          # @!attribute [r] schema
+          #   @return [::Google::Cloud::Dataplex::V1::DataDocumentationResult::Schema]
+          #     Output only. Schema of the table with generated metadata of the columns
+          #     in the schema.
+          # @!attribute [r] queries
+          #   @return [::Array<::Google::Cloud::Dataplex::V1::DataDocumentationResult::Query>]
+          #     Output only. Sample SQL queries for the table.
+          class TableResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A sample SQL query in data documentation.
+          # @!attribute [r] sql
+          #   @return [::String]
+          #     Output only. The SQL query string which can be executed.
+          # @!attribute [r] description
+          #   @return [::String]
+          #     Output only. The description for the query.
+          class Query
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Schema of the table with generated metadata of columns.
+          # @!attribute [r] fields
+          #   @return [::Array<::Google::Cloud::Dataplex::V1::DataDocumentationResult::Field>]
+          #     Output only. The list of columns.
+          class Schema
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Column of a table with generated metadata and nested fields.
+          # @!attribute [r] name
+          #   @return [::String]
+          #     Output only. The name of the column.
+          # @!attribute [r] description
+          #   @return [::String]
+          #     Output only. Generated description for columns and fields.
+          # @!attribute [r] fields
+          #   @return [::Array<::Google::Cloud::Dataplex::V1::DataDocumentationResult::Field>]
+          #     Output only. Nested fields.
+          class Field
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/dataplex/v1/data_quality.rb

@@ -172,6 +172,9 @@ module Google
         #   @return [::Google::Cloud::Dataplex::V1::DataScanCatalogPublishingStatus]
         #     Output only. The status of publishing the data scan as Dataplex Universal
         #     Catalog metadata.
+        # @!attribute [r] anomaly_detection_generated_assets
+        #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult::AnomalyDetectionGeneratedAssets]
+        #     Output only. The generated assets for anomaly detection.
         class DataQualityResult
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -212,6 +215,35 @@ module Google
               end
             end
           end
+
+          # The assets generated by Anomaly Detection Data Scan.
+          # @!attribute [r] result_table
+          #   @return [::String]
+          #     Output only. The result table for anomaly detection.
+          #     Format:
+          #     PROJECT_ID.DATASET_ID.TABLE_ID
+          #     If the result table is set at AnomalyDetectionAssets, the result table
+          #     here would be the same as the one set in the
+          #     AnomalyDetectionAssets.result_table.
+          # @!attribute [r] data_intermediate_table
+          #   @return [::String]
+          #     Output only. The intermediate table for data anomaly detection.
+          #     Format:
+          #     PROJECT_ID.DATASET_ID.TABLE_ID
+          # @!attribute [r] freshness_intermediate_table
+          #   @return [::String]
+          #     Output only. The intermediate table for freshness anomaly detection.
+          #     Format:
+          #     PROJECT_ID.DATASET_ID.TABLE_ID
+          # @!attribute [r] volume_intermediate_table
+          #   @return [::String]
+          #     Output only. The intermediate table for volume anomaly detection.
+          #     Format:
+          #     PROJECT_ID.DATASET_ID.TABLE_ID
+          class AnomalyDetectionGeneratedAssets
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
 
         # DataQualityRuleResult provides a more detailed, per-rule view of the results.

data/proto_docs/google/cloud/dataplex/v1/datascans.rb

@@ -303,6 +303,10 @@ module Google
         # * Data discovery: scans data in Cloud Storage buckets to extract and then
         #   catalog metadata. For more information, see [Discover and catalog Cloud
         #   Storage data](https://cloud.google.com/bigquery/docs/automatic-discovery).
+        # * Data documentation: analyzes the table details and generates insights
+        # including descriptions and sample SQL queries for the table. For more
+        # information, see [Generate data insights in
+        # BigQuery](https://cloud.google.com/bigquery/docs/data-insights).
         # @!attribute [r] name
         #   @return [::String]
         #     Output only. Identifier. The relative resource name of the scan, of the
@@ -353,32 +357,42 @@ module Google
         #   @return [::Google::Cloud::Dataplex::V1::DataQualitySpec]
         #     Settings for a data quality scan.
         #
-        #     Note: The following fields are mutually exclusive: `data_quality_spec`, `data_profile_spec`, `data_discovery_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `data_quality_spec`, `data_profile_spec`, `data_discovery_spec`, `data_documentation_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] data_profile_spec
         #   @return [::Google::Cloud::Dataplex::V1::DataProfileSpec]
         #     Settings for a data profile scan.
         #
-        #     Note: The following fields are mutually exclusive: `data_profile_spec`, `data_quality_spec`, `data_discovery_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `data_profile_spec`, `data_quality_spec`, `data_discovery_spec`, `data_documentation_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] data_discovery_spec
         #   @return [::Google::Cloud::Dataplex::V1::DataDiscoverySpec]
         #     Settings for a data discovery scan.
         #
-        #     Note: The following fields are mutually exclusive: `data_discovery_spec`, `data_quality_spec`, `data_profile_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `data_discovery_spec`, `data_quality_spec`, `data_profile_spec`, `data_documentation_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] data_documentation_spec
+        #   @return [::Google::Cloud::Dataplex::V1::DataDocumentationSpec]
+        #     Settings for a data documentation scan.
+        #
+        #     Note: The following fields are mutually exclusive: `data_documentation_spec`, `data_quality_spec`, `data_profile_spec`, `data_discovery_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] data_quality_result
         #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult]
         #     Output only. The result of a data quality scan.
         #
-        #     Note: The following fields are mutually exclusive: `data_quality_result`, `data_profile_result`, `data_discovery_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `data_quality_result`, `data_profile_result`, `data_discovery_result`, `data_documentation_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] data_profile_result
         #   @return [::Google::Cloud::Dataplex::V1::DataProfileResult]
         #     Output only. The result of a data profile scan.
         #
-        #     Note: The following fields are mutually exclusive: `data_profile_result`, `data_quality_result`, `data_discovery_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `data_profile_result`, `data_quality_result`, `data_discovery_result`, `data_documentation_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] data_discovery_result
         #   @return [::Google::Cloud::Dataplex::V1::DataDiscoveryResult]
         #     Output only. The result of a data discovery scan.
         #
-        #     Note: The following fields are mutually exclusive: `data_discovery_result`, `data_quality_result`, `data_profile_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `data_discovery_result`, `data_quality_result`, `data_profile_result`, `data_documentation_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [r] data_documentation_result
+        #   @return [::Google::Cloud::Dataplex::V1::DataDocumentationResult]
+        #     Output only. The result of a data documentation scan.
+        #
+        #     Note: The following fields are mutually exclusive: `data_documentation_result`, `data_quality_result`, `data_profile_result`, `data_discovery_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class DataScan
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -459,32 +473,42 @@ module Google
         #   @return [::Google::Cloud::Dataplex::V1::DataQualitySpec]
         #     Output only. Settings for a data quality scan.
         #
-        #     Note: The following fields are mutually exclusive: `data_quality_spec`, `data_profile_spec`, `data_discovery_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `data_quality_spec`, `data_profile_spec`, `data_discovery_spec`, `data_documentation_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] data_profile_spec
         #   @return [::Google::Cloud::Dataplex::V1::DataProfileSpec]
         #     Output only. Settings for a data profile scan.
         #
-        #     Note: The following fields are mutually exclusive: `data_profile_spec`, `data_quality_spec`, `data_discovery_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `data_profile_spec`, `data_quality_spec`, `data_discovery_spec`, `data_documentation_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] data_discovery_spec
         #   @return [::Google::Cloud::Dataplex::V1::DataDiscoverySpec]
         #     Output only. Settings for a data discovery scan.
         #
-        #     Note: The following fields are mutually exclusive: `data_discovery_spec`, `data_quality_spec`, `data_profile_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `data_discovery_spec`, `data_quality_spec`, `data_profile_spec`, `data_documentation_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [r] data_documentation_spec
+        #   @return [::Google::Cloud::Dataplex::V1::DataDocumentationSpec]
+        #     Output only. Settings for a data documentation scan.
+        #
+        #     Note: The following fields are mutually exclusive: `data_documentation_spec`, `data_quality_spec`, `data_profile_spec`, `data_discovery_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] data_quality_result
         #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult]
         #     Output only. The result of a data quality scan.
         #
-        #     Note: The following fields are mutually exclusive: `data_quality_result`, `data_profile_result`, `data_discovery_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `data_quality_result`, `data_profile_result`, `data_discovery_result`, `data_documentation_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] data_profile_result
         #   @return [::Google::Cloud::Dataplex::V1::DataProfileResult]
         #     Output only. The result of a data profile scan.
         #
-        #     Note: The following fields are mutually exclusive: `data_profile_result`, `data_quality_result`, `data_discovery_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `data_profile_result`, `data_quality_result`, `data_discovery_result`, `data_documentation_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] data_discovery_result
         #   @return [::Google::Cloud::Dataplex::V1::DataDiscoveryResult]
         #     Output only. The result of a data discovery scan.
         #
-        #     Note: The following fields are mutually exclusive: `data_discovery_result`, `data_quality_result`, `data_profile_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `data_discovery_result`, `data_quality_result`, `data_profile_result`, `data_documentation_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [r] data_documentation_result
+        #   @return [::Google::Cloud::Dataplex::V1::DataDocumentationResult]
+        #     Output only. The result of a data documentation scan.
+        #
+        #     Note: The following fields are mutually exclusive: `data_documentation_result`, `data_quality_result`, `data_profile_result`, `data_discovery_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class DataScanJob
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -527,6 +551,9 @@ module Google
 
           # Data discovery scan.
           DATA_DISCOVERY = 3
+
+          # Data documentation scan.
+          DATA_DOCUMENTATION = 4
         end
       end
     end

data/proto_docs/google/cloud/dataplex/v1/processing.rb

@@ -78,8 +78,8 @@ module Google
         #     Storage bucket for DataDiscoveryScan Format:
         #     //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID
         #     or
-        #     BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan
-        #     Format:
+        #     BigQuery table of type "TABLE" for
+        #     DataProfileScan/DataQualityScan/DataDocumentationScan Format:
         #     //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
         #
         #     Note: The following fields are mutually exclusive: `resource`, `entity`. If a field in that set is populated, all other fields in the set will automatically be cleared.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dataplex-v1
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.1
 platform: ruby
 authors:
 - Google LLC
@@ -127,6 +127,7 @@ files:
 - lib/google/cloud/dataplex/v1/content_service/rest/service_stub.rb
 - lib/google/cloud/dataplex/v1/content_services_pb.rb
 - lib/google/cloud/dataplex/v1/data_discovery_pb.rb
+- lib/google/cloud/dataplex/v1/data_documentation_pb.rb
 - lib/google/cloud/dataplex/v1/data_profile_pb.rb
 - lib/google/cloud/dataplex/v1/data_quality_pb.rb
 - lib/google/cloud/dataplex/v1/data_scan_service.rb
@@ -191,6 +192,7 @@ files:
 - proto_docs/google/cloud/dataplex/v1/cmek.rb
 - proto_docs/google/cloud/dataplex/v1/content.rb
 - proto_docs/google/cloud/dataplex/v1/data_discovery.rb
+- proto_docs/google/cloud/dataplex/v1/data_documentation.rb
 - proto_docs/google/cloud/dataplex/v1/data_profile.rb
 - proto_docs/google/cloud/dataplex/v1/data_quality.rb
 - proto_docs/google/cloud/dataplex/v1/data_taxonomy.rb