public interface DataQualitySpecOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCatalogPublishingEnabled()
public abstract boolean getCatalogPublishingEnabled()Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata.
bool catalog_publishing_enabled = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The catalogPublishingEnabled. |
getEnableCatalogBasedRules()
public abstract boolean getEnableCatalogBasedRules()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.
bool enable_catalog_based_rules = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The enableCatalogBasedRules. |
getFilter()
public abstract String getFilter()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.
string filter = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes()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.
string filter = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getPostScanActions()
public abstract DataQualitySpec.PostScanActions getPostScanActions()Optional. Actions to take upon job completion.
.google.cloud.dataplex.v1.DataQualitySpec.PostScanActions post_scan_actions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataQualitySpec.PostScanActions |
The postScanActions. |
getPostScanActionsOrBuilder()
public abstract DataQualitySpec.PostScanActionsOrBuilder getPostScanActionsOrBuilder()Optional. Actions to take upon job completion.
.google.cloud.dataplex.v1.DataQualitySpec.PostScanActions post_scan_actions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataQualitySpec.PostScanActionsOrBuilder |
|
getRowFilter()
public abstract String getRowFilter()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
string row_filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The rowFilter. |
getRowFilterBytes()
public abstract ByteString getRowFilterBytes()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
string row_filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for rowFilter. |
getRules(int index)
public abstract DataQualityRule getRules(int index)Required. The list of rules to evaluate against a data source. At least one rule is required.
repeated .google.cloud.dataplex.v1.DataQualityRule rules = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
DataQualityRule |
|
getRulesCount()
public abstract int getRulesCount()Required. The list of rules to evaluate against a data source. At least one rule is required.
repeated .google.cloud.dataplex.v1.DataQualityRule rules = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
|
getRulesList()
public abstract List<DataQualityRule> getRulesList()Required. The list of rules to evaluate against a data source. At least one rule is required.
repeated .google.cloud.dataplex.v1.DataQualityRule rules = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<DataQualityRule> |
|
getRulesOrBuilder(int index)
public abstract DataQualityRuleOrBuilder getRulesOrBuilder(int index)Required. The list of rules to evaluate against a data source. At least one rule is required.
repeated .google.cloud.dataplex.v1.DataQualityRule rules = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
DataQualityRuleOrBuilder |
|
getRulesOrBuilderList()
public abstract List<? extends DataQualityRuleOrBuilder> getRulesOrBuilderList()Required. The list of rules to evaluate against a data source. At least one rule is required.
repeated .google.cloud.dataplex.v1.DataQualityRule rules = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.dataplex.v1.DataQualityRuleOrBuilder> |
|
getSamplingPercent()
public abstract float getSamplingPercent()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_percentis not specified, 0 or 100.
float sampling_percent = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
float |
The samplingPercent. |
hasPostScanActions()
public abstract boolean hasPostScanActions()Optional. Actions to take upon job completion.
.google.cloud.dataplex.v1.DataQualitySpec.PostScanActions post_scan_actions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the postScanActions field is set. |