Package com.google.cloud.dataplex.v1

Class DataProfileSpec

  • All Implemented Interfaces:
    DataProfileSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DataProfileSpec
extends com.google.protobuf.GeneratedMessageV3
implements DataProfileSpecOrBuilder
     DataProfileScan related setting.
    Protobuf type google.cloud.dataplex.v1.DataProfileSpec
    See Also:
    Serialized Form

    • Field Detail

      • SAMPLING_PERCENT_FIELD_NUMBER

        public static final int SAMPLING_PERCENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ROW_FILTER_FIELD_NUMBER

        public static final int ROW_FILTER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • POST_SCAN_ACTIONS_FIELD_NUMBER

        public static final int POST_SCAN_ACTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INCLUDE_FIELDS_FIELD_NUMBER

        public static final int INCLUDE_FIELDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXCLUDE_FIELDS_FIELD_NUMBER

        public static final int EXCLUDE_FIELDS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

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

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

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

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

      • 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

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected DataProfileSpec.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<DataProfileSpec> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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