google-cloud-dataplex-v1 1.0.0 → 1.1.0

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

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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
+        # Spec for a data discovery scan.
+        # @!attribute [rw] bigquery_publishing_config
+        #   @return [::Google::Cloud::Dataplex::V1::DataDiscoverySpec::BigQueryPublishingConfig]
+        #     Optional. Configuration for metadata publishing.
+        # @!attribute [rw] storage_config
+        #   @return [::Google::Cloud::Dataplex::V1::DataDiscoverySpec::StorageConfig]
+        #     Cloud Storage related configurations.
+        class DataDiscoverySpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Describes BigQuery publishing configurations.
+          # @!attribute [rw] table_type
+          #   @return [::Google::Cloud::Dataplex::V1::DataDiscoverySpec::BigQueryPublishingConfig::TableType]
+          #     Optional. Determines whether to  publish discovered tables as BigLake
+          #     external tables or non-BigLake external tables.
+          # @!attribute [rw] connection
+          #   @return [::String]
+          #     Optional. The BigQuery connection used to create BigLake tables.
+          #     Must be in the form
+          #     `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
+          class BigQueryPublishingConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Determines how discovered tables are published.
+            module TableType
+              # Table type unspecified.
+              TABLE_TYPE_UNSPECIFIED = 0
+
+              # Default. Discovered tables are published as BigQuery external tables
+              # whose data is accessed using the credentials of the user querying the
+              # table.
+              EXTERNAL = 1
+
+              # Discovered tables are published as BigLake external tables whose data
+              # is accessed using the credentials of the associated BigQuery
+              # connection.
+              BIGLAKE = 2
+            end
+          end
+
+          # Configurations related to Cloud Storage as the data source.
+          # @!attribute [rw] include_patterns
+          #   @return [::Array<::String>]
+          #     Optional. Defines the data to include during discovery when only a subset
+          #     of the data should be considered. Provide a list of patterns that
+          #     identify the data to include. For Cloud Storage bucket assets, these
+          #     patterns are interpreted as glob patterns used to match object names. For
+          #     BigQuery dataset assets, these patterns are interpreted as patterns to
+          #     match table names.
+          # @!attribute [rw] exclude_patterns
+          #   @return [::Array<::String>]
+          #     Optional. Defines the data to exclude during discovery. Provide a list of
+          #     patterns that identify the data to exclude. For Cloud Storage bucket
+          #     assets, these patterns are interpreted as glob patterns used to match
+          #     object names. For BigQuery dataset assets, these patterns are interpreted
+          #     as patterns to match table names.
+          # @!attribute [rw] csv_options
+          #   @return [::Google::Cloud::Dataplex::V1::DataDiscoverySpec::StorageConfig::CsvOptions]
+          #     Optional. Configuration for CSV data.
+          # @!attribute [rw] json_options
+          #   @return [::Google::Cloud::Dataplex::V1::DataDiscoverySpec::StorageConfig::JsonOptions]
+          #     Optional. Configuration for JSON data.
+          class StorageConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Describes CSV and similar semi-structured data formats.
+            # @!attribute [rw] header_rows
+            #   @return [::Integer]
+            #     Optional. The number of rows to interpret as header rows that should be
+            #     skipped when reading data rows.
+            # @!attribute [rw] delimiter
+            #   @return [::String]
+            #     Optional. The delimiter that is used to separate values. The default is
+            #     `,` (comma).
+            # @!attribute [rw] encoding
+            #   @return [::String]
+            #     Optional. The character encoding of the data. The default is UTF-8.
+            # @!attribute [rw] type_inference_disabled
+            #   @return [::Boolean]
+            #     Optional. Whether to disable the inference of data types for CSV data.
+            #     If true, all columns are registered as strings.
+            # @!attribute [rw] quote
+            #   @return [::String]
+            #     Optional. The character used to quote column values. Accepts `"`
+            #     (double quotation mark) or `'` (single quotation mark). If unspecified,
+            #     defaults to `"` (double quotation mark).
+            class CsvOptions
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Describes JSON data format.
+            # @!attribute [rw] encoding
+            #   @return [::String]
+            #     Optional. The character encoding of the data. The default is UTF-8.
+            # @!attribute [rw] type_inference_disabled
+            #   @return [::Boolean]
+            #     Optional. Whether to disable the inference of data types for JSON data.
+            #     If true, all columns are registered as their primitive types
+            #     (strings, number, or boolean).
+            class JsonOptions
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+
+        # The output of a data discovery scan.
+        # @!attribute [r] bigquery_publishing
+        #   @return [::Google::Cloud::Dataplex::V1::DataDiscoveryResult::BigQueryPublishing]
+        #     Output only. Configuration for metadata publishing.
+        class DataDiscoveryResult
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Describes BigQuery publishing configurations.
+          # @!attribute [r] dataset
+          #   @return [::String]
+          #     Output only. The BigQuery dataset to publish to. It takes the form
+          #     `projects/{project_id}/datasets/{dataset_id}`.
+          #     If not set, the service creates a default publishing dataset.
+          class BigQueryPublishing
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -151,15 +151,15 @@ module Google
               # @!attribute [rw] distinct_ratio
               #   @return [::Float]
               #     Ratio of rows with distinct values against total scanned rows.
