Interface ProductSearchParamsOrBuilder (3.18.0)

public interface ProductSearchParamsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBoundingPoly()

public abstract BoundingPoly getBoundingPoly()

The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 9;

Returns
Type	Description
`BoundingPoly`	The boundingPoly.

getBoundingPolyOrBuilder()

public abstract BoundingPolyOrBuilder getBoundingPolyOrBuilder()

The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 9;

Returns
Type	Description
`BoundingPolyOrBuilder`

getFilter()

public abstract String getFilter()

The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value.

For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='.

string filter = 8;

Returns
Type	Description
`String`	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

string filter = 8;

Returns
Type	Description
`ByteString`	The bytes for filter.

getProductCategories(int index)

public abstract String getProductCategories(int index)

The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1", or "general-v1" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well.

repeated string product_categories = 7;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The productCategories at the given index.

getProductCategoriesBytes(int index)

public abstract ByteString getProductCategoriesBytes(int index)

repeated string product_categories = 7;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the productCategories at the given index.

getProductCategoriesCount()

public abstract int getProductCategoriesCount()

repeated string product_categories = 7;

Returns
Type	Description
`int`	The count of productCategories.

getProductCategoriesList()

public abstract List<String> getProductCategoriesList()

repeated string product_categories = 7;

Returns
Type	Description
`List<String>`	A list containing the productCategories.

getProductSet()

public abstract String getProductSet()

The resource name of a ProductSet to be searched for similar images.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

string product_set = 6 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The productSet.

getProductSetBytes()

public abstract ByteString getProductSetBytes()

The resource name of a ProductSet to be searched for similar images.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

string product_set = 6 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for productSet.

hasBoundingPoly()

public abstract boolean hasBoundingPoly()

The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.

.google.cloud.vision.v1.BoundingPoly bounding_poly = 9;

Returns
Type	Description
`boolean`	Whether the boundingPoly field is set.