Interface ProductSearchParamsOrBuilder

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
String

The productSet.

getProductSetBytes()

public abstract ByteString getProductSetBytes()

The resource name of a ProductSet to be searched for s