Class protos.google.cloud.vision.v1.LocalizedObjectAnnotation (3.1.2)

Represents a LocalizedObjectAnnotation.

Package

@google-cloud/vision

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.vision.v1.ILocalizedObjectAnnotation);

Constructs a new LocalizedObjectAnnotation.

Parameter
NameDescription
properties ILocalizedObjectAnnotation

Properties to set

Properties

boundingPoly

public boundingPoly?: (google.cloud.vision.v1.IBoundingPoly|null);

LocalizedObjectAnnotation boundingPoly.

languageCode

public languageCode: string;

LocalizedObjectAnnotation languageCode.

mid

public mid: string;

LocalizedObjectAnnotation mid.

name

public name: string;

LocalizedObjectAnnotation name.

score

public score: number;

LocalizedObjectAnnotation score.

Methods

create(properties)

public static create(properties?: google.cloud.vision.v1.ILocalizedObjectAnnotation): google.cloud.vision.v1.LocalizedObjectAnnotation;

Creates a new LocalizedObjectAnnotation instance using the specified properties.

Parameter
NameDescription
properties ILocalizedObjectAnnotation

Properties to set

Returns
TypeDescription
google.cloud.vision.v1.LocalizedObjectAnnotation

LocalizedObjectAnnotation instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.vision.v1.LocalizedObjectAnnotation;

Decodes a LocalizedObjectAnnotation 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.cloud.vision.v1.LocalizedObjectAnnotation

LocalizedObjectAnnotation

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.vision.v1.LocalizedObjectAnnotation;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.vision.v1.LocalizedObjectAnnotation

LocalizedObjectAnnotation

encode(message, writer)

public static encode(message: google.cloud.vision.v1.ILocalizedObjectAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified LocalizedObjectAnnotation message. Does not implicitly messages.

Parameters
NameDescription
message ILocalizedObjectAnnotation

LocalizedObjectAnnotation 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.cloud.vision.v1.ILocalizedObjectAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ILocalizedObjectAnnotation

LocalizedObjectAnnotation 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.cloud.vision.v1.LocalizedObjectAnnotation;

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

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

Plain object

Returns
TypeDescription
google.cloud.vision.v1.LocalizedObjectAnnotation

LocalizedObjectAnnotation

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for LocalizedObjectAnnotation

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this LocalizedObjectAnnotation to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.vision.v1.LocalizedObjectAnnotation, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.cloud.vision.v1.LocalizedObjectAnnotation

LocalizedObjectAnnotation

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