Package com.google.cloud.dataplex.v1

Class DataQualitySpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<DataQualitySpec.Builder>
com.google.cloud.dataplex.v1.DataQualitySpec.Builder
All Implemented Interfaces:
DataQualitySpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
DataQualitySpec
public static final class DataQualitySpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<DataQualitySpec.Builder> implements DataQualitySpecOrBuilder
 DataQualityScan related setting.
Protobuf type google.cloud.dataplex.v1.DataQualitySpec

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

    • clear

      public DataQualitySpec.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<DataQualitySpec.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<DataQualitySpec.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public DataQualitySpec.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<DataQualitySpec.Builder>

    • mergeFrom

      public DataQualitySpec.Builder mergeFrom(DataQualitySpec other)

    • isInitialized

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

    • mergeFrom

      public DataQualitySpec.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<DataQualitySpec.Builder>
      Throws:
      IOException

    • 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

    • 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

    • setRules

      public DataQualitySpec.Builder setRules(int index, DataQualityRule value)
       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];

    • setRules

      public DataQualitySpec.Builder setRules(int index, DataQualityRule.Builder builderForValue)
       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];

    • addRules

      public DataQualitySpec.Builder addRules(DataQualityRule value)
       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];

    • addRules

      public DataQualitySpec.Builder addRules(int index, DataQualityRule value)
       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];

    • addRules

      public DataQualitySpec.Builder addRules(DataQualityRule.Builder builderForValue)
       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];

    • addRules

      public DataQualitySpec.Builder addRules(int index, DataQualityRule.Builder builderForValue)
       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];

    • addAllRules

      public DataQualitySpec.Builder addAllRules(Iterable<? extends DataQualityRule> values)
       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];

    • clearRules

      public DataQualitySpec.Builder clearRules()
       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];

    • removeRules

      public DataQualitySpec.Builder removeRules(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];

    • getRulesBuilder

      public DataQualityRule.Builder getRulesBuilder(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];

    • 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

    • 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

    • addRulesBuilder

      public DataQualityRule.Builder addRulesBuilder()
       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];

    • addRulesBuilder

      public DataQualityRule.Builder addRulesBuilder(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];

    • getRulesBuilderList

      public List<DataQualityRule.Builder> getRulesBuilderList()
       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];

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

    • setSamplingPercent

      public DataQualitySpec.Builder setSamplingPercent(float value)
       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];
      Parameters:
      value - The samplingPercent to set.
      Returns:
      This builder for chaining.

    • clearSamplingPercent

      public DataQualitySpec.Builder clearSamplingPercent()
       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];
      Returns:
      This builder for chaining.

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

    • setRowFilter

      public DataQualitySpec.Builder setRowFilter(String value)
       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];
      Parameters:
      value - The rowFilter to set.
      Returns:
      This builder for chaining.

    • clearRowFilter

      public DataQualitySpec.Builder clearRowFilter()
       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];
      Returns:
      This builder for chaining.

    • setRowFilterBytes

      public DataQualitySpec.Builder setRowFilterBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for rowFilter to set.
      Returns:
      This builder for chaining.

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

    • setPostScanActions

      public DataQualitySpec.Builder setPostScanActions(DataQualitySpec.PostScanActions value)
       Optional. Actions to take upon job completion.
      .google.cloud.dataplex.v1.DataQualitySpec.PostScanActions post_scan_actions = 6 [(.google.api.field_behavior) = OPTIONAL];

    • setPostScanActions

      public DataQualitySpec.Builder setPostScanActions(DataQualitySpec.PostScanActions.Builder builderForValue)
       Optional. Actions to take upon job completion.
      .google.cloud.dataplex.v1.DataQualitySpec.PostScanActions post_scan_actions = 6 [(.google.api.field_behavior) = OPTIONAL];

    • mergePostScanActions

      public DataQualitySpec.Builder mergePostScanActions(DataQualitySpec.PostScanActions value)
       Optional. Actions to take upon job completion.
      .google.cloud.dataplex.v1.DataQualitySpec.PostScanActions post_scan_actions = 6 [(.google.api.field_behavior) = OPTIONAL];

    • clearPostScanActions

      public DataQualitySpec.Builder clearPostScanActions()
       Optional. Actions to take upon job completion.
      .google.cloud.dataplex.v1.DataQualitySpec.PostScanActions post_scan_actions = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getPostScanActionsBuilder

      public DataQualitySpec.PostScanActions.Builder getPostScanActionsBuilder()
       Optional. Actions to take upon job completion.
      .google.cloud.dataplex.v1.DataQualitySpec.PostScanActions post_scan_actions = 6 [(.google.api.field_behavior) = OPTIONAL];

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

    • setCatalogPublishingEnabled

      public DataQualitySpec.Builder setCatalogPublishingEnabled(boolean value)
       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];
      Parameters:
      value - The catalogPublishingEnabled to set.
      Returns:
      This builder for chaining.

    • clearCatalogPublishingEnabled

      public DataQualitySpec.Builder clearCatalogPublishingEnabled()
       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];
      Returns:
      This builder for chaining.