Class FixedSizeBucketingConfig

public final class FixedSizeBucketingConfig extends 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}, i.e 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

Fields

BUCKET_SIZE_FIELD_NUMBER

public static final int BUCKET_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

LOWER_BOUND_FIELD_NUMBER

public static final int LOWER_BOUND_FIELD_NUMBER
Field Value
TypeDescription
int

UPPER_BOUND_FIELD_NUMBER

public static final int UPPER_BOUND_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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];

Returns
TypeDescription
double

The bucketSize.

getDefaultInstance()

public static FixedSizeBucketingConfig getDefaultInstance()
Returns
TypeDescription
FixedSizeBucketingConfig

getDefaultInstanceForType()

public FixedSizeBucketingConfig getDefaultInstanceForType()
Returns
TypeDescription
FixedSizeBucketingConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

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];

Returns
TypeDescription
Value

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];

Returns
TypeDescription
ValueOrBuilder

getParserForType()

public Parser<FixedSizeBucketingConfig> getParserForType()
Returns
TypeDescription
Parser<FixedSizeBucketingConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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];

Returns
TypeDescription
Value

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];

Returns
TypeDescription
ValueOrBuilder

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];

Returns
TypeDescription
boolean

Whether the lowerBound field is set.

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];

Returns
TypeDescription
boolean

Whether the upperBound field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static FixedSizeBucketingConfig.Builder newBuilder()
Returns
TypeDescription
FixedSizeBucketingConfig.Builder

newBuilder(FixedSizeBucketingConfig prototype)

public static FixedSizeBucketingConfig.Builder newBuilder(FixedSizeBucketingConfig prototype)
Parameter
NameDescription
prototypeFixedSizeBucketingConfig
Returns
TypeDescription
FixedSizeBucketingConfig.Builder

newBuilderForType()

public FixedSizeBucketingConfig.Builder newBuilderForType()
Returns
TypeDescription
FixedSizeBucketingConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FixedSizeBucketingConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
FixedSizeBucketingConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static FixedSizeBucketingConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FixedSizeBucketingConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FixedSizeBucketingConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FixedSizeBucketingConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static FixedSizeBucketingConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
FixedSizeBucketingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FixedSizeBucketingConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FixedSizeBucketingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FixedSizeBucketingConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FixedSizeBucketingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FixedSizeBucketingConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FixedSizeBucketingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FixedSizeBucketingConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FixedSizeBucketingConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FixedSizeBucketingConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FixedSizeBucketingConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static FixedSizeBucketingConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FixedSizeBucketingConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FixedSizeBucketingConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FixedSizeBucketingConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static FixedSizeBucketingConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FixedSizeBucketingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FixedSizeBucketingConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FixedSizeBucketingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<FixedSizeBucketingConfig> parser()
Returns
TypeDescription
Parser<FixedSizeBucketingConfig>

toBuilder()

public FixedSizeBucketingConfig.Builder toBuilder()
Returns
TypeDescription
FixedSizeBucketingConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException