Class protos.google.privacy.dlp.v2.BoundingBox

Represents a BoundingBox.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new BoundingBox.

Parameter
NameDescription
properties IBoundingBox

Properties to set

Properties

height

public height: number;

BoundingBox height.

left

public left: number;

BoundingBox left.

top

public top: number;

BoundingBox top.

width

public width: number;

BoundingBox width.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IBoundingBox): google.privacy.dlp.v2.BoundingBox;

Creates a new BoundingBox instance using the specified properties.

Parameter
NameDescription
properties IBoundingBox

Properties to set

Returns
TypeDescription
google.privacy.dlp.v2.BoundingBox

BoundingBox instance

decode(reader, length)

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

Decodes a BoundingBox 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.BoundingBox

BoundingBox

decodeDelimited(reader)

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

Decodes a BoundingBox 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.BoundingBox

BoundingBox

encode(message, writer)

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

Encodes the specified BoundingBox message. Does not implicitly messages.

Parameters
NameDescription
message IBoundingBox

BoundingBox 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.IBoundingBox, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IBoundingBox

BoundingBox 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.BoundingBox;

Creates a BoundingBox 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.BoundingBox

BoundingBox

toJSON()

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

Converts this BoundingBox to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.privacy.dlp.v2.BoundingBox

BoundingBox

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 BoundingBox 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