google-cloud-dataplex-v1 0.7.0 → 0.8.0

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

@@ -37,7 +37,7 @@ module Google
         #     Overall data quality result -- `true` if all rules passed.
         # @!attribute [rw] dimensions
         #   @return [::Array<::Google::Cloud::Dataplex::V1::DataQualityDimensionResult>]
-        #     A list of results at the dimension-level.
+        #     A list of results at the dimension level.
         # @!attribute [rw] rules
         #   @return [::Array<::Google::Cloud::Dataplex::V1::DataQualityRuleResult>]
         #     A list of all the rules in a job, and their results.
@@ -52,8 +52,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # DataQualityRuleResult provides a more detailed, per-rule level view of the
-        # results.
+        # DataQualityRuleResult provides a more detailed, per-rule view of the results.
         # @!attribute [rw] rule
         #   @return [::Google::Cloud::Dataplex::V1::DataQualityRule]
         #     The rule specified in the DataQualitySpec, as is.
@@ -62,12 +61,15 @@ module Google
         #     Whether the rule passed or failed.
         # @!attribute [rw] evaluated_count
         #   @return [::Integer]
-        #     The number of rows a rule was evaluated against.
-        #     This field is only valid for ColumnMap type rules.
+        #     The number of rows a rule was evaluated against. This field is only valid
+        #     for ColumnMap type rules.
+        #
         #     Evaluated count can be configured to either
-        #     (1) include all rows (default) - with null rows automatically failing rule
-        #     evaluation  OR (2) exclude null rows from the evaluated_count, by setting
-        #     ignore_nulls = true
+        #
+        #     * include all rows (default) - with `null` rows automatically failing rule
+        #     evaluation, or
+        #     * exclude `null` rows from the `evaluated_count`, by setting
+        #     `ignore_nulls = true`.
         # @!attribute [rw] passed_count
         #   @return [::Integer]
         #     The number of rows which passed a rule evaluation.
@@ -77,7 +79,7 @@ module Google
         #     The number of rows with null values in the specified column.
         # @!attribute [rw] pass_ratio
         #   @return [::Float]
-        #     The ratio of passed_count / evaluated_count.
+        #     The ratio of **passed_count / evaluated_count**.
         #     This field is only valid for ColumnMap type rules.
         # @!attribute [rw] failing_rows_query
         #   @return [::String]
@@ -88,8 +90,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # DataQualityDimensionResult provides a more detailed, per-dimension level view
-        # of the results.
+        # DataQualityDimensionResult provides a more detailed, per-dimension view of
+        # the results.
         # @!attribute [rw] passed
         #   @return [::Boolean]
         #     Whether the dimension passed or failed.
@@ -133,20 +135,22 @@ module Google
         #     Optional. The unnested column which this rule is evaluated against.
         # @!attribute [rw] ignore_null
         #   @return [::Boolean]
-        #     Optional. Rows with null values will automatically fail a rule, unless
-        #     ignore_null is true. In that case, such null rows are trivially considered
-        #     passing. Only applicable to ColumnMap rules.
+        #     Optional. Rows with `null` values will automatically fail a rule, unless
+        #     `ignore_null` is `true`. In that case, such `null` rows are trivially
+        #     considered passing.
+        #
+        #     Only applicable to ColumnMap rules.
         # @!attribute [rw] dimension
         #   @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"]
+        #     the dimension level. Supported dimensions are **["COMPLETENESS",
+        #     "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]**
         # @!attribute [rw] threshold
         #   @return [::Float]
-        #     Optional. The minimum ratio of passing_rows / total_rows required to pass
-        #     this rule, with a range of [0.0, 1.0]
+        #     Optional. The minimum ratio of **passing_rows / total_rows** required to
+        #     pass this rule, with a range of [0.0, 1.0].
         #
-        #     0 indicates default value (i.e. 1.0)
+        #     0 indicates default value (i.e. 1.0).
         class DataQualityRule
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -155,21 +159,25 @@ module Google
           # @!attribute [rw] min_value
           #   @return [::String]
           #     Optional. The minimum column value allowed for a row to pass this
-          #     validation. At least one of min_value and max_value need to be provided.
+          #     validation. At least one of `min_value` and `max_value` need to be
+          #     provided.
           # @!attribute [rw] max_value
           #   @return [::String]
           #     Optional. The maximum column value allowed for a row to pass this
-          #     validation. At least one of min_value and max_value need to be provided.
+          #     validation. At least one of `min_value` and `max_value` need to be
+          #     provided.
           # @!attribute [rw] strict_min_enabled
           #   @return [::Boolean]
           #     Optional. Whether each value needs to be strictly greater than ('>') the
-          #     minimum, or if equality is allowed. Only relevant if a min_value has been
-          #     defined. Default = false.
+          #     minimum, or if equality is allowed.
+          #
+          #     Only relevant if a `min_value` has been defined. Default = false.
           # @!attribute [rw] strict_max_enabled
           #   @return [::Boolean]
           #     Optional. Whether each value needs to be strictly lesser than ('<') the
-          #     maximum, or if equality is allowed. Only relevant if a max_value has been
-          #     defined. Default = false.
+          #     maximum, or if equality is allowed.
+          #
+          #     Only relevant if a `max_value` has been defined. Default = false.
           class RangeExpectation
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -184,6 +192,7 @@ module Google
           # Evaluates whether each column value is contained by a specified set.
           # @!attribute [rw] values
           #   @return [::Array<::String>]
+          #     Expected values for the column value.
           class SetExpectation
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -192,6 +201,7 @@ module Google
           # Evaluates whether each column value matches a specified regex.
           # @!attribute [rw] regex
           #   @return [::String]
+          #     A regular expression the column value is expected to match.
           class RegexExpectation
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -207,30 +217,36 @@ module Google
           # range.
           # @!attribute [rw] statistic
           #   @return [::Google::Cloud::Dataplex::V1::DataQualityRule::StatisticRangeExpectation::ColumnStatistic]
+          #     The aggregate metric to evaluate.
           # @!attribute [rw] min_value
           #   @return [::String]
           #     The minimum column statistic value allowed for a row to pass this
           #     validation.
-          #     At least one of min_value and max_value need to be provided.
+          #
+          #     At least one of `min_value` and `max_value` need to be provided.
           # @!attribute [rw] max_value
           #   @return [::String]
           #     The maximum column statistic value allowed for a row to pass this
           #     validation.
-          #     At least one of min_value and max_value need to be provided.
+          #
+          #     At least one of `min_value` and `max_value` need to be provided.
           # @!attribute [rw] strict_min_enabled
           #   @return [::Boolean]
           #     Whether column statistic needs to be strictly greater than ('>')
-          #     the minimum, or if equality is allowed. Only relevant if a min_value has
-          #     been defined. Default = false.
+          #     the minimum, or if equality is allowed.
+          #
+          #     Only relevant if a `min_value` has been defined. Default = false.
           # @!attribute [rw] strict_max_enabled
           #   @return [::Boolean]
           #     Whether column statistic needs to be strictly lesser than ('<') the
-          #     maximum, or if equality is allowed. Only relevant if a max_value has been
-          #     defined. Default = false.
+          #     maximum, or if equality is allowed.
+          #
+          #     Only relevant if a `max_value` has been defined. Default = false.
           class StatisticRangeExpectation
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
 
+            # The list of aggregate metrics a rule can be evaluated against.
             module ColumnStatistic
               # Unspecified statistic type
               STATISTIC_UNDEFINED = 0
@@ -247,22 +263,28 @@ module Google
           end
 
           # Evaluates whether each row passes the specified condition.
+          #
           # The SQL expression needs to use BigQuery standard SQL syntax and should
-          # produce a boolean per row as the result.
+          # produce a boolean value per row as the result.
+          #
           # Example: col1 >= 0 AND col2 < 10
           # @!attribute [rw] sql_expression
           #   @return [::String]
+          #     The SQL expression.
           class RowConditionExpectation
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
           # Evaluates whether the provided expression is true.
+          #
           # The SQL expression needs to use BigQuery standard SQL syntax and should
           # produce a scalar boolean result.
+          #
           # Example: MIN(col1) >= 0
           # @!attribute [rw] sql_expression
           #   @return [::String]
+          #     The SQL expression.
           class TableConditionExpectation
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -40,6 +40,10 @@ module Google
         #     * Must end with a number or a letter.
         #     * Must be between 1-63 characters.
         #     * Must be unique within the customer project / location.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     Optional. Only validate the request, but do not perform mutations.
+        #     The default is `false`.
         class CreateDataScanRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -54,6 +58,10 @@ module Google
         # @!attribute [rw] update_mask
         #   @return [::Google::Protobuf::FieldMask]
         #     Required. Mask of fields to update.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     Optional. Only validate the request, but do not perform mutations.
+        #     The default is `false`.
         class UpdateDataScanRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -108,7 +116,7 @@ module Google
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. Maximum number of dataScans to return. The service may return
-        #     fewer than this value. If unspecified, at most 10 scans will be returned.
+        #     fewer than this value. If unspecified, at most 500 scans will be returned.
         #     The maximum value is 1000; values above 1000 will be coerced to 1000.
         # @!attribute [rw] page_token
         #   @return [::String]
@@ -171,7 +179,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the DataScanJob:
-        #     `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id}`
+        #     `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/jobs/{data_scan_job_id}`
         #     where `project` refers to a *project_id* or *project_number* and
         #     `location_id` refers to a GCP region.
         # @!attribute [rw] view

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

@@ -283,8 +283,7 @@ module Google
         #     published table name. Specifying a new ID in an update entity
         #     request will override the existing value.
         #     The ID must contain only letters (a-z, A-Z), numbers (0-9), and
-        #     underscores. Must begin with a letter and consist of 256 or fewer
-        #     characters.
+        #     underscores, and consist of 256 or fewer characters.
         # @!attribute [rw] etag
         #   @return [::String]
         #     Optional. The etag associated with the entity, which can be retrieved with
@@ -322,6 +321,14 @@ module Google
         # @!attribute [r] compatibility
         #   @return [::Google::Cloud::Dataplex::V1::Entity::CompatibilityStatus]
         #     Output only. Metadata stores that the entity is compatible with.
+        # @!attribute [r] access
+        #   @return [::Google::Cloud::Dataplex::V1::StorageAccess]
+        #     Output only. Identifies the access mechanism to the entity. Not user
+        #     settable.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. System generated unique ID for the Entity. This ID will be
+        #     different if the Entity is deleted and re-created with the same name.
         # @!attribute [rw] schema
         #   @return [::Google::Cloud::Dataplex::V1::Schema]
         #     Required. The description of the data structure and layout.
@@ -685,6 +692,28 @@ module Google
           end
         end
 
+        # Describes the access mechanism of the data within its storage location.
+        # @!attribute [r] read
+        #   @return [::Google::Cloud::Dataplex::V1::StorageAccess::AccessMode]
+        #     Output only. Describes the read access mechanism of the data. Not user
+        #     settable.
+        class StorageAccess
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Access Mode determines how data stored within the Entity is read.
+          module AccessMode
+            # Access mode unspecified.
+            ACCESS_MODE_UNSPECIFIED = 0
+
+            # Default. Data is accessed directly using storage APIs.
+            DIRECT = 1
+
+            # Data is accessed through a managed interface using BigQuery APIs.
+            MANAGED = 2
+          end
+        end
+
         # Identifies the cloud system that manages the data storage.
         module StorageSystem
           # Storage system unspecified.

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

@@ -24,7 +24,7 @@ module Google
         # DataScan scheduling and trigger settings.
         # @!attribute [rw] on_demand
         #   @return [::Google::Cloud::Dataplex::V1::Trigger::OnDemand]
-        #     The scan runs one-time shortly after DataScan Creation.
+        #     The scan runs once via `RunDataScan` API.
         # @!attribute [rw] schedule
         #   @return [::Google::Cloud::Dataplex::V1::Trigger::Schedule]
         #     The scan is scheduled to run periodically.
@@ -32,7 +32,7 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # The scan runs one-time via RunDataScan API.
+          # The scan runs once via `RunDataScan` API.
           class OnDemand
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -41,13 +41,17 @@ module Google
           # The scan is scheduled to run periodically.
           # @!attribute [rw] cron
           #   @return [::String]
-          #     Required. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running
+          #     Required. [Cron](https://en.wikipedia.org/wiki/Cron) schedule for running
           #     scans periodically.
-          #     To explicitly set a timezone to the cron tab, apply a prefix in the
-          #     cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or "TZ=$\\{IANA_TIME_ZONE}".
-          #     The $\\{IANA_TIME_ZONE} may only be a valid string from IANA time zone
-          #     database. For example, "CRON_TZ=America/New_York 1 * * * *", or
-          #     "TZ=America/New_York 1 * * * *".
+          #
+          #     To explicitly set a timezone in the cron tab, apply a prefix in the
+          #     cron tab: **"CRON_TZ=$\\{IANA_TIME_ZONE}"** or **"TZ=$\\{IANA_TIME_ZONE}"**.
+          #     The **$\\{IANA_TIME_ZONE}** may only be a valid string from IANA time zone
+          #     database
+          #     ([wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)).
+          #     For example, `CRON_TZ=America/New_York 1 * * * *`, or
+          #     `TZ=America/New_York 1 * * * *`.
+          #
           #     This field is required for Schedule scans.
           class Schedule
             include ::Google::Protobuf::MessageExts
