Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataQualitySpec (v2.10.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::DataQualitySpec.

DataQualityScan related setting.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#catalog_publishing_enabled

def catalog_publishing_enabled() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata.

#catalog_publishing_enabled=

def catalog_publishing_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata.
Returns
  • (::Boolean) — Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata.

#enable_catalog_based_rules

def enable_catalog_based_rules() -> ::Boolean
Returns
  • (::Boolean) — Optional. If enabled, the data scan will retrieve rules defined in the dataplex-types.global.data-rules aspect on all paths of the catalog entry corresponding to the BigQuery table resource and all attached glossary terms. The path that data-rules aspect is attached on the table entry defines the column that the rule will be evaluated against. For glossary terms, the path that the terms are attached on the table entry defines the column that the rule will be evaluated against. At the start of scan execution, the rules reflect the latest state retrieved from the catalog entry and any updates on the rules thereafter are ignored for that execution. The updates will be reflected from the next execution. Rules defined in the datascan must be empty if this field is enabled.

#enable_catalog_based_rules=

def enable_catalog_based_rules=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If enabled, the data scan will retrieve rules defined in the dataplex-types.global.data-rules aspect on all paths of the catalog entry corresponding to the BigQuery table resource and all attached glossary terms. The path that data-rules aspect is attached on the table entry defines the column that the rule will be evaluated against. For glossary terms, the path that the terms are attached on the table entry defines the column that the rule will be evaluated against. At the start of scan execution, the rules reflect the latest state retrieved from the catalog entry and any updates on the rules thereafter are ignored for that execution. The updates will be reflected from the next execution. Rules defined in the datascan must be empty if this field is enabled.
Returns
  • (::Boolean) — Optional. If enabled, the data scan will retrieve rules defined in the dataplex-types.global.data-rules aspect on all paths of the catalog entry corresponding to the BigQuery table resource and all attached glossary terms. The path that data-rules aspect is attached on the table entry defines the column that the rule will be evaluated against. For glossary terms, the path that the terms are attached on the table entry defines the column that the rule will be evaluated against. At the start of scan execution, the rules reflect the latest state retrieved from the catalog entry and any updates on the rules thereafter are ignored for that execution. The updates will be reflected from the next execution. Rules defined in the datascan must be empty if this field is enabled.

#filter

def filter() -> ::String
Returns
  • (::String) — Optional. Filter for selectively running a subset of rules. You can filter the request by the name or attribute key-value pairs defined on the rule. If not specified, all rules are run. The filter is applicable to both, the rules retrieved from catalog and explicitly defined rules in the scan. Please see filter syntax for more details.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Optional. Filter for selectively running a subset of rules. You can filter the request by the name or attribute key-value pairs defined on the rule. If not specified, all rules are run. The filter is applicable to both, the rules retrieved from catalog and explicitly defined rules in the scan. Please see filter syntax for more details.
Returns
  • (::String) — Optional. Filter for selectively running a subset of rules. You can filter the request by the name or attribute key-value pairs defined on the rule. If not specified, all rules are run. The filter is applicable to both, the rules retrieved from catalog and explicitly defined rules in the scan. Please see filter syntax for more details.

#post_scan_actions

def post_scan_actions() -> ::Google::Cloud::Dataplex::V1::DataQualitySpec::PostScanActions
Returns

#post_scan_actions=

def post_scan_actions=(value) -> ::Google::Cloud::Dataplex::V1::DataQualitySpec::PostScanActions
Parameter
Returns

#row_filter

def row_filter() -> ::String
Returns
  • (::String) — Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax.

    Example: col1 >= 0 AND col2 < 10

#row_filter=

def row_filter=(value) -> ::String
Parameter
  • value (::String) — Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax.

    Example: col1 >= 0 AND col2 < 10

Returns
  • (::String) — Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax.

    Example: col1 >= 0 AND col2 < 10

#rules

def rules() -> ::Array<::Google::Cloud::Dataplex::V1::DataQualityRule>
Returns

#rules=

def rules=(value) -> ::Array<::Google::Cloud::Dataplex::V1::DataQualityRule>
Parameter
Returns

#sampling_percent

def sampling_percent() -> ::Float
Returns
  • (::Float) —

    Optional. The percentage of the records to be selected from the dataset for DataScan.

    • Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.
    • Sampling is not applied if sampling_percent is not specified, 0 or 100.

#sampling_percent=

def sampling_percent=(value) -> ::Float
Parameter
  • value (::Float) —

    Optional. The percentage of the records to be selected from the dataset for DataScan.

    • Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.
    • Sampling is not applied if sampling_percent is not specified, 0 or 100.
Returns
  • (::Float) —

    Optional. The percentage of the records to be selected from the dataset for DataScan.

    • Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.
    • Sampling is not applied if sampling_percent is not specified, 0 or 100.