Class protos.google.cloud.vision.v1p3beta1.ProductSearchParams

Represents a ProductSearchParams.

Package

@google-cloud/vision

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.vision.v1p3beta1.IProductSearchParams);

Constructs a new ProductSearchParams.

Parameter
NameDescription
properties IProductSearchParams

Properties to set

Properties

boundingPoly

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

ProductSearchParams boundingPoly.

catalogName

public catalogName: string;

ProductSearchParams catalogName.

category

public category: (google.cloud.vision.v1p3beta1.ProductSearchCategory|keyof typeof google.cloud.vision.v1p3beta1.ProductSearchCategory);

ProductSearchParams category.

filter

public filter: string;

ProductSearchParams filter.

normalizedBoundingPoly

public normalizedBoundingPoly?: (google.cloud.vision.v1p3beta1.INormalizedBoundingPoly|null);

ProductSearchParams normalizedBoundingPoly.

productCategories

public productCategories: string[];

ProductSearchParams productCategories.

productCategory

public productCategory: string;

ProductSearchParams productCategory.

productSet

public productSet: string;

ProductSearchParams productSet.

view

public view: (google.cloud.vision.v1p3beta1.ProductSearchResultsView|keyof typeof google.cloud.vision.v1p3beta1.ProductSearchResultsView);

ProductSearchParams view.

Methods

create(properties)

public static create(properties?: google.cloud.vision.v1p3beta1.IProductSearchParams): google.cloud.vision.v1p3beta1.ProductSearchParams;

Creates a new ProductSearchParams instance using the specified properties.

Parameter
NameDescription
properties IProductSearchParams

Properties to set

Returns
TypeDescription
google.cloud.vision.v1p3beta1.ProductSearchParams

ProductSearchParams instance

decode(reader, length)

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

Decodes a ProductSearchParams 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.v1p3beta1.ProductSearchParams

ProductSearchParams

decodeDelimited(reader)

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

Decodes a ProductSearchParams 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.v1p3beta1.ProductSearchParams

ProductSearchParams

encode(message, writer)

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

Encodes the specified ProductSearchParams message. Does not implicitly messages.

Parameters
NameDescription
message IProductSearchParams

ProductSearchParams 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.v1p3beta1.IProductSearchParams, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IProductSearchParams

ProductSearchParams 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.v1p3beta1.ProductSearchParams;

Creates a ProductSearchParams 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.v1p3beta1.ProductSearchParams

ProductSearchParams

toJSON()

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

Converts this ProductSearchParams to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.vision.v1p3beta1.ProductSearchParams

ProductSearchParams

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