Class DataQualitySpec (1.51.0) 

public final class DataQualitySpec extends GeneratedMessageV3 implements DataQualitySpecOrBuilder

DataQualityScan related setting.

Protobuf type google.cloud.dataplex.v1.DataQualitySpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DataQualitySpec

Static Fields

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

RULES_FIELD_NUMBER

public static final int RULES_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 DataQualitySpec getDefaultInstance()
Returns
Type Description
DataQualitySpec

getDescriptor()

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

newBuilder()

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

newBuilder(DataQualitySpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public DataQualitySpec getDefaultInstanceForType()
Returns
Type Description
DataQualitySpec

getParserForType()

public Parser<DataQualitySpec> getParserForType()
Returns
Type Description
Parser<DataQualitySpec>
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.

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 DataQualitySpec.Builder newBuilderForType()
Returns
Type Description
DataQualitySpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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