Class FixedSizeBucketingConfig

  • All Implemented Interfaces:
    FixedSizeBucketingConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class FixedSizeBucketingConfig
    extends com.google.protobuf.GeneratedMessageV3
    implements FixedSizeBucketingConfigOrBuilder
     Buckets values based on fixed size ranges. The
     Bucketing transformation can provide all of this functionality,
     but requires more configuration. This message is provided as a convenience to
     the user for simple bucketing strategies.
    
     The transformed value will be a hyphenated string of
     {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound
     = 20, all values that are within this bucket will be replaced with "10-20".
    
     This can be used on data of type: double, long.
    
     If the bound Value type differs from the type of data
     being transformed, we will first attempt converting the type of the data to
     be transformed to match the type of the bound before comparing.
    
     See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.
     
    Protobuf type google.privacy.dlp.v2.FixedSizeBucketingConfig
    See Also:
    Serialized Form
    • Field Detail

      • LOWER_BOUND_FIELD_NUMBER

        public static final int LOWER_BOUND_FIELD_NUMBER
        See Also:
        Constant Field Values
      • UPPER_BOUND_FIELD_NUMBER

        public static final int UPPER_BOUND_FIELD_NUMBER
        See Also:
        Constant Field Values
      • BUCKET_SIZE_FIELD_NUMBER

        public static final int BUCKET_SIZE_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
      • hasLowerBound

        public boolean hasLowerBound()
         Required. Lower bound value of buckets. All values less than `lower_bound` are
         grouped together into a single bucket; for example if `lower_bound` = 10,
         then all values less than 10 are replaced with the value "-10".
         
        .google.privacy.dlp.v2.Value lower_bound = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasLowerBound in interface FixedSizeBucketingConfigOrBuilder
        Returns:
        Whether the lowerBound field is set.
      • getLowerBound

        public Value getLowerBound()
         Required. Lower bound value of buckets. All values less than `lower_bound` are
         grouped together into a single bucket; for example if `lower_bound` = 10,
         then all values less than 10 are replaced with the value "-10".
         
        .google.privacy.dlp.v2.Value lower_bound = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLowerBound in interface FixedSizeBucketingConfigOrBuilder
        Returns:
        The lowerBound.
      • getLowerBoundOrBuilder

        public ValueOrBuilder getLowerBoundOrBuilder()
         Required. Lower bound value of buckets. All values less than `lower_bound` are
         grouped together into a single bucket; for example if `lower_bound` = 10,
         then all values less than 10 are replaced with the value "-10".
         
        .google.privacy.dlp.v2.Value lower_bound = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getLowerBoundOrBuilder in interface FixedSizeBucketingConfigOrBuilder
      • hasUpperBound

        public boolean hasUpperBound()
         Required. Upper bound value of buckets. All values greater than upper_bound are
         grouped together into a single bucket; for example if `upper_bound` = 89,
         then all values greater than 89 are replaced with the value "89+".
         
        .google.privacy.dlp.v2.Value upper_bound = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasUpperBound in interface FixedSizeBucketingConfigOrBuilder
        Returns:
        Whether the upperBound field is set.
      • getUpperBound

        public Value getUpperBound()
         Required. Upper bound value of buckets. All values greater than upper_bound are
         grouped together into a single bucket; for example if `upper_bound` = 89,
         then all values greater than 89 are replaced with the value "89+".
         
        .google.privacy.dlp.v2.Value upper_bound = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUpperBound in interface FixedSizeBucketingConfigOrBuilder
        Returns:
        The upperBound.
      • getUpperBoundOrBuilder

        public ValueOrBuilder getUpperBoundOrBuilder()
         Required. Upper bound value of buckets. All values greater than upper_bound are
         grouped together into a single bucket; for example if `upper_bound` = 89,
         then all values greater than 89 are replaced with the value "89+".
         
        .google.privacy.dlp.v2.Value upper_bound = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUpperBoundOrBuilder in interface FixedSizeBucketingConfigOrBuilder
      • getBucketSize

        public double getBucketSize()
         Required. Size of each bucket (except for minimum and maximum buckets). So if
         `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the
         following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60,
         60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works.
         
        double bucket_size = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getBucketSize in interface FixedSizeBucketingConfigOrBuilder
        Returns:
        The bucketSize.
      • 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 FixedSizeBucketingConfig parseFrom​(ByteBuffer data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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