@@ -58,9 +62,15 @@ module Google
         # The data source for DataScan.
         # @!attribute [rw] entity
         #   @return [::String]
-        #     Immutable. The dataplex entity that contains the data for DataScan, of
-        #     the form:
+        #     Immutable. The Dataplex entity that represents the data source (e.g.
+        #     BigQuery table) for DataScan, of the form:
         #     `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
+        # @!attribute [rw] resource
+        #   @return [::String]
+        #     Immutable. The service-qualified full resource name of the cloud resource
+        #     for a DataScan job to scan against. The field could be: BigQuery table of
+        #     type "TABLE" for DataProfileScan/DataQualityScan Format:
+        #     //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
         class DataSource
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -78,13 +88,13 @@ module Google
           # @!attribute [rw] field
           #   @return [::String]
           #     The field that contains values which monotonically increases over time
-          #     (e.g. timestamp).
+          #     (e.g. a timestamp column).
           # @!attribute [rw] start
           #   @return [::String]
-          #     Value that marks the start of the range
+          #     Value that marks the start of the range.
           # @!attribute [rw] end
           #   @return [::String]
-          #     Value that marks the end of the range
+          #     Value that marks the end of the range.
           class IncrementalField
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -249,9 +249,8 @@ module Google
           #     discovery every 60 minutes. To explicitly set a timezone to the cron
           #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
           #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
-          #     from IANA time zone database. For example,
-          #     `CRON_TZ=America/New_York 1 * * * *`,
-          #     or `TZ=America/New_York 1 * * * *`.
+          #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
+          #     * * * *`, or `TZ=America/New_York 1 * * * *`.
           class DiscoverySpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -629,9 +628,8 @@ module Google
           #     discovery every 60 minutes. To explicitly set a timezone to the cron
           #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
           #     TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid string
-          #     from IANA time zone database. For example,
-          #     `CRON_TZ=America/New_York 1 * * * *`,
-          #     or `TZ=America/New_York 1 * * * *`.
+          #     from IANA time zone database. For example, `CRON_TZ=America/New_York 1
+          #     * * * *`, or `TZ=America/New_York 1 * * * *`.
           class DiscoverySpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -682,6 +680,10 @@ module Google
           # @!attribute [rw] type
           #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::Type]
           #     Required. Immutable. Type of resource.
+          # @!attribute [rw] read_access_mode
+          #   @return [::Google::Cloud::Dataplex::V1::Asset::ResourceSpec::AccessMode]
+          #     Optional. Determines how read permissions are handled for each asset and
+          #     their associated tables. Only available to storage buckets assets.
           class ResourceSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -697,6 +699,19 @@ module Google
               # BigQuery dataset.
               BIGQUERY_DATASET = 2
             end
+
+            # Access Mode determines how data stored within the resource is read. This
+            # is only applicable to storage bucket assets.
+            module AccessMode
+              # Access mode unspecified.
+              ACCESS_MODE_UNSPECIFIED = 0
+
+              # Default. Data is accessed directly using storage APIs.
+              DIRECT = 1
+
+              # Data is accessed through a managed interface using BigQuery APIs.
+              MANAGED = 2
+            end
           end
 
           # Status of the resource referenced by an asset.
@@ -709,6 +724,9 @@ module Google
           # @!attribute [rw] update_time
           #   @return [::Google::Protobuf::Timestamp]
           #     Last update time of the status.
+          # @!attribute [r] managed_access_identity
+          #   @return [::String]
+          #     Output only. Service account associated with the BigQuery Connection.
           class ResourceStatus
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -553,6 +553,23 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the task:
+        #     `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`.
+        class RunTaskRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # @!attribute [rw] job
+        #   @return [::Google::Cloud::Dataplex::V1::Job]
+        #     Jobs created by RunTask API.
+        class RunTaskResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # List jobs request.
         # @!attribute [rw] parent
         #   @return [::String]

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

@@ -174,9 +174,8 @@ module Google
           #     tab, apply a prefix in the cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or
           #     "TZ=$\\{IANA_TIME_ZONE}". The $\\{IANA_TIME_ZONE} may only be a valid
           #     string from IANA time zone database. For example,
-          #     `CRON_TZ=America/New_York 1 * * * *`,
-          #     or `TZ=America/New_York 1 * * * *`.
-          #     This field is required for RECURRING tasks.
+          #     `CRON_TZ=America/New_York 1 * * * *`, or `TZ=America/New_York 1 * * *
+          #     *`. This field is required for RECURRING tasks.
           class TriggerSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dataplex-v1
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common