Class DataQualitySpec.Builder (1.40.0)

public static final class DataQualitySpec.Builder extends GeneratedMessageV3.Builder<DataQualitySpec.Builder> implements DataQualitySpecOrBuilder

DataQualityScan related setting.

Protobuf type google.cloud.dataplex.v1.DataQualitySpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllRules(Iterable<? extends DataQualityRule> values)

public DataQualitySpec.Builder addAllRules(Iterable<? extends DataQualityRule> values)

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
values Iterable<? extends com.google.cloud.dataplex.v1.DataQualityRule>
Returns
Type Description
DataQualitySpec.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DataQualitySpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DataQualitySpec.Builder
Overrides

addRules(DataQualityRule value)

public DataQualitySpec.Builder addRules(DataQualityRule value)

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
value DataQualityRule
Returns
Type Description
DataQualitySpec.Builder

addRules(DataQualityRule.Builder builderForValue)

public DataQualitySpec.Builder addRules(DataQualityRule.Builder builderForValue)

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
builderForValue DataQualityRule.Builder
Returns
Type Description
DataQualitySpec.Builder

addRules(int index, DataQualityRule value)

public DataQualitySpec.Builder addRules(int index, DataQualityRule value)

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];

Parameters
Name Description
index int
value DataQualityRule
Returns
Type Description
DataQualitySpec.Builder

addRules(int index, DataQualityRule.Builder builderForValue)

public DataQualitySpec.Builder addRules(int index, DataQualityRule.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue DataQualityRule.Builder
Returns
Type Description
DataQualitySpec.Builder

addRulesBuilder()

public DataQualityRule.Builder addRulesBuilder()

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
DataQualityRule.Builder

addRulesBuilder(int index)

public DataQualityRule.Builder addRulesBuilder(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.Builder

build()

public DataQualitySpec build()
Returns
Type Description
DataQualitySpec

buildPartial()

public DataQualitySpec buildPartial()
Returns
Type Description
DataQualitySpec

clear()

public DataQualitySpec.Builder clear()
Returns
Type Description
DataQualitySpec.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public DataQualitySpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DataQualitySpec.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public DataQualitySpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DataQualitySpec.Builder
Overrides

clearPostScanActions()

public DataQualitySpec.Builder clearPostScanActions()

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.Builder

clearRowFilter()

public DataQualitySpec.Builder clearRowFilter()

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 BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10

string row_filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataQualitySpec.Builder

This builder for chaining.

clearRules()

public DataQualitySpec.Builder clearRules()

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
DataQualitySpec.Builder

clearSamplingPercent()

public DataQualitySpec.Builder clearSamplingPercent()

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.

float sampling_percent = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataQualitySpec.Builder

This builder for chaining.

clone()

public DataQualitySpec.Builder clone()
Returns
Type Description
DataQualitySpec.Builder
Overrides

getDefaultInstanceForType()

public DataQualitySpec getDefaultInstanceForType()
Returns
Type Description
DataQualitySpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPostScanActions()

public 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.

getPostScanActionsBuilder()

public DataQualitySpec.PostScanActions.Builder getPostScanActionsBuilder()

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.Builder

getPostScanActionsOrBuilder()

public 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 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 BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10

string row_filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The rowFilter.

getRowFilterBytes()

public 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 BigQuery standard SQL 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 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

getRulesBuilder(int index)

public DataQualityRule.Builder getRulesBuilder(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.Builder

getRulesBuilderList()

public List<DataQualityRule.Builder> getRulesBuilderList()

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<Builder>

getRulesCount()

public 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 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 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 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 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_percent is not specified, 0 or 100.

float sampling_percent = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
float

The samplingPercent.

hasPostScanActions()

public 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DataQualitySpec other)

public DataQualitySpec.Builder mergeFrom(DataQualitySpec other)
Parameter
Name Description
other DataQualitySpec
Returns
Type Description
DataQualitySpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataQualitySpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataQualitySpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DataQualitySpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DataQualitySpec.Builder
Overrides

mergePostScanActions(DataQualitySpec.PostScanActions value)

public DataQualitySpec.Builder mergePostScanActions(DataQualitySpec.PostScanActions value)

Optional. Actions to take upon job completion.

.google.cloud.dataplex.v1.DataQualitySpec.PostScanActions post_scan_actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataQualitySpec.PostScanActions
Returns
Type Description
DataQualitySpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DataQualitySpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DataQualitySpec.Builder
Overrides

removeRules(int index)

public DataQualitySpec.Builder removeRules(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
DataQualitySpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public DataQualitySpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DataQualitySpec.Builder
Overrides

setPostScanActions(DataQualitySpec.PostScanActions value)

public DataQualitySpec.Builder setPostScanActions(DataQualitySpec.PostScanActions value)

Optional. Actions to take upon job completion.

.google.cloud.dataplex.v1.DataQualitySpec.PostScanActions post_scan_actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataQualitySpec.PostScanActions
Returns
Type Description
DataQualitySpec.Builder

setPostScanActions(DataQualitySpec.PostScanActions.Builder builderForValue)

public DataQualitySpec.Builder setPostScanActions(DataQualitySpec.PostScanActions.Builder builderForValue)

Optional. Actions to take upon job completion.

.google.cloud.dataplex.v1.DataQualitySpec.PostScanActions post_scan_actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DataQualitySpec.PostScanActions.Builder
Returns
Type Description
DataQualitySpec.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DataQualitySpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DataQualitySpec.Builder
Overrides

setRowFilter(String value)

public DataQualitySpec.Builder setRowFilter(String value)

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 BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10

string row_filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The rowFilter to set.

Returns
Type Description
DataQualitySpec.Builder

This builder for chaining.

setRowFilterBytes(ByteString value)

public DataQualitySpec.Builder setRowFilterBytes(ByteString value)

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 BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10

string row_filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for rowFilter to set.

Returns
Type Description
DataQualitySpec.Builder

This builder for chaining.

setRules(int index, DataQualityRule value)

public DataQualitySpec.Builder setRules(int index, DataQualityRule value)

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];

Parameters
Name Description
index int
value DataQualityRule
Returns
Type Description
DataQualitySpec.Builder

setRules(int index, DataQualityRule.Builder builderForValue)

public DataQualitySpec.Builder setRules(int index, DataQualityRule.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue DataQualityRule.Builder
Returns
Type Description
DataQualitySpec.Builder

setSamplingPercent(float value)

public DataQualitySpec.Builder setSamplingPercent(float value)

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.

float sampling_percent = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value float

The samplingPercent to set.

Returns
Type Description
DataQualitySpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DataQualitySpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DataQualitySpec.Builder
Overrides