Class DataQualityRule.DebugQuery.Builder (1.86.0)

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

getDescriptor()

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

Methods

build()

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

buildPartial()

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

clear()

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

clearDescription()

public DataQualityRule.DebugQuery.Builder clearDescription()

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
DataQualityRule.DebugQuery.Builder

This builder for chaining.

clearSqlStatement()

public DataQualityRule.DebugQuery.Builder clearSqlStatement()

Required. Specifies the SQL statement to be executed.

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

Returns
Type Description
DataQualityRule.DebugQuery.Builder

This builder for chaining.

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DataQualityRule.DebugQuery other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setDescription(String value)

public DataQualityRule.DebugQuery.Builder setDescription(String value)

Optional. Specifies the description of the debug query.

  • The maximum length is 1,024 characters.

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

Parameter
Name Description
value String

The description to set.

Returns
Type Description
DataQualityRule.DebugQuery.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public DataQualityRule.DebugQuery.Builder setDescriptionBytes(ByteString value)

Optional. Specifies the description of the debug query.

  • The maximum length is 1,024 characters.

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

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
DataQualityRule.DebugQuery.Builder

This builder for chaining.

setSqlStatement(String value)

public DataQualityRule.DebugQuery.Builder setSqlStatement(String value)

Required. Specifies the SQL statement to be executed.

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

Parameter
Name Description
value String

The sqlStatement to set.

Returns
Type Description
DataQualityRule.DebugQuery.Builder

This builder for chaining.

setSqlStatementBytes(ByteString value)

public DataQualityRule.DebugQuery.Builder setSqlStatementBytes(ByteString value)

Required. Specifies the SQL statement to be executed.

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

Parameter
Name Description
value ByteString

The bytes for sqlStatement to set.

Returns
Type Description
DataQualityRule.DebugQuery.Builder

This builder for chaining.