Class DataProfileSpec (1.43.0)

public final class DataProfileSpec extends GeneratedMessageV3 implements DataProfileSpecOrBuilder

DataProfileScan related setting.

Protobuf type google.cloud.dataplex.v1.DataProfileSpec

Static Fields

EXCLUDE_FIELDS_FIELD_NUMBER

public static final int EXCLUDE_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

INCLUDE_FIELDS_FIELD_NUMBER

public static final int INCLUDE_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

POST_SCAN_ACTIONS_FIELD_NUMBER

public static final int POST_SCAN_ACTIONS_FIELD_NUMBER
Field Value
Type Description
int

ROW_FILTER_FIELD_NUMBER

public static final int ROW_FILTER_FIELD_NUMBER
Field Value
Type Description
int

SAMPLING_PERCENT_FIELD_NUMBER

public static final int SAMPLING_PERCENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DataProfileSpec getDefaultInstance()
Returns
Type Description
DataProfileSpec

getDescriptor()

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

newBuilder()

public static DataProfileSpec.Builder newBuilder()
Returns
Type Description
DataProfileSpec.Builder

newBuilder(DataProfileSpec prototype)

public static DataProfileSpec.Builder newBuilder(DataProfileSpec prototype)
Parameter
Name Description
prototype DataProfileSpec
Returns
Type Description
DataProfileSpec.Builder

parseDelimitedFrom(InputStream input)

public static DataProfileSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataProfileSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataProfileSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataProfileSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DataProfileSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DataProfileSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataProfileSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataProfileSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataProfileSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DataProfileSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataProfileSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataProfileSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataProfileSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DataProfileSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataProfileSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataProfileSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DataProfileSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataProfileSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataProfileSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataProfileSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DataProfileSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DataProfileSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataProfileSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataProfileSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DataProfileSpec> parser()
Returns
Type Description
Parser<DataProfileSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DataProfileSpec getDefaultInstanceForType()
Returns
Type Description
DataProfileSpec

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.

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.

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

getParserForType()

public Parser<DataProfileSpec> getParserForType()
Returns
Type Description
Parser<DataProfileSpec>
Overrides

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.

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DataProfileSpec.Builder newBuilderForType()
Returns
Type Description
DataProfileSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataProfileSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DataProfileSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DataProfileSpec.Builder toBuilder()
Returns
Type Description
DataProfileSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException