Package com.google.cloud.dataplex.v1

Class DataQualitySpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.DataQualitySpec
All Implemented Interfaces:
DataQualitySpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DataQualitySpec extends com.google.protobuf.GeneratedMessage implements DataQualitySpecOrBuilder
 DataQualityScan related setting.
Protobuf type google.cloud.dataplex.v1.DataQualitySpec
See Also:

  • Field Details

    • RULES_FIELD_NUMBER

      public static final int RULES_FIELD_NUMBER
      See Also:

    • SAMPLING_PERCENT_FIELD_NUMBER

      public static final int SAMPLING_PERCENT_FIELD_NUMBER
      See Also:

    • ROW_FILTER_FIELD_NUMBER

      public static final int ROW_FILTER_FIELD_NUMBER
      See Also:

    • POST_SCAN_ACTIONS_FIELD_NUMBER

      public static final int POST_SCAN_ACTIONS_FIELD_NUMBER
      See Also:

    • CATALOG_PUBLISHING_ENABLED_FIELD_NUMBER

      public static final int CATALOG_PUBLISHING_ENABLED_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

    • getRulesList

      public List<DataQualityRule> getRulesList()
       Required. The list of rules to evaluate against a data source. At least one
 rule is required.
      repeated .google.cloud.dataplex.v1.DataQualityRule rules = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRulesList in interface DataQualitySpecOrBuilder

    • getRulesOrBuilderList

      public List<? extends DataQualityRuleOrBuilder> getRulesOrBuilderList()
       Required. The list of rules to evaluate against a data source. At least one
 rule is required.
      repeated .google.cloud.dataplex.v1.DataQualityRule rules = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRulesOrBuilderList in interface DataQualitySpecOrBuilder

    • getRulesCount

      public int getRulesCount()
       Required. The list of rules to evaluate against a data source. At least one
 rule is required.
      repeated .google.cloud.dataplex.v1.DataQualityRule rules = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRulesCount in interface DataQualitySpecOrBuilder

    • getRules

      public DataQualityRule getRules(int index)
       Required. The list of rules to evaluate against a data source. At least one
 rule is required.
      repeated .google.cloud.dataplex.v1.DataQualityRule rules = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRules in interface DataQualitySpecOrBuilder

    • getRulesOrBuilder

      public DataQualityRuleOrBuilder getRulesOrBuilder(int index)
       Required. The list of rules to evaluate against a data source. At least one
 rule is required.
      repeated .google.cloud.dataplex.v1.DataQualityRule rules = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRulesOrBuilder in interface DataQualitySpecOrBuilder

    • getSamplingPercent

      public float getSamplingPercent()
       Optional. The percentage of the records to be selected from the dataset for
 DataScan.

 * Value can range between 0.0 and 100.0 with up to 3 significant decimal
 digits.
 * Sampling is not applied if `sampling_percent` is not specified, 0 or
 100.
      float sampling_percent = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSamplingPercent in interface DataQualitySpecOrBuilder
      Returns:
      The samplingPercent.

    • getRowFilter

      public String getRowFilter()
       Optional. A filter applied to all rows in a single DataScan job.
 The filter needs to be a valid SQL expression for a [WHERE clause in
 GoogleSQL
 syntax](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).

 Example: col1 >= 0 AND col2 < 10
      string row_filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRowFilter in interface DataQualitySpecOrBuilder
      Returns:
      The rowFilter.

    • getRowFilterBytes

      public com.google.protobuf.ByteString getRowFilterBytes()
       Optional. A filter applied to all rows in a single DataScan job.
 The filter needs to be a valid SQL expression for a [WHERE clause in
 GoogleSQL
 syntax](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).

 Example: col1 >= 0 AND col2 < 10
      string row_filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRowFilterBytes in interface DataQualitySpecOrBuilder
      Returns:
      The bytes for rowFilter.

    • hasPostScanActions

      public boolean hasPostScanActions()
       Optional. Actions to take upon job completion.
      .google.cloud.dataplex.v1.DataQualitySpec.PostScanActions post_scan_actions = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasPostScanActions in interface DataQualitySpecOrBuilder
      Returns:
      Whether the postScanActions field is set.

    • getPostScanActions

      public DataQualitySpec.PostScanActions getPostScanActions()
       Optional. Actions to take upon job completion.
      .google.cloud.dataplex.v1.DataQualitySpec.PostScanActions post_scan_actions = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPostScanActions in interface DataQualitySpecOrBuilder
      Returns:
      The postScanActions.

    • getPostScanActionsOrBuilder

      public DataQualitySpec.PostScanActionsOrBuilder getPostScanActionsOrBuilder()
       Optional. Actions to take upon job completion.
      .google.cloud.dataplex.v1.DataQualitySpec.PostScanActions post_scan_actions = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPostScanActionsOrBuilder in interface DataQualitySpecOrBuilder

    • getCatalogPublishingEnabled

      public boolean getCatalogPublishingEnabled()
       Optional. If set, the latest DataScan job result will be published as
 Dataplex Universal Catalog metadata.
      bool catalog_publishing_enabled = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCatalogPublishingEnabled in interface DataQualitySpecOrBuilder
      Returns:
      The catalogPublishingEnabled.

    • 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 DataQualitySpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static DataQualitySpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static DataQualitySpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DataQualitySpec.Builder newBuilder()

    • newBuilder

      public static DataQualitySpec.Builder newBuilder(DataQualitySpec prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DataQualitySpec getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DataQualitySpec> 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 DataQualitySpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder