Interface ProductSearchParamsOrBuilder (2.0.29)

Version 2.0.29

• 3.51.0 (latest)
• 3.50.0
• 3.49.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.3
• 2.1.4
• 2.0.29

public interface ProductSearchParamsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBoundingPoly()

public abstract BoundingPoly getBoundingPoly()

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

.google.cloud.vision.v1p3beta1.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. Optional. If it is not specified, system discretion will be applied.

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

Returns

Type	Description
BoundingPolyOrBuilder

getCatalogName()

public abstract String getCatalogName()

The resource name of the catalog to search. Format is: productSearch/catalogs/CATALOG_NAME.

string catalog_name = 1;

Returns

Type	Description
String	The catalogName.

getCatalogNameBytes()

public abstract ByteString getCatalogNameBytes()

The resource name of the catalog to search. Format is: productSearch/catalogs/CATALOG_NAME.

string catalog_name = 1;

Returns

Type	Description
ByteString	The bytes for catalogName.

getCategory()

public abstract ProductSearchCategory getCategory()

The category to search in. Optional. It is inferred by the system if it is not specified. [Deprecated] Use product_category.

.google.cloud.vision.v1p3beta1.ProductSearchCategory category = 2;

Returns

Type	Description
ProductSearchCategory	The category.

getCategoryValue()

public abstract int getCategoryValue()

The category to search in. Optional. It is inferred by the system if it is not specified. [Deprecated] Use product_category.

.google.cloud.vision.v1p3beta1.ProductSearchCategory category = 2;

Returns

Type	Description
int	The enum numeric value on the wire for category.

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. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but not "(color = red OR brand = Google)" or "color: red".

string filter = 8;

Returns

Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but not "(color = red OR brand = Google)" or "color: red".

string filter = 8;

Returns

Type	Description
ByteString	The bytes for filter.

getNormalizedBoundingPoly()

public abstract NormalizedBoundingPoly getNormalizedBoundingPoly()

The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied. [Deprecated] Use bounding_poly.

.google.cloud.vision.v1p3beta1.NormalizedBoundingPoly normalized_bounding_poly = 3;

Returns

Type	Description
NormalizedBoundingPoly	The normalizedBoundingPoly.

getNormalizedBoundingPolyOrBuilder()

public abstract NormalizedBoundingPolyOrBuilder getNormalizedBoundingPolyOrBuilder()

The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied. [Deprecated] Use bounding_poly.

.google.cloud.vision.v1p3beta1.NormalizedBoundingPoly normalized_bounding_poly = 3;

Returns

Type	Description
NormalizedBoundingPolyOrBuilder

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" or "apparel" should be specified.

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)

The list of product categories to search in. Currently, we only consider the first category, and either "homegoods" or "apparel" should be specified.

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()

The list of product categories to search in. Currently, we only consider the first category, and either "homegoods" or "apparel" should be specified.

repeated string product_categories = 7;

Returns

Type	Description
int	The count of productCategories.

getProductCategoriesList()

public abstract List<String> getProductCategoriesList()

The list of product categories to search in. Currently, we only consider the first category, and either "homegoods" or "apparel" should be specified.

repeated string product_categories = 7;

Returns

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

getProductCategory()

public abstract String getProductCategory()

The product category to search in. Optional. It is inferred by the system if it is not specified. Supported values are bag, shoe, sunglasses, dress, outerwear, skirt, top, shorts, and pants.

string product_category = 5;

Returns

Type	Description
String	The productCategory.

getProductCategoryBytes()

public abstract ByteString getProductCategoryBytes()

The product category to search in. Optional. It is inferred by the system if it is not specified. Supported values are bag, shoe, sunglasses, dress, outerwear, skirt, top, shorts, and pants.

string product_category = 5;

Returns

Type	Description
ByteString	The bytes for productCategory.

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.

getView()

public abstract ProductSearchResultsView getView()

Specifies the verbosity of the product search results. Optional. Defaults to BASIC.

.google.cloud.vision.v1p3beta1.ProductSearchResultsView view = 4;

Returns

Type	Description
ProductSearchResultsView	The view.

getViewValue()

public abstract int getViewValue()

Specifies the verbosity of the product search results. Optional. Defaults to BASIC.

.google.cloud.vision.v1p3beta1.ProductSearchResultsView view = 4;

Returns

Type	Description
int	The enum numeric value on the wire for view.

hasBoundingPoly()

public abstract boolean hasBoundingPoly()

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

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

Returns

Type	Description
boolean	Whether the boundingPoly field is set.

hasNormalizedBoundingPoly()

public abstract boolean hasNormalizedBoundingPoly()

The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied. [Deprecated] Use bounding_poly.

.google.cloud.vision.v1p3beta1.NormalizedBoundingPoly normalized_bounding_poly = 3;

Returns

Type	Description
boolean	Whether the normalizedBoundingPoly field is set.