Class protos.google.cloud.vision.v1.WebDetection

Represents a WebDetection.

Package

@google-cloud/vision

Constructors

(constructor)(properties)

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

Constructs a new WebDetection.

Parameter
NameDescription
properties IWebDetection

Properties to set

Properties

bestGuessLabels

public bestGuessLabels: google.cloud.vision.v1.WebDetection.IWebLabel[];

WebDetection bestGuessLabels.

fullMatchingImages

public fullMatchingImages: google.cloud.vision.v1.WebDetection.IWebImage[];

WebDetection fullMatchingImages.

pagesWithMatchingImages

public pagesWithMatchingImages: google.cloud.vision.v1.WebDetection.IWebPage[];

WebDetection pagesWithMatchingImages.

partialMatchingImages

public partialMatchingImages: google.cloud.vision.v1.WebDetection.IWebImage[];

WebDetection partialMatchingImages.

visuallySimilarImages

public visuallySimilarImages: google.cloud.vision.v1.WebDetection.IWebImage[];

WebDetection visuallySimilarImages.

webEntities

public webEntities: google.cloud.vision.v1.WebDetection.IWebEntity[];

WebDetection webEntities.

Methods

create(properties)

public static create(properties?: google.cloud.vision.v1.IWebDetection): google.cloud.vision.v1.WebDetection;

Creates a new WebDetection instance using the specified properties.

Parameter
NameDescription
properties IWebDetection

Properties to set

Returns
TypeDescription
google.cloud.vision.v1.WebDetection

WebDetection instance

decode(reader, length)

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

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

WebDetection

decodeDelimited(reader)

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

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

WebDetection

encode(message, writer)

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

Encodes the specified WebDetection message. Does not implicitly messages.

Parameters
NameDescription
message IWebDetection

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

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

Parameters
NameDescription
message IWebDetection

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

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

WebDetection

toJSON()

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

Converts this WebDetection to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

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

WebDetection

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