Class protos.google.cloud.vision.v1.ReferenceImage

Represents a ReferenceImage.

Package

@google-cloud/vision

Constructors

(constructor)(properties)

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

Constructs a new ReferenceImage.

Parameter
NameDescription
properties IReferenceImage

Properties to set

Properties

boundingPolys

public boundingPolys: google.cloud.vision.v1.IBoundingPoly[];

ReferenceImage boundingPolys.

name

public name: string;

ReferenceImage name.

uri

public uri: string;

ReferenceImage uri.

Methods

create(properties)

public static create(properties?: google.cloud.vision.v1.IReferenceImage): google.cloud.vision.v1.ReferenceImage;

Creates a new ReferenceImage instance using the specified properties.

Parameter
NameDescription
properties IReferenceImage

Properties to set

Returns
TypeDescription
google.cloud.vision.v1.ReferenceImage

ReferenceImage instance

decode(reader, length)

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

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

ReferenceImage

decodeDelimited(reader)

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

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

ReferenceImage

encode(message, writer)

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

Encodes the specified ReferenceImage message. Does not implicitly messages.

Parameters
NameDescription
message IReferenceImage

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

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

Parameters
NameDescription
message IReferenceImage

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

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

ReferenceImage

toJSON()

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

Converts this ReferenceImage to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

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

ReferenceImage

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