Class protos.google.privacy.dlp.v2.BucketingConfig.Bucket

Represents a Bucket.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

constructor(properties?: google.privacy.dlp.v2.BucketingConfig.IBucket);

Constructs a new Bucket.

Parameter
NameDescription
properties IBucket

Properties to set

Properties

max

public max?: (google.privacy.dlp.v2.IValue|null);

Bucket max.

min

public min?: (google.privacy.dlp.v2.IValue|null);

Bucket min.

replacementValue

public replacementValue?: (google.privacy.dlp.v2.IValue|null);

Bucket replacementValue.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.BucketingConfig.IBucket): google.privacy.dlp.v2.BucketingConfig.Bucket;

Creates a new Bucket instance using the specified properties.

Parameter
NameDescription
properties IBucket

Properties to set

Returns
TypeDescription
google.privacy.dlp.v2.BucketingConfig.Bucket

Bucket instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.privacy.dlp.v2.BucketingConfig.Bucket;

Decodes a Bucket message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.privacy.dlp.v2.BucketingConfig.Bucket

Bucket

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.privacy.dlp.v2.BucketingConfig.Bucket;

Decodes a Bucket message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.privacy.dlp.v2.BucketingConfig.Bucket

Bucket

encode(message, writer)

public static encode(message: google.privacy.dlp.v2.BucketingConfig.IBucket, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Bucket message. Does not implicitly messages.

Parameters
NameDescription
message IBucket

Bucket message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.privacy.dlp.v2.BucketingConfig.IBucket, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Bucket message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IBucket

Bucket message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.privacy.dlp.v2.BucketingConfig.Bucket;

Creates a Bucket message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.privacy.dlp.v2.BucketingConfig.Bucket

Bucket

toJSON()

public toJSON(): { [k: string]: any };

Converts this Bucket to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.privacy.dlp.v2.BucketingConfig.Bucket, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Bucket message. Also converts values to other types if specified.

Parameters
NameDescription
message google.privacy.dlp.v2.BucketingConfig.Bucket

Bucket

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Bucket message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not