Package com.google.cloud.dataplex.v1

Class DataProfileSpec.Builder

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

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public DataProfileSpec.Builder mergeFrom(DataProfileSpec other)

    • isInitialized

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

    • mergeFrom

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

    • 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 = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSamplingPercent in interface DataProfileSpecOrBuilder
      Returns:
      The samplingPercent.

    • setSamplingPercent

      public DataProfileSpec.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 = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The samplingPercent to set.
      Returns:
      This builder for chaining.

    • clearSamplingPercent

      public DataProfileSpec.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 = 2 [(.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
 BigQuery standard SQL syntax.
 Example: col1 >= 0 AND col2 < 10
      string row_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRowFilter in interface DataProfileSpecOrBuilder
      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
 BigQuery standard SQL syntax.
 Example: col1 >= 0 AND col2 < 10
      string row_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRowFilterBytes in interface DataProfileSpecOrBuilder
      Returns:
      The bytes for rowFilter.

    • setRowFilter

      public DataProfileSpec.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
 BigQuery standard SQL syntax.
 Example: col1 >= 0 AND col2 < 10
      string row_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The rowFilter to set.
      Returns:
      This builder for chaining.

    • clearRowFilter

      public DataProfileSpec.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
 BigQuery standard SQL syntax.
 Example: col1 >= 0 AND col2 < 10
      string row_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setRowFilterBytes

      public DataProfileSpec.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
 BigQuery standard SQL syntax.
 Example: col1 >= 0 AND col2 < 10
      string row_filter = 3 [(.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.DataProfileSpec.PostScanActions post_scan_actions = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasPostScanActions in interface DataProfileSpecOrBuilder
      Returns:
      Whether the postScanActions field is set.

    • getPostScanActions

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

    • setPostScanActions

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

    • setPostScanActions

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

    • mergePostScanActions

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

    • clearPostScanActions

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

    • getPostScanActionsBuilder

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

    • getPostScanActionsOrBuilder

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

    • hasIncludeFields

      public boolean hasIncludeFields()
       Optional. The fields to include in data profile.

 If not specified, all fields at the time of profile scan job execution are
 included, except for ones listed in `exclude_fields`.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasIncludeFields in interface DataProfileSpecOrBuilder
      Returns:
      Whether the includeFields field is set.

    • getIncludeFields

      public DataProfileSpec.SelectedFields getIncludeFields()
       Optional. The fields to include in data profile.

 If not specified, all fields at the time of profile scan job execution are
 included, except for ones listed in `exclude_fields`.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIncludeFields in interface DataProfileSpecOrBuilder
      Returns:
      The includeFields.

    • setIncludeFields

      public DataProfileSpec.Builder setIncludeFields(DataProfileSpec.SelectedFields value)
       Optional. The fields to include in data profile.

 If not specified, all fields at the time of profile scan job execution are
 included, except for ones listed in `exclude_fields`.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];

    • setIncludeFields

      public DataProfileSpec.Builder setIncludeFields(DataProfileSpec.SelectedFields.Builder builderForValue)
       Optional. The fields to include in data profile.

 If not specified, all fields at the time of profile scan job execution are
 included, except for ones listed in `exclude_fields`.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];

    • mergeIncludeFields

      public DataProfileSpec.Builder mergeIncludeFields(DataProfileSpec.SelectedFields value)
       Optional. The fields to include in data profile.

 If not specified, all fields at the time of profile scan job execution are
 included, except for ones listed in `exclude_fields`.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];

    • clearIncludeFields

      public DataProfileSpec.Builder clearIncludeFields()
       Optional. The fields to include in data profile.

 If not specified, all fields at the time of profile scan job execution are
 included, except for ones listed in `exclude_fields`.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getIncludeFieldsBuilder

      public DataProfileSpec.SelectedFields.Builder getIncludeFieldsBuilder()
       Optional. The fields to include in data profile.

 If not specified, all fields at the time of profile scan job execution are
 included, except for ones listed in `exclude_fields`.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getIncludeFieldsOrBuilder

      public DataProfileSpec.SelectedFieldsOrBuilder getIncludeFieldsOrBuilder()
       Optional. The fields to include in data profile.

 If not specified, all fields at the time of profile scan job execution are
 included, except for ones listed in `exclude_fields`.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields include_fields = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIncludeFieldsOrBuilder in interface DataProfileSpecOrBuilder

    • hasExcludeFields

      public boolean hasExcludeFields()
       Optional. The fields to exclude from data profile.

 If specified, the fields will be excluded from data profile, regardless of
 `include_fields` value.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasExcludeFields in interface DataProfileSpecOrBuilder
      Returns:
      Whether the excludeFields field is set.

    • getExcludeFields

      public DataProfileSpec.SelectedFields getExcludeFields()
       Optional. The fields to exclude from data profile.

 If specified, the fields will be excluded from data profile, regardless of
 `include_fields` value.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExcludeFields in interface DataProfileSpecOrBuilder
      Returns:
      The excludeFields.

    • setExcludeFields

      public DataProfileSpec.Builder setExcludeFields(DataProfileSpec.SelectedFields value)
       Optional. The fields to exclude from data profile.

 If specified, the fields will be excluded from data profile, regardless of
 `include_fields` value.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

    • setExcludeFields

      public DataProfileSpec.Builder setExcludeFields(DataProfileSpec.SelectedFields.Builder builderForValue)
       Optional. The fields to exclude from data profile.

 If specified, the fields will be excluded from data profile, regardless of
 `include_fields` value.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

    • mergeExcludeFields

      public DataProfileSpec.Builder mergeExcludeFields(DataProfileSpec.SelectedFields value)
       Optional. The fields to exclude from data profile.

 If specified, the fields will be excluded from data profile, regardless of
 `include_fields` value.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

    • clearExcludeFields

      public DataProfileSpec.Builder clearExcludeFields()
       Optional. The fields to exclude from data profile.

 If specified, the fields will be excluded from data profile, regardless of
 `include_fields` value.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getExcludeFieldsBuilder

      public DataProfileSpec.SelectedFields.Builder getExcludeFieldsBuilder()
       Optional. The fields to exclude from data profile.

 If specified, the fields will be excluded from data profile, regardless of
 `include_fields` value.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getExcludeFieldsOrBuilder

      public DataProfileSpec.SelectedFieldsOrBuilder getExcludeFieldsOrBuilder()
       Optional. The fields to exclude from data profile.

 If specified, the fields will be excluded from data profile, regardless of
 `include_fields` value.
      .google.cloud.dataplex.v1.DataProfileSpec.SelectedFields exclude_fields = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExcludeFieldsOrBuilder in interface DataProfileSpecOrBuilder

    • 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 DataProfileSpecOrBuilder
      Returns:
      The catalogPublishingEnabled.

    • setCatalogPublishingEnabled

      public DataProfileSpec.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 DataProfileSpec.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.