com.google.api.services.vision.v1.model

Class ProductSearchParams

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.vision.v1.model.ProductSearchParams

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ProductSearchParams
extends com.google.api.client.json.GenericJson

Parameters for a product search request.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Vision API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ProductSearchParams()

Method Summary

Modifier and Type	Method and Description
ProductSearchParams	clone()
BoundingPoly	getBoundingPoly() The bounding polygon around the area of interest in the image.
String	getFilter() The filtering expression.
List<String>	getProductCategories() The list of product categories to search in.
String	getProductSet() The resource name of a ProductSet to be searched for similar images.
ProductSearchParams	set(String fieldName, Object value)
ProductSearchParams	setBoundingPoly(BoundingPoly boundingPoly) The bounding polygon around the area of interest in the image.
ProductSearchParams	setFilter(String filter) The filtering expression.
ProductSearchParams	setProductCategories(List<String> productCategories) The list of product categories to search in.
ProductSearchParams	setProductSet(String productSet) The resource name of a ProductSet to be searched for similar images.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ProductSearchParams

public ProductSearchParams()

Method Detail

getBoundingPoly

public BoundingPoly getBoundingPoly()

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

Returns:

value or null for none

setBoundingPoly

public ProductSearchParams setBoundingPoly(BoundingPoly boundingPoly)

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

Parameters:

boundingPoly - boundingPoly or null for none

getFilter

public 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 '='.

Returns:

value or null for none

setFilter

public ProductSearchParams setFilter(String filter)

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 '='.

Parameters:

filter - filter or null for none

getProductCategories

public List<String> getProductCategories()

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.

Returns:

value or null for none

setProductCategories

public ProductSearchParams setProductCategories(List<String> productCategories)

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.

Parameters:

productCategories - productCategories or null for none

getProductSet

public 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`.

Returns:

value or null for none

setProductSet

public ProductSearchParams setProductSet(String productSet)

The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.

Parameters:

productSet - productSet or null for none

set

public ProductSearchParams set(String fieldName,
                               Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ProductSearchParams clone()

Overrides:

clone in class com.google.api.client.json.GenericJson