Represents a ProductSearchParams.
Package
@google-cloud/vision!Constructors
(constructor)(properties)
constructor(properties?: google.cloud.vision.v1p3beta1.IProductSearchParams);Constructs a new ProductSearchParams.
| Name | Description |
| properties |
IProductSearchParams
Properties to set |
Properties
boundingPoly
public boundingPoly?: (google.cloud.vision.v1p3beta1.IBoundingPoly|null);ProductSearchParams boundingPoly.
| Type | Description |
| (google.cloud.vision.v1p3beta1.IBoundingPoly|null) |
catalogName
public catalogName: string;ProductSearchParams catalogName.
| Type | Description |
| string |
category
public category: (google.cloud.vision.v1p3beta1.ProductSearchCategory|keyof typeof google.cloud.vision.v1p3beta1.ProductSearchCategory);ProductSearchParams category.
| Type | Description |
| (google.cloud.vision.v1p3beta1.ProductSearchCategory|keyof typeof google.cloud.vision.v1p3beta1.ProductSearchCategory) |
filter
public filter: string;ProductSearchParams filter.
| Type | Description |
| string |
normalizedBoundingPoly
public normalizedBoundingPoly?: (google.cloud.vision.v1p3beta1.INormalizedBoundingPoly|null);ProductSearchParams normalizedBoundingPoly.
| Type | Description |
| (google.cloud.vision.v1p3beta1.INormalizedBoundingPoly|null) |
productCategories
public productCategories: string[];ProductSearchParams productCategories.
| Type | Description |
| string[] |
productCategory
public productCategory: string;ProductSearchParams productCategory.
| Type | Description |
| string |
productSet
public productSet: string;ProductSearchParams productSet.
| Type | Description |
| string |
view
public view: (google.cloud.vision.v1p3beta1.ProductSearchResultsView|keyof typeof google.cloud.vision.v1p3beta1.ProductSearchResultsView);ProductSearchParams view.
| Type | Description |
| (google.cloud.vision.v1p3beta1.ProductSearchResultsView|keyof typeof google.cloud.vision.v1p3beta1.ProductSearchResultsView) |
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.
| Name | Description |
| properties |
IProductSearchParams
Properties to set |
| Type | Description |
| 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.
| Name | Description |
| reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| length |
number
Message length if known beforehand |
| Type | Description |
| 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.
| Name | Description |
| reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Type | Description |
| 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.
| Name | Description |
| message |
IProductSearchParams
ProductSearchParams message or plain object to encode |
| writer |
$protobuf.Writer
Writer to encode to |
| Type | Description |
| $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.
| Name | Description |
| message |
IProductSearchParams
ProductSearchParams message or plain object to encode |
| writer |
$protobuf.Writer
Writer to encode to |
| Type | Description |
| $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.
| Name | Description |
| object |
{ [k: string]: any }
Plain object |
| Type | Description |
| google.cloud.vision.v1p3beta1.ProductSearchParams | ProductSearchParams |
toJSON()
public toJSON(): { [k: string]: any };Converts this ProductSearchParams to JSON.
| Type | Description |
| { [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.
| Name | Description |
| message |
google.cloud.vision.v1p3beta1.ProductSearchParams
ProductSearchParams |
| options |
$protobuf.IConversionOptions
Conversion options |
| Type | Description |
| { [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a ProductSearchParams message.
| Name | Description |
| message |
{ [k: string]: any }
Plain object to verify |
| Type | Description |
| (string|null) |
|