Class protos.google.cloud.vision.v1p4beta1.ProductSearchResults (2.3.8)

Represents a ProductSearchResults.

Package

@google-cloud/vision!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.vision.v1p4beta1.IProductSearchResults);

Constructs a new ProductSearchResults.

Parameter
NameDescription
properties IProductSearchResults

Properties to set

Properties

indexTime

public indexTime?: (google.protobuf.ITimestamp|null);

ProductSearchResults indexTime.

Property Value
TypeDescription
(google.protobuf.ITimestamp|null)

productGroupedResults

public productGroupedResults: google.cloud.vision.v1p4beta1.ProductSearchResults.IGroupedResult[];

ProductSearchResults productGroupedResults.

Property Value
TypeDescription
google.cloud.vision.v1p4beta1.ProductSearchResults.IGroupedResult[]

results

public results: google.cloud.vision.v1p4beta1.ProductSearchResults.IResult[];

ProductSearchResults results.

Property Value
TypeDescription
google.cloud.vision.v1p4beta1.ProductSearchResults.IResult[]

Methods

create(properties)

public static create(properties?: google.cloud.vision.v1p4beta1.IProductSearchResults): google.cloud.vision.v1p4beta1.ProductSearchResults;

Creates a new ProductSearchResults instance using the specified properties.

Parameter
NameDescription
properties IProductSearchResults

Properties to set

Returns
TypeDescription
google.cloud.vision.v1p4beta1.ProductSearchResults

ProductSearchResults instance

decode(reader, length)

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

Decodes a ProductSearchResults 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.v1p4beta1.ProductSearchResults

ProductSearchResults

decodeDelimited(reader)

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

Decodes a ProductSearchResults 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.v1p4beta1.ProductSearchResults

ProductSearchResults

encode(message, writer)

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

Encodes the specified ProductSearchResults message. Does not implicitly messages.

Parameters
NameDescription
message IProductSearchResults

ProductSearchResults 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.v1p4beta1.IProductSearchResults, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IProductSearchResults

ProductSearchResults 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.v1p4beta1.ProductSearchResults;

Creates a ProductSearchResults 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.v1p4beta1.ProductSearchResults

ProductSearchResults

toJSON()

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

Converts this ProductSearchResults to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.vision.v1p4beta1.ProductSearchResults

ProductSearchResults

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