-              #     Not available for complex non-groupable field type RECORD and fields
-              #     with REPEATABLE mode.
+              #     Not available for complex non-groupable field type, including RECORD,
+              #     ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.
               # @!attribute [rw] top_n_values
               #   @return [::Array<::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::TopNValue>]
               #     The list of top N non-null values, frequency and ratio with which
               #     they occur in the scanned data. N is 10 or equal to the number of
               #     distinct values in the field, whichever is smaller. Not available for
-              #     complex non-groupable field type RECORD and fields with REPEATABLE
-              #     mode.
+              #     complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY,
+              #     and JSON, as well as fields with REPEATABLE mode.
               # @!attribute [rw] string_profile
               #   @return [::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::StringFieldInfo]
               #     String type field information.

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

@@ -276,7 +276,7 @@ module Google
         #   @return [::String]
         #     The dimension name a rule belongs to. Supported dimensions are
         #     ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS",
-        #     "INTEGRITY"]
+        #     "FRESHNESS", "VOLUME"]
         class DataQualityDimension
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -336,7 +336,8 @@ module Google
         #   @return [::String]
         #     Required. The dimension a rule belongs to. Results are also aggregated at
         #     the dimension level. Supported dimensions are **["COMPLETENESS",
-        #     "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]**
+        #     "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS",
+        #     "VOLUME"]**
         # @!attribute [rw] threshold
         #   @return [::Float]
         #     Optional. The minimum ratio of **passing_rows / total_rows** required to
@@ -359,6 +360,10 @@ module Google
         #     Optional. Description of the rule.
         #
         #     * The maximum length is 1,024 characters.
+        # @!attribute [rw] suspended
+        #   @return [::Boolean]
+        #     Optional. Whether the Rule is active or suspended.
+        #     Default is false.
         class DataQualityRule
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -340,16 +340,22 @@ module Google
         #     Output only. The type of DataScan.
         # @!attribute [rw] data_quality_spec
         #   @return [::Google::Cloud::Dataplex::V1::DataQualitySpec]
-        #     DataQualityScan related setting.
+        #     Settings for a data quality scan.
         # @!attribute [rw] data_profile_spec
         #   @return [::Google::Cloud::Dataplex::V1::DataProfileSpec]
-        #     DataProfileScan related setting.
+        #     Settings for a data profile scan.
+        # @!attribute [rw] data_discovery_spec
+        #   @return [::Google::Cloud::Dataplex::V1::DataDiscoverySpec]
+        #     Settings for a data discovery scan.
         # @!attribute [r] data_quality_result
         #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult]
-        #     Output only. The result of the data quality scan.
+        #     Output only. The result of a data quality scan.
         # @!attribute [r] data_profile_result
         #   @return [::Google::Cloud::Dataplex::V1::DataProfileResult]
-        #     Output only. The result of the data profile scan.
+        #     Output only. The result of a data profile scan.
+        # @!attribute [r] data_discovery_result
+        #   @return [::Google::Cloud::Dataplex::V1::DataDiscoveryResult]
+        #     Output only. The result of a data discovery scan.
         class DataScan
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -407,6 +413,9 @@ module Google
         # @!attribute [r] uid
         #   @return [::String]
         #     Output only. System generated globally unique ID for the DataScanJob.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the DataScanJob was created.
         # @!attribute [r] start_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The time when the DataScanJob was started.
@@ -424,16 +433,22 @@ module Google
         #     Output only. The type of the parent DataScan.
         # @!attribute [r] data_quality_spec
         #   @return [::Google::Cloud::Dataplex::V1::DataQualitySpec]
-        #     Output only. DataQualityScan related setting.
+        #     Output only. Settings for a data quality scan.
         # @!attribute [r] data_profile_spec
         #   @return [::Google::Cloud::Dataplex::V1::DataProfileSpec]
-        #     Output only. DataProfileScan related setting.
+        #     Output only. Settings for a data profile scan.
+        # @!attribute [r] data_discovery_spec
+        #   @return [::Google::Cloud::Dataplex::V1::DataDiscoverySpec]
+        #     Output only. Settings for a data discovery scan.
         # @!attribute [r] data_quality_result
         #   @return [::Google::Cloud::Dataplex::V1::DataQualityResult]
-        #     Output only. The result of the data quality scan.
+        #     Output only. The result of a data quality scan.
         # @!attribute [r] data_profile_result
         #   @return [::Google::Cloud::Dataplex::V1::DataProfileResult]
-        #     Output only. The result of the data profile scan.
+        #     Output only. The result of a data profile scan.
+        # @!attribute [r] data_discovery_result
+        #   @return [::Google::Cloud::Dataplex::V1::DataDiscoveryResult]
+        #     Output only. The result of a data discovery scan.
         class DataScanJob
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -463,16 +478,19 @@ module Google
           end
         end
 
-        # The type of DataScan.
+        # The type of data scan.
         module DataScanType
-          # The DataScan type is unspecified.
+          # The data scan type is unspecified.
           DATA_SCAN_TYPE_UNSPECIFIED = 0
 
-          # Data Quality scan.
+          # Data quality scan.
           DATA_QUALITY = 1
 
-          # Data Profile scan.
+          # Data profile scan.
           DATA_PROFILE = 2
+
+          # Data discovery scan.
+          DATA_DISCOVERY = 3
         end
       end
     end

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

@@ -37,6 +37,9 @@ module Google
         # @!attribute [rw] data_location
         #   @return [::String]
         #     The data location associated with the event.
+        # @!attribute [rw] datascan_id
+        #   @return [::String]
+        #     The id of the associated datascan for standalone discovery.
         # @!attribute [rw] type
         #   @return [::Google::Cloud::Dataplex::V1::DiscoveryEvent::EventType]
         #     The type of the event being logged.
@@ -52,6 +55,9 @@ module Google
         # @!attribute [rw] action
         #   @return [::Google::Cloud::Dataplex::V1::DiscoveryEvent::ActionDetails]
         #     Details about the action associated with the event.
+        # @!attribute [rw] table
+        #   @return [::Google::Cloud::Dataplex::V1::DiscoveryEvent::TableDetails]
+        #     Details about the BigQuery table publishing associated with the event.
         class DiscoveryEvent
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -90,6 +96,18 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Details about the published table.
+          # @!attribute [rw] table
+          #   @return [::String]
+          #     The fully-qualified resource name of the table resource.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::Dataplex::V1::DiscoveryEvent::TableType]
+          #     The type of the table resource.
+          class TableDetails
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # Details about the partition.
           # @!attribute [rw] partition
           #   @return [::String]
@@ -116,6 +134,9 @@ module Google
           #   @return [::String]
           #     The type of action.
           #     Eg. IncompatibleDataSchema, InvalidDataFormat
+          # @!attribute [rw] issue
+          #   @return [::String]
+          #     The human readable issue associated with the action.
           class ActionDetails
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -146,6 +167,18 @@ module Google
 
             # An event representing a partition being deleted.
             PARTITION_DELETED = 7
+
+            # An event representing a table being published.
+            TABLE_PUBLISHED = 10
+
+            # An event representing a table being updated.
+            TABLE_UPDATED = 11
+
+            # An event representing a table being skipped in publishing.
+            TABLE_IGNORED = 12
+
+            # An event representing a table being deleted.
+            TABLE_DELETED = 13
           end
 
           # The type of the entity.
@@ -159,6 +192,21 @@ module Google
             # Entities representing unstructured data.
             FILESET = 2
           end
+
+          # The type of the published table.
+          module TableType
+            # An unspecified table type.
+            TABLE_TYPE_UNSPECIFIED = 0
+
+            # External table type.
+            EXTERNAL_TABLE = 1
+
+            # BigLake table type.
+            BIGLAKE_TABLE = 2
+
+            # Object table type for unstructured data.
+            OBJECT_TABLE = 3
+          end
         end
 
         # The payload associated with Job logs that contains events describing jobs
@@ -436,7 +484,6 @@ module Google
 
         # These messages contain information about the execution of a datascan.
         # The monitored resource is 'DataScan'
-        # Next ID: 13
         # @!attribute [rw] data_source
         #   @return [::String]
         #     The data source of the data scan
@@ -646,6 +693,9 @@ module Google
 
             # Data scan for data quality.
             DATA_QUALITY = 2
+
+            # Data scan for data discovery.
+            DATA_DISCOVERY = 4
           end
 
           # The job state of the data scan.

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

@@ -260,10 +260,9 @@ module Google
           #     named process arguments (`--key=value`).
           # @!attribute [rw] sql_script_file
           #   @return [::String]
-          #     A reference to a query file. This can be the Cloud Storage URI of the
-          #     query file or it can the path to a SqlScript Content. The execution
-          #     args are used to declare a set of script variables
-          #     (`set key="value";`).
+          #     A reference to a query file. This should be the Cloud Storage URI of
+          #     the query file. The execution args are used to declare a set of script
+          #     variables (`set key="value";`).
           # @!attribute [rw] sql_script
           #   @return [::String]
           #     The query text.

data/proto_docs/google/longrunning/operations.rb

@@ -42,7 +42,7 @@ module Google
     #     The error result of the operation in case of failure or cancellation.
     # @!attribute [rw] response
     #   @return [::Google::Protobuf::Any]
-    #     The normal response of the operation in case of success.  If the original
+    #     The normal, successful response of the operation.  If the original
     #     method returns no data on success, such as `Delete`, the response is
     #     `google.protobuf.Empty`.  If the original method is standard
     #     `Get`/`Create`/`Update`, the response should be the resource.  For other
@@ -55,7 +55,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.GetOperation.
+    # The request message for
+    # Operations.GetOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource.
@@ -64,7 +65,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.ListOperations.
+    # The request message for
+    # Operations.ListOperations.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation's parent resource.
@@ -82,7 +84,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The response message for Operations.ListOperations.
+    # The response message for
+    # Operations.ListOperations.
     # @!attribute [rw] operations
     #   @return [::Array<::Google::Longrunning::Operation>]
     #     A list of operations that matches the specified filter in the request.
@@ -94,7 +97,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.CancelOperation.
+    # The request message for
+    # Operations.CancelOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource to be cancelled.
@@ -103,7 +107,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.DeleteOperation.
+    # The request message for
+    # Operations.DeleteOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource to be deleted.
@@ -112,7 +117,8 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
-    # The request message for Operations.WaitOperation.
+    # The request message for
+    # Operations.WaitOperation.
     # @!attribute [rw] name
     #   @return [::String]
     #     The name of the operation resource to wait on.
@@ -130,13 +136,12 @@ module Google
     #
     # Example:
     #
-    #   rpc LongRunningRecognize(LongRunningRecognizeRequest)
-    #       returns (google.longrunning.Operation) {
-    #     option (google.longrunning.operation_info) = {
-    #       response_type: "LongRunningRecognizeResponse"
-    #       metadata_type: "LongRunningRecognizeMetadata"
-    #     };
-    #   }
+    #     rpc Export(ExportRequest) returns (google.longrunning.Operation) {
+    #       option (google.longrunning.operation_info) = {
+    #         response_type: "ExportResponse"
+    #         metadata_type: "ExportMetadata"
+    #       };
+    #     }
     # @!attribute [rw] response_type
     #   @return [::String]
     #     Required. The message name of the primary return type for this

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dataplex-v1
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -123,6 +123,7 @@ files:
 - lib/google/cloud/dataplex/v1/content_service/rest/client.rb
 - 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_profile_pb.rb
 - lib/google/cloud/dataplex/v1/data_quality_pb.rb
 - lib/google/cloud/dataplex/v1/data_scan_service.rb
@@ -177,11 +178,13 @@ files:
 - proto_docs/README.md
 - proto_docs/google/api/client.rb
 - proto_docs/google/api/field_behavior.rb
+- proto_docs/google/api/field_info.rb
 - proto_docs/google/api/launch_stage.rb
 - proto_docs/google/api/resource.rb
 - proto_docs/google/cloud/dataplex/v1/analyze.rb
 - proto_docs/google/cloud/dataplex/v1/catalog.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_profile.rb
 - proto_docs/google/cloud/dataplex/v1/data_quality.rb
 - proto_docs/google/cloud/dataplex/v1/data_taxonomy.rb
@@ -221,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Dataplex API is used to manage the lifecycle of data lakes.