com.google.cloud.vision.v1p3beta1

Interface ProductSearchParamsOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ProductSearchParams, ProductSearchParams.Builder

public interface ProductSearchParamsOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
BoundingPoly	getBoundingPoly() The bounding polygon around the area of interest in the image.
BoundingPolyOrBuilder	getBoundingPolyOrBuilder() The bounding polygon around the area of interest in the image.
String	getCatalogName() The resource name of the catalog to search.
com.google.protobuf.ByteString	getCatalogNameBytes() The resource name of the catalog to search.
ProductSearchCategory	getCategory() The category to search in.
int	getCategoryValue() The category to search in.
String	getFilter() The filtering expression.
com.google.protobuf.ByteString	getFilterBytes() The filtering expression.
NormalizedBoundingPoly	getNormalizedBoundingPoly() The bounding polygon around the area of interest in the image.
NormalizedBoundingPolyOrBuilder	getNormalizedBoundingPolyOrBuilder() The bounding polygon around the area of interest in the image.
String	getProductCategories(int index) The list of product categories to search in.
com.google.protobuf.ByteString	getProductCategoriesBytes(int index) The list of product categories to search in.
int	getProductCategoriesCount() The list of product categories to search in.
List<String>	getProductCategoriesList() The list of product categories to search in.
String	getProductCategory() The product category to search in.
com.google.protobuf.ByteString	getProductCategoryBytes() The product category to search in.
String	getProductSet() The resource name of a [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be searched for similar images.
com.google.protobuf.ByteString	getProductSetBytes() The resource name of a [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be searched for similar images.
ProductSearchResultsView	getView() Specifies the verbosity of the product search results.
int	getViewValue() Specifies the verbosity of the product search results.
boolean	hasBoundingPoly() The bounding polygon around the area of interest in the image.
boolean	hasNormalizedBoundingPoly() The bounding polygon around the area of interest in the image.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getCatalogName

String getCatalogName()

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

string catalog_name = 1;

Returns:

The catalogName.

getCatalogNameBytes

com.google.protobuf.ByteString getCatalogNameBytes()

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

string catalog_name = 1;

Returns:

The bytes for catalogName.

getCategoryValue

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:

The enum numeric value on the wire for category.

getCategory

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:

The category.

getProductCategory

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:

The productCategory.

getProductCategoryBytes

com.google.protobuf.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:

The bytes for productCategory.

hasNormalizedBoundingPoly

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:

Whether the normalizedBoundingPoly field is set.

getNormalizedBoundingPoly

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:

The normalizedBoundingPoly.

getNormalizedBoundingPolyOrBuilder

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;

hasBoundingPoly

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:

Whether the boundingPoly field is set.

getBoundingPoly

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:

The boundingPoly.

getBoundingPolyOrBuilder

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;

getViewValue

int getViewValue()

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

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

Returns:

The enum numeric value on the wire for view.

getView

ProductSearchResultsView getView()

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

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

Returns:

The view.

getProductSet

String getProductSet()

 The resource name of a
 [ProductSet][google.cloud.vision.v1p3beta1.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:

The productSet.

getProductSetBytes

com.google.protobuf.ByteString getProductSetBytes()

 The resource name of a
 [ProductSet][google.cloud.vision.v1p3beta1.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:

The bytes for productSet.

getProductCategoriesList

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:

A list containing the productCategories.

getProductCategoriesCount

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:

The count of productCategories.

getProductCategories

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;

Parameters:

index - The index of the element to return.

Returns:

The productCategories at the given index.

getProductCategoriesBytes

com.google.protobuf.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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the productCategories at the given index.

getFilter

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:

The filter.

getFilterBytes

com.google.protobuf.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:

The bytes for filter.