Class DataQualityRule.TemplateReference (1.91.0)

public static final class DataQualityRule.TemplateReference extends GeneratedMessage 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > DataQualityRule.TemplateReference

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RESOLVED_SQL_FIELD_NUMBER

public static final int RESOLVED_SQL_FIELD_NUMBER
Field Value
Type Description
int

RULE_TEMPLATE_FIELD_NUMBER

public static final int RULE_TEMPLATE_FIELD_NUMBER
Field Value
Type Description
int

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DataQualityRule.TemplateReference getDefaultInstance()
Returns
Type Description
DataQualityRule.TemplateReference

getDescriptor()

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

newBuilder()

public static DataQualityRule.TemplateReference.Builder newBuilder()
Returns
Type Description
DataQualityRule.TemplateReference.Builder

newBuilder(DataQualityRule.TemplateReference prototype)

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

parseDelimitedFrom(InputStream input)

public static DataQualityRule.TemplateReference parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataQualityRule.TemplateReference
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static DataQualityRule.TemplateReference parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DataQualityRule.TemplateReference
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static DataQualityRule.TemplateReference parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DataQualityRule.TemplateReference
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static DataQualityRule.TemplateReference parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataQualityRule.TemplateReference
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static DataQualityRule.TemplateReference parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DataQualityRule.TemplateReference
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<DataQualityRule.TemplateReference> parser()
Returns
Type Description
Parser<TemplateReference>

Methods

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

equals(Object obj)

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

getDefaultInstanceForType()

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

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.

getParserForType()

public Parser<DataQualityRule.TemplateReference> getParserForType()
Returns
Type Description
Parser<TemplateReference>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DataQualityRule.TemplateReference.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DataQualityRule.TemplateReference.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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