Cloud Dataplex v1 API - Class DataQualitySpec (3.15.0) 

public sealed class DataQualitySpec : IMessage<DataQualitySpec>, IEquatable<DataQualitySpec>, IDeepCloneable<DataQualitySpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Dataplex v1 API class DataQualitySpec.

DataQualityScan related setting.

Inheritance

object > DataQualitySpec

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

DataQualitySpec()

public DataQualitySpec()

DataQualitySpec(DataQualitySpec)

public DataQualitySpec(DataQualitySpec other)
Parameter
Name Description
other DataQualitySpec

Properties

CatalogPublishingEnabled

public bool CatalogPublishingEnabled { get; set; }

Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata.

Property Value
Type Description
bool

EnableCatalogBasedRules

public bool EnableCatalogBasedRules { get; set; }

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.

Property Value
Type Description
bool

Filter

public string Filter { get; set; }

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.

Property Value
Type Description
string

PostScanActions

public DataQualitySpec.Types.PostScanActions PostScanActions { get; set; }

Optional. Actions to take upon job completion.

Property Value
Type Description
DataQualitySpecTypesPostScanActions

RowFilter

public string RowFilter { get; set; }

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

Property Value
Type Description
string

Rules

public RepeatedField<DataQualityRule> Rules { get; }

Required. The list of rules to evaluate against a data source. At least one rule is required.

Property Value
Type Description
RepeatedFieldDataQualityRule

SamplingPercent

public float SamplingPercent { get; set; }

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.
Property Value
Type Description
float