Class DataQualityRuleTemplate.Builder (1.91.0)

public static final class DataQualityRuleTemplate.Builder extends GeneratedMessage.Builder<DataQualityRuleTemplate.Builder> implements DataQualityRuleTemplateOrBuilder

DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules.

Protobuf type google.cloud.dataplex.v1.DataQualityRuleTemplate

Static Methods

getDescriptor()

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

Methods

addAllCapabilities(Iterable<String> values)

public DataQualityRuleTemplate.Builder addAllCapabilities(Iterable<String> values)

Output only. A list of features or properties supported by this rule template.

repeated string capabilities = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<String>

The capabilities to add.

Returns
Type Description
DataQualityRuleTemplate.Builder

This builder for chaining.

addAllSqlCollection(Iterable<? extends DataQualityRuleTemplate.Sql> values)

public DataQualityRuleTemplate.Builder addAllSqlCollection(Iterable<? extends DataQualityRuleTemplate.Sql> values)

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql>
Returns
Type Description
DataQualityRuleTemplate.Builder

addCapabilities(String value)

public DataQualityRuleTemplate.Builder addCapabilities(String value)

Output only. A list of features or properties supported by this rule template.

repeated string capabilities = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The capabilities to add.

Returns
Type Description
DataQualityRuleTemplate.Builder

This builder for chaining.

addCapabilitiesBytes(ByteString value)

public DataQualityRuleTemplate.Builder addCapabilitiesBytes(ByteString value)

Output only. A list of features or properties supported by this rule template.

repeated string capabilities = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes of the capabilities to add.

Returns
Type Description
DataQualityRuleTemplate.Builder

This builder for chaining.

addSqlCollection(DataQualityRuleTemplate.Sql value)

public DataQualityRuleTemplate.Builder addSqlCollection(DataQualityRuleTemplate.Sql value)

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value DataQualityRuleTemplate.Sql
Returns
Type Description
DataQualityRuleTemplate.Builder

addSqlCollection(DataQualityRuleTemplate.Sql.Builder builderForValue)

public DataQualityRuleTemplate.Builder addSqlCollection(DataQualityRuleTemplate.Sql.Builder builderForValue)

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue DataQualityRuleTemplate.Sql.Builder
Returns
Type Description
DataQualityRuleTemplate.Builder

addSqlCollection(int index, DataQualityRuleTemplate.Sql value)

public DataQualityRuleTemplate.Builder addSqlCollection(int index, DataQualityRuleTemplate.Sql value)

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value DataQualityRuleTemplate.Sql
Returns
Type Description
DataQualityRuleTemplate.Builder

addSqlCollection(int index, DataQualityRuleTemplate.Sql.Builder builderForValue)

public DataQualityRuleTemplate.Builder addSqlCollection(int index, DataQualityRuleTemplate.Sql.Builder builderForValue)

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue DataQualityRuleTemplate.Sql.Builder
Returns
Type Description
DataQualityRuleTemplate.Builder

addSqlCollectionBuilder()

public DataQualityRuleTemplate.Sql.Builder addSqlCollectionBuilder()

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleTemplate.Sql.Builder

addSqlCollectionBuilder(int index)

public DataQualityRuleTemplate.Sql.Builder addSqlCollectionBuilder(int index)

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DataQualityRuleTemplate.Sql.Builder

build()

public DataQualityRuleTemplate build()
Returns
Type Description
DataQualityRuleTemplate

buildPartial()

public DataQualityRuleTemplate buildPartial()
Returns
Type Description
DataQualityRuleTemplate

clear()

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

clearCapabilities()

public DataQualityRuleTemplate.Builder clearCapabilities()

Output only. A list of features or properties supported by this rule template.

repeated string capabilities = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleTemplate.Builder

This builder for chaining.

clearDimension()

public DataQualityRuleTemplate.Builder clearDimension()

Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level.

string dimension = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleTemplate.Builder

This builder for chaining.

clearInputParameters()

public DataQualityRuleTemplate.Builder clearInputParameters()
Returns
Type Description
DataQualityRuleTemplate.Builder

clearName()

public DataQualityRuleTemplate.Builder clearName()

Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleTemplate.Builder

This builder for chaining.

clearSqlCollection()

public DataQualityRuleTemplate.Builder clearSqlCollection()

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleTemplate.Builder

containsInputParameters(String key)

public boolean containsInputParameters(String key)

Output only. Description for input parameters

map<string, .google.cloud.dataplex.v1.DataQualityRuleTemplate.ParameterDescription> input_parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
boolean

getCapabilities(int index)

public String getCapabilities(int index)

Output only. A list of features or properties supported by this rule template.

repeated string capabilities = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The capabilities at the given index.

getCapabilitiesBytes(int index)

public ByteString getCapabilitiesBytes(int index)

Output only. A list of features or properties supported by this rule template.

repeated string capabilities = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the capabilities at the given index.

getCapabilitiesCount()

public int getCapabilitiesCount()

Output only. A list of features or properties supported by this rule template.

repeated string capabilities = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of capabilities.

getCapabilitiesList()

public ProtocolStringList getCapabilitiesList()

Output only. A list of features or properties supported by this rule template.

repeated string capabilities = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the capabilities.

getDefaultInstanceForType()

public DataQualityRuleTemplate getDefaultInstanceForType()
Returns
Type Description
DataQualityRuleTemplate

getDescriptorForType()

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

getDimension()

public String getDimension()

Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level.

string dimension = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The dimension.

getDimensionBytes()

public ByteString getDimensionBytes()

Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level.

string dimension = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for dimension.

getInputParameters() (deprecated)

public Map<String,DataQualityRuleTemplate.ParameterDescription> getInputParameters()
Returns
Type Description
Map<String,ParameterDescription>

getInputParametersCount()

public int getInputParametersCount()

Output only. Description for input parameters

map<string, .google.cloud.dataplex.v1.DataQualityRuleTemplate.ParameterDescription> input_parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getInputParametersMap()

public Map<String,DataQualityRuleTemplate.ParameterDescription> getInputParametersMap()

Output only. Description for input parameters

map<string, .google.cloud.dataplex.v1.DataQualityRuleTemplate.ParameterDescription> input_parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Map<String,ParameterDescription>

getInputParametersOrDefault(String key, DataQualityRuleTemplate.ParameterDescription defaultValue)

public DataQualityRuleTemplate.ParameterDescription getInputParametersOrDefault(String key, DataQualityRuleTemplate.ParameterDescription defaultValue)

Output only. Description for input parameters

map<string, .google.cloud.dataplex.v1.DataQualityRuleTemplate.ParameterDescription> input_parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
key String
defaultValue DataQualityRuleTemplate.ParameterDescription
Returns
Type Description
DataQualityRuleTemplate.ParameterDescription

getInputParametersOrThrow(String key)

public DataQualityRuleTemplate.ParameterDescription getInputParametersOrThrow(String key)

Output only. Description for input parameters

map<string, .google.cloud.dataplex.v1.DataQualityRuleTemplate.ParameterDescription> input_parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
DataQualityRuleTemplate.ParameterDescription

getMutableInputParameters() (deprecated)

public Map<String,DataQualityRuleTemplate.ParameterDescription> getMutableInputParameters()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,ParameterDescription>

getName()

public String getName()

Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getSqlCollection(int index)

public DataQualityRuleTemplate.Sql getSqlCollection(int index)

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DataQualityRuleTemplate.Sql

getSqlCollectionBuilder(int index)

public DataQualityRuleTemplate.Sql.Builder getSqlCollectionBuilder(int index)

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DataQualityRuleTemplate.Sql.Builder

getSqlCollectionBuilderList()

public List<DataQualityRuleTemplate.Sql.Builder> getSqlCollectionBuilderList()

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getSqlCollectionCount()

public int getSqlCollectionCount()

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getSqlCollectionList()

public List<DataQualityRuleTemplate.Sql> getSqlCollectionList()

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Sql>

getSqlCollectionOrBuilder(int index)

public DataQualityRuleTemplate.SqlOrBuilder getSqlCollectionOrBuilder(int index)

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DataQualityRuleTemplate.SqlOrBuilder

getSqlCollectionOrBuilderList()

public List<? extends DataQualityRuleTemplate.SqlOrBuilder> getSqlCollectionOrBuilderList()

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.dataplex.v1.DataQualityRuleTemplate.SqlOrBuilder>

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DataQualityRuleTemplate other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

putAllInputParameters(Map<String,DataQualityRuleTemplate.ParameterDescription> values)

public DataQualityRuleTemplate.Builder putAllInputParameters(Map<String,DataQualityRuleTemplate.ParameterDescription> values)

Output only. Description for input parameters

map<string, .google.cloud.dataplex.v1.DataQualityRuleTemplate.ParameterDescription> input_parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Map<String,ParameterDescription>
Returns
Type Description
DataQualityRuleTemplate.Builder

putInputParameters(String key, DataQualityRuleTemplate.ParameterDescription value)

public DataQualityRuleTemplate.Builder putInputParameters(String key, DataQualityRuleTemplate.ParameterDescription value)

Output only. Description for input parameters

map<string, .google.cloud.dataplex.v1.DataQualityRuleTemplate.ParameterDescription> input_parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
key String
value DataQualityRuleTemplate.ParameterDescription
Returns
Type Description
DataQualityRuleTemplate.Builder

putInputParametersBuilderIfAbsent(String key)

public DataQualityRuleTemplate.ParameterDescription.Builder putInputParametersBuilderIfAbsent(String key)

Output only. Description for input parameters

map<string, .google.cloud.dataplex.v1.DataQualityRuleTemplate.ParameterDescription> input_parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
DataQualityRuleTemplate.ParameterDescription.Builder

removeInputParameters(String key)

public DataQualityRuleTemplate.Builder removeInputParameters(String key)

Output only. Description for input parameters

map<string, .google.cloud.dataplex.v1.DataQualityRuleTemplate.ParameterDescription> input_parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
DataQualityRuleTemplate.Builder

removeSqlCollection(int index)

public DataQualityRuleTemplate.Builder removeSqlCollection(int index)

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DataQualityRuleTemplate.Builder

setCapabilities(int index, String value)

public DataQualityRuleTemplate.Builder setCapabilities(int index, String value)

Output only. A list of features or properties supported by this rule template.

repeated string capabilities = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int

The index to set the value at.

value String

The capabilities to set.

Returns
Type Description
DataQualityRuleTemplate.Builder

This builder for chaining.

setDimension(String value)

public DataQualityRuleTemplate.Builder setDimension(String value)

Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level.

string dimension = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The dimension to set.

Returns
Type Description
DataQualityRuleTemplate.Builder

This builder for chaining.

setDimensionBytes(ByteString value)

public DataQualityRuleTemplate.Builder setDimensionBytes(ByteString value)

Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level.

string dimension = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for dimension to set.

Returns
Type Description
DataQualityRuleTemplate.Builder

This builder for chaining.

setName(String value)

public DataQualityRuleTemplate.Builder setName(String value)

Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DataQualityRuleTemplate.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DataQualityRuleTemplate.Builder setNameBytes(ByteString value)

Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DataQualityRuleTemplate.Builder

This builder for chaining.

setSqlCollection(int index, DataQualityRuleTemplate.Sql value)

public DataQualityRuleTemplate.Builder setSqlCollection(int index, DataQualityRuleTemplate.Sql value)

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value DataQualityRuleTemplate.Sql
Returns
Type Description
DataQualityRuleTemplate.Builder

setSqlCollection(int index, DataQualityRuleTemplate.Sql.Builder builderForValue)

public DataQualityRuleTemplate.Builder setSqlCollection(int index, DataQualityRuleTemplate.Sql.Builder builderForValue)

Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.

repeated .google.cloud.dataplex.v1.DataQualityRuleTemplate.Sql sql_collection = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue DataQualityRuleTemplate.Sql.Builder
Returns
Type Description
DataQualityRuleTemplate.Builder