Class DataQualityRuleTemplate (1.91.0)

1.91.0 (latest) 1.89.0 1.86.0 1.85.0 1.83.0 1.81.0 1.80.0 1.79.0 1.78.0 1.76.0 1.74.0 1.73.0 1.72.0 1.71.0 1.70.0 1.68.0 1.66.0 1.65.0 1.62.0 1.61.0 1.60.0 1.58.0 1.57.0 1.56.0 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.0 1.12.0 1.11.0 1.10.0 1.9.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.2 1.0.1 0.2.2

public final class DataQualityRuleTemplate extends GeneratedMessage implements DataQualityRuleTemplateOrBuilder

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

Protobuf type google.cloud.dataplex.v1.DataQualityRuleTemplate

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > DataQualityRuleTemplate

Implements

DataQualityRuleTemplateOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CAPABILITIES_FIELD_NUMBER

public static final int CAPABILITIES_FIELD_NUMBER

Field Value
Type	Description
int

DIMENSION_FIELD_NUMBER

public static final int DIMENSION_FIELD_NUMBER

Field Value
Type	Description
int

INPUT_PARAMETERS_FIELD_NUMBER

public static final int INPUT_PARAMETERS_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

SQL_COLLECTION_FIELD_NUMBER

public static final int SQL_COLLECTION_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static DataQualityRuleTemplate getDefaultInstance()

Returns
Type	Description
DataQualityRuleTemplate

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static DataQualityRuleTemplate.Builder newBuilder()

Returns
Type	Description
DataQualityRuleTemplate.Builder

newBuilder(DataQualityRuleTemplate prototype)

public static DataQualityRuleTemplate.Builder newBuilder(DataQualityRuleTemplate prototype)

Parameter
Name	Description
prototype	DataQualityRuleTemplate

Returns
Type	Description
DataQualityRuleTemplate.Builder

parseDelimitedFrom(InputStream input)

public static DataQualityRuleTemplate parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DataQualityRuleTemplate

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataQualityRuleTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataQualityRuleTemplate

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static DataQualityRuleTemplate parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
DataQualityRuleTemplate

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataQualityRuleTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataQualityRuleTemplate

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataQualityRuleTemplate parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
DataQualityRuleTemplate

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataQualityRuleTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataQualityRuleTemplate

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataQualityRuleTemplate parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
DataQualityRuleTemplate

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataQualityRuleTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataQualityRuleTemplate

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static DataQualityRuleTemplate parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DataQualityRuleTemplate

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataQualityRuleTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataQualityRuleTemplate

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static DataQualityRuleTemplate parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
DataQualityRuleTemplate

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataQualityRuleTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataQualityRuleTemplate

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<DataQualityRuleTemplate> parser()

Returns
Type	Description
Parser<DataQualityRuleTemplate>

Methods

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

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

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()

Use #getInputParametersMap() instead.

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

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.

getParserForType()

public Parser<DataQualityRuleTemplate> getParserForType()

Returns
Type	Description
Parser<DataQualityRuleTemplate>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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

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>

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

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

GeneratedMessage.isInitialized()

newBuilderForType()

public DataQualityRuleTemplate.Builder newBuilderForType()

Returns
Type	Description
DataQualityRuleTemplate.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DataQualityRuleTemplate.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
DataQualityRuleTemplate.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public DataQualityRuleTemplate.Builder toBuilder()

Returns
Type	Description
DataQualityRuleTemplate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException