Class DataQualityRule.DebugQuery.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<DataQualityRule.DebugQuery.Builder>
com.google.cloud.dataplex.v1.DataQualityRule.DebugQuery.Builder
All Implemented Interfaces:
DataQualityRule.DebugQueryOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
DataQualityRule.DebugQuery

public static final class DataQualityRule.DebugQuery.Builder extends com.google.protobuf.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](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-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](https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).

 You can also name results with an explicit alias using `[AS] alias`. For
 more information, see [BigQuery explicit
 aliases](https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).

 Example: `SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM
 ${data()}`
 
Protobuf type google.cloud.dataplex.v1.DataQualityRule.DebugQuery
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<DataQualityRule.DebugQuery.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<DataQualityRule.DebugQuery.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<DataQualityRule.DebugQuery.Builder>
    • getDefaultInstanceForType

      public DataQualityRule.DebugQuery getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public DataQualityRule.DebugQuery buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public DataQualityRule.DebugQuery.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DataQualityRule.DebugQuery.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<DataQualityRule.DebugQuery.Builder>
    • mergeFrom

      public DataQualityRule.DebugQuery.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DataQualityRule.DebugQuery.Builder>
      Throws:
      IOException
    • 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];
      Specified by:
      getDescription in interface DataQualityRule.DebugQueryOrBuilder
      Returns:
      The description.
    • getDescriptionBytes

      public com.google.protobuf.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];
      Specified by:
      getDescriptionBytes in interface DataQualityRule.DebugQueryOrBuilder
      Returns:
      The bytes for description.
    • setDescription

      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];
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.
    • 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:
      This builder for chaining.
    • setDescriptionBytes

      public DataQualityRule.DebugQuery.Builder setDescriptionBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.
    • getSqlStatement

      public String getSqlStatement()
       Required. Specifies the SQL statement to be executed.
       
      string sql_statement = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getSqlStatement in interface DataQualityRule.DebugQueryOrBuilder
      Returns:
      The sqlStatement.
    • getSqlStatementBytes

      public com.google.protobuf.ByteString getSqlStatementBytes()
       Required. Specifies the SQL statement to be executed.
       
      string sql_statement = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getSqlStatementBytes in interface DataQualityRule.DebugQueryOrBuilder
      Returns:
      The bytes for sqlStatement.
    • setSqlStatement

      public DataQualityRule.DebugQuery.Builder setSqlStatement(String value)
       Required. Specifies the SQL statement to be executed.
       
      string sql_statement = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The sqlStatement to set.
      Returns:
      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:
      This builder for chaining.
    • setSqlStatementBytes

      public DataQualityRule.DebugQuery.Builder setSqlStatementBytes(com.google.protobuf.ByteString value)
       Required. Specifies the SQL statement to be executed.
       
      string sql_statement = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for sqlStatement to set.
      Returns:
      This builder for chaining.