Class DataProfileSpec.Builder (1.46.0)

public static final class DataProfileSpec.Builder extends GeneratedMessageV3.Builder<DataProfileSpec.Builder> implements DataProfileSpecOrBuilder

DataProfileScan related setting.

Protobuf type google.cloud.dataplex.v1.DataProfileSpec

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public DataProfileSpec build()
Returns
Type Description
DataProfileSpec

buildPartial()

public DataProfileSpec buildPartial()
Returns
Type Description
DataProfileSpec

clear()

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

clearExcludeFields()

public DataProfileSpec.Builder clearExcludeFields()

Optional. The fields to exclude from data profile.

If specified, the fields will be excluded from data profile, regardless of include_fields value.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProfileSpec.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearIncludeFields()

public DataProfileSpec.Builder clearIncludeFields()

Optional. The fields to include in data profile.

If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProfileSpec.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPostScanActions()

public DataProfileSpec.Builder clearPostScanActions()

Optional. Actions to take upon job completion..

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

Returns
Type Description
DataProfileSpec.Builder

clearRowFilter()

public DataProfileSpec.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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProfileSpec.Builder

This builder for chaining.

clearSamplingPercent()

public DataProfileSpec.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 = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProfileSpec.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public DataProfileSpec getDefaultInstanceForType()
Returns
Type Description
DataProfileSpec

getDescriptorForType()

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

getExcludeFields()

public DataProfileSpec.SelectedFields getExcludeFields()

Optional. The fields to exclude from data profile.

If specified, the fields will be excluded from data profile, regardless of include_fields value.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProfileSpec.SelectedFields

The excludeFields.

getExcludeFieldsBuilder()

public DataProfileSpec.SelectedFields.Builder getExcludeFieldsBuilder()

Optional. The fields to exclude from data profile.

If specified, the fields will be excluded from data profile, regardless of include_fields value.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProfileSpec.SelectedFields.Builder

getExcludeFieldsOrBuilder()

public DataProfileSpec.SelectedFieldsOrBuilder getExcludeFieldsOrBuilder()

Optional. The fields to exclude from data profile.

If specified, the fields will be excluded from data profile, regardless of include_fields value.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProfileSpec.SelectedFieldsOrBuilder

getIncludeFields()

public DataProfileSpec.SelectedFields getIncludeFields()

Optional. The fields to include in data profile.

If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProfileSpec.SelectedFields

The includeFields.

getIncludeFieldsBuilder()

public DataProfileSpec.SelectedFields.Builder getIncludeFieldsBuilder()

Optional. The fields to include in data profile.

If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProfileSpec.SelectedFields.Builder

getIncludeFieldsOrBuilder()

public DataProfileSpec.SelectedFieldsOrBuilder getIncludeFieldsOrBuilder()

Optional. The fields to include in data profile.

If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataProfileSpec.SelectedFieldsOrBuilder

getPostScanActions()

public DataProfileSpec.PostScanActions getPostScanActions()

Optional. Actions to take upon job completion..

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

Returns
Type Description
DataProfileSpec.PostScanActions

The postScanActions.

getPostScanActionsBuilder()

public DataProfileSpec.PostScanActions.Builder getPostScanActionsBuilder()

Optional. Actions to take upon job completion..

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

Returns
Type Description
DataProfileSpec.PostScanActions.Builder

getPostScanActionsOrBuilder()

public DataProfileSpec.PostScanActionsOrBuilder getPostScanActionsOrBuilder()

Optional. Actions to take upon job completion..

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

Returns
Type Description
DataProfileSpec.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 = 3 [(.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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for rowFilter.

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 = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
float

The samplingPercent.

hasExcludeFields()

public boolean hasExcludeFields()

Optional. The fields to exclude from data profile.

If specified, the fields will be excluded from data profile, regardless of include_fields value.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the excludeFields field is set.

hasIncludeFields()

public boolean hasIncludeFields()

Optional. The fields to include in data profile.

If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the includeFields field is set.

hasPostScanActions()

public boolean hasPostScanActions()

Optional. Actions to take upon job completion..

.google.cloud.dataplex.v1.DataProfileSpec.PostScanActions post_scan_actions = 4 [(.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

mergeExcludeFields(DataProfileSpec.SelectedFields value)

public DataProfileSpec.Builder mergeExcludeFields(DataProfileSpec.SelectedFields value)

Optional. The fields to exclude from data profile.

If specified, the fields will be excluded from data profile, regardless of include_fields value.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataProfileSpec.SelectedFields
Returns
Type Description
DataProfileSpec.Builder

mergeFrom(DataProfileSpec other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeIncludeFields(DataProfileSpec.SelectedFields value)

public DataProfileSpec.Builder mergeIncludeFields(DataProfileSpec.SelectedFields value)

Optional. The fields to include in data profile.

If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataProfileSpec.SelectedFields
Returns
Type Description
DataProfileSpec.Builder

mergePostScanActions(DataProfileSpec.PostScanActions value)

public DataProfileSpec.Builder mergePostScanActions(DataProfileSpec.PostScanActions value)

Optional. Actions to take upon job completion..

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

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setExcludeFields(DataProfileSpec.SelectedFields value)

public DataProfileSpec.Builder setExcludeFields(DataProfileSpec.SelectedFields value)

Optional. The fields to exclude from data profile.

If specified, the fields will be excluded from data profile, regardless of include_fields value.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataProfileSpec.SelectedFields
Returns
Type Description
DataProfileSpec.Builder

setExcludeFields(DataProfileSpec.SelectedFields.Builder builderForValue)

public DataProfileSpec.Builder setExcludeFields(DataProfileSpec.SelectedFields.Builder builderForValue)

Optional. The fields to exclude from data profile.

If specified, the fields will be excluded from data profile, regardless of include_fields value.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DataProfileSpec.SelectedFields.Builder
Returns
Type Description
DataProfileSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setIncludeFields(DataProfileSpec.SelectedFields value)

public DataProfileSpec.Builder setIncludeFields(DataProfileSpec.SelectedFields value)

Optional. The fields to include in data profile.

If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataProfileSpec.SelectedFields
Returns
Type Description
DataProfileSpec.Builder

setIncludeFields(DataProfileSpec.SelectedFields.Builder builderForValue)

public DataProfileSpec.Builder setIncludeFields(DataProfileSpec.SelectedFields.Builder builderForValue)

Optional. The fields to include in data profile.

If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields.

.google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DataProfileSpec.SelectedFields.Builder
Returns
Type Description
DataProfileSpec.Builder

setPostScanActions(DataProfileSpec.PostScanActions value)

public DataProfileSpec.Builder setPostScanActions(DataProfileSpec.PostScanActions value)

Optional. Actions to take upon job completion..

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

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

setPostScanActions(DataProfileSpec.PostScanActions.Builder builderForValue)

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

Optional. Actions to take upon job completion..

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

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

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

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

setRowFilter(String value)

public DataProfileSpec.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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The rowFilter to set.

Returns
Type Description
DataProfileSpec.Builder

This builder for chaining.

setRowFilterBytes(ByteString value)

public DataProfileSpec.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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for rowFilter to set.

Returns
Type Description
DataProfileSpec.Builder

This builder for chaining.

setSamplingPercent(float value)

public DataProfileSpec.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 = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value float

The samplingPercent to set.

Returns
Type Description
DataProfileSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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