Class DataQualityRule.TemplateReference.Builder (1.91.0)

public static final class DataQualityRule.TemplateReference.Builder extends GeneratedMessage.Builder<DataQualityRule.TemplateReference.Builder> implements DataQualityRule.TemplateReferenceOrBuilder

A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails

Protobuf type google.cloud.dataplex.v1.DataQualityRule.TemplateReference

Static Methods

getDescriptor()

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

Methods

build()

public DataQualityRule.TemplateReference build()
Returns
Type Description
DataQualityRule.TemplateReference

buildPartial()

public DataQualityRule.TemplateReference buildPartial()
Returns
Type Description
DataQualityRule.TemplateReference

clear()

public DataQualityRule.TemplateReference.Builder clear()
Returns
Type Description
DataQualityRule.TemplateReference.Builder
Overrides

clearName()

public DataQualityRule.TemplateReference.Builder clearName()

Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
DataQualityRule.TemplateReference.Builder

This builder for chaining.

clearResolvedSql()

public DataQualityRule.TemplateReference.Builder clearResolvedSql()

Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result.

string resolved_sql = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRule.TemplateReference.Builder

This builder for chaining.

clearRuleTemplate()

public DataQualityRule.TemplateReference.Builder clearRuleTemplate()

Output only. The rule template used to resolve the rule. It is only populated in the result.

.google.cloud.dataplex.v1.DataQualityRuleTemplate rule_template = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRule.TemplateReference.Builder

clearValues()

public DataQualityRule.TemplateReference.Builder clearValues()
Returns
Type Description
DataQualityRule.TemplateReference.Builder

containsValues(String key)

public boolean containsValues(String key)

Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8).

map<string, .google.cloud.dataplex.v1.DataQualityRule.TemplateReference.ParameterValue> values = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public DataQualityRule.TemplateReference getDefaultInstanceForType()
Returns
Type Description
DataQualityRule.TemplateReference

getDescriptorForType()

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

getMutableValues() (deprecated)

public Map<String,DataQualityRule.TemplateReference.ParameterValue> getMutableValues()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,ParameterValue>

getName()

public String getName()

Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getResolvedSql()

public String getResolvedSql()

Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result.

string resolved_sql = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The resolvedSql.

getResolvedSqlBytes()

public ByteString getResolvedSqlBytes()

Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result.

string resolved_sql = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for resolvedSql.

getRuleTemplate()

public DataQualityRuleTemplate getRuleTemplate()

Output only. The rule template used to resolve the rule. It is only populated in the result.

.google.cloud.dataplex.v1.DataQualityRuleTemplate rule_template = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleTemplate

The ruleTemplate.

getRuleTemplateBuilder()

public DataQualityRuleTemplate.Builder getRuleTemplateBuilder()

Output only. The rule template used to resolve the rule. It is only populated in the result.

.google.cloud.dataplex.v1.DataQualityRuleTemplate rule_template = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleTemplate.Builder

getRuleTemplateOrBuilder()

public DataQualityRuleTemplateOrBuilder getRuleTemplateOrBuilder()

Output only. The rule template used to resolve the rule. It is only populated in the result.

.google.cloud.dataplex.v1.DataQualityRuleTemplate rule_template = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataQualityRuleTemplateOrBuilder

getValues() (deprecated)

public Map<String,DataQualityRule.TemplateReference.ParameterValue> getValues()

Use #getValuesMap() instead.

Returns
Type Description
Map<String,ParameterValue>

getValuesCount()

public int getValuesCount()

Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8).

map<string, .google.cloud.dataplex.v1.DataQualityRule.TemplateReference.ParameterValue> values = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getValuesMap()

public Map<String,DataQualityRule.TemplateReference.ParameterValue> getValuesMap()

Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8).

map<string, .google.cloud.dataplex.v1.DataQualityRule.TemplateReference.ParameterValue> values = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,ParameterValue>

getValuesOrDefault(String key, DataQualityRule.TemplateReference.ParameterValue defaultValue)

public DataQualityRule.TemplateReference.ParameterValue getValuesOrDefault(String key, DataQualityRule.TemplateReference.ParameterValue defaultValue)

Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8).

map<string, .google.cloud.dataplex.v1.DataQualityRule.TemplateReference.ParameterValue> values = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue DataQualityRule.TemplateReference.ParameterValue
Returns
Type Description
DataQualityRule.TemplateReference.ParameterValue

getValuesOrThrow(String key)

public DataQualityRule.TemplateReference.ParameterValue getValuesOrThrow(String key)

Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8).

map<string, .google.cloud.dataplex.v1.DataQualityRule.TemplateReference.ParameterValue> values = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
DataQualityRule.TemplateReference.ParameterValue

hasRuleTemplate()

public boolean hasRuleTemplate()

Output only. The rule template used to resolve the rule. It is only populated in the result.

.google.cloud.dataplex.v1.DataQualityRuleTemplate rule_template = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the ruleTemplate field is set.

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(DataQualityRule.TemplateReference other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeRuleTemplate(DataQualityRuleTemplate value)

public DataQualityRule.TemplateReference.Builder mergeRuleTemplate(DataQualityRuleTemplate value)

Output only. The rule template used to resolve the rule. It is only populated in the result.

.google.cloud.dataplex.v1.DataQualityRuleTemplate rule_template = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value DataQualityRuleTemplate
Returns
Type Description
DataQualityRule.TemplateReference.Builder

putAllValues(Map<String,DataQualityRule.TemplateReference.ParameterValue> values)

public DataQualityRule.TemplateReference.Builder putAllValues(Map<String,DataQualityRule.TemplateReference.ParameterValue> values)

Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8).

map<string, .google.cloud.dataplex.v1.DataQualityRule.TemplateReference.ParameterValue> values = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,ParameterValue>
Returns
Type Description
DataQualityRule.TemplateReference.Builder

putValues(String key, DataQualityRule.TemplateReference.ParameterValue value)

public DataQualityRule.TemplateReference.Builder putValues(String key, DataQualityRule.TemplateReference.ParameterValue value)

Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8).

map<string, .google.cloud.dataplex.v1.DataQualityRule.TemplateReference.ParameterValue> values = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value DataQualityRule.TemplateReference.ParameterValue
Returns
Type Description
DataQualityRule.TemplateReference.Builder

putValuesBuilderIfAbsent(String key)

public DataQualityRule.TemplateReference.ParameterValue.Builder putValuesBuilderIfAbsent(String key)

Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8).

map<string, .google.cloud.dataplex.v1.DataQualityRule.TemplateReference.ParameterValue> values = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
DataQualityRule.TemplateReference.ParameterValue.Builder

removeValues(String key)

public DataQualityRule.TemplateReference.Builder removeValues(String key)

Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8).

map<string, .google.cloud.dataplex.v1.DataQualityRule.TemplateReference.ParameterValue> values = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
DataQualityRule.TemplateReference.Builder

setName(String value)

public DataQualityRule.TemplateReference.Builder setName(String value)

Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DataQualityRule.TemplateReference.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DataQualityRule.TemplateReference.Builder setNameBytes(ByteString value)

Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DataQualityRule.TemplateReference.Builder

This builder for chaining.

setResolvedSql(String value)

public DataQualityRule.TemplateReference.Builder setResolvedSql(String value)

Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result.

string resolved_sql = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The resolvedSql to set.

Returns
Type Description
DataQualityRule.TemplateReference.Builder

This builder for chaining.

setResolvedSqlBytes(ByteString value)

public DataQualityRule.TemplateReference.Builder setResolvedSqlBytes(ByteString value)

Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result.

string resolved_sql = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for resolvedSql to set.

Returns
Type Description
DataQualityRule.TemplateReference.Builder

This builder for chaining.

setRuleTemplate(DataQualityRuleTemplate value)

public DataQualityRule.TemplateReference.Builder setRuleTemplate(DataQualityRuleTemplate value)

Output only. The rule template used to resolve the rule. It is only populated in the result.

.google.cloud.dataplex.v1.DataQualityRuleTemplate rule_template = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value DataQualityRuleTemplate
Returns
Type Description
DataQualityRule.TemplateReference.Builder

setRuleTemplate(DataQualityRuleTemplate.Builder builderForValue)

public DataQualityRule.TemplateReference.Builder setRuleTemplate(DataQualityRuleTemplate.Builder builderForValue)

Output only. The rule template used to resolve the rule. It is only populated in the result.

.google.cloud.dataplex.v1.DataQualityRuleTemplate rule_template = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue DataQualityRuleTemplate.Builder
Returns
Type Description
DataQualityRule.TemplateReference.Builder