Package com.google.cloud.dataplex.v1

Class DataQualityRule.DebugQuery

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.DataQualityRule.DebugQuery
All Implemented Interfaces:
DataQualityRule.DebugQueryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
DataQualityRule
public static final class DataQualityRule.DebugQuery extends com.google.protobuf.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](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
See Also:

  • Field Details

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • SQL_STATEMENT_FIELD_NUMBER

      public static final int SQL_STATEMENT_FIELD_NUMBER
      See Also:

  • 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

    • 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.

    • 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.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static DataQualityRule.DebugQuery parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataQualityRule.DebugQuery parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataQualityRule.DebugQuery parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataQualityRule.DebugQuery parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataQualityRule.DebugQuery parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataQualityRule.DebugQuery parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataQualityRule.DebugQuery parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataQualityRule.DebugQuery parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataQualityRule.DebugQuery parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataQualityRule.DebugQuery parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataQualityRule.DebugQuery parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataQualityRule.DebugQuery parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static DataQualityRule.DebugQuery.Builder newBuilder()

    • newBuilder

      public static DataQualityRule.DebugQuery.Builder newBuilder(DataQualityRule.DebugQuery prototype)

    • toBuilder

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

    • newBuilderForType

      protected DataQualityRule.DebugQuery.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DataQualityRule.DebugQuery getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DataQualityRule.DebugQuery> parser()

    • getParserForType

      public com.google.protobuf.Parser<DataQualityRule.DebugQuery> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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