Class DataQualityRule.DebugQuery (1.86.0)

public static final class DataQualityRule.DebugQuery extends GeneratedMessage implements DataQualityRule.DebugQueryOrBuilder

Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.

The SQL statement must use GoogleSQL syntax, and must not contain any semicolons.

You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter.

You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases.

Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()}

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

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

SQL_STATEMENT_FIELD_NUMBER

public static final int SQL_STATEMENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(DataQualityRule.DebugQuery prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

getDescription()

public String getDescription()

Optional. Specifies the description of the debug query.

  • The maximum length is 1,024 characters.

string description = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Specifies the description of the debug query.

  • The maximum length is 1,024 characters.

string description = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSqlStatement()

public String getSqlStatement()

Required. Specifies the SQL statement to be executed.

string sql_statement = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The sqlStatement.

getSqlStatementBytes()

public ByteString getSqlStatementBytes()

Required. Specifies the SQL statement to be executed.

string sql_statement = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for sqlStatement.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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