Class ProductSearchParams.Builder (2.0.29)

Version 2.0.29

• 3.53.0 (latest)
• 3.52.0
• 3.51.0
• 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 static final class ProductSearchParams.Builder extends GeneratedMessageV3.Builder<ProductSearchParams.Builder> implements ProductSearchParamsOrBuilder

Parameters for a product search request.

Protobuf type google.cloud.vision.v1p3beta1.ProductSearchParams

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ProductSearchParams.Builder

Implements

ProductSearchParamsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllProductCategories(Iterable<String> values)

public ProductSearchParams.Builder addAllProductCategories(Iterable<String> values)

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
values	Iterable<String> The productCategories to add.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

addProductCategories(String value)

public ProductSearchParams.Builder addProductCategories(String value)

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
value	String The productCategories to add.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

addProductCategoriesBytes(ByteString value)

public ProductSearchParams.Builder addProductCategoriesBytes(ByteString value)

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
value	ByteString The bytes of the productCategories to add.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ProductSearchParams.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ProductSearchParams.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ProductSearchParams build()

Returns

Type	Description
ProductSearchParams

buildPartial()

public ProductSearchParams buildPartial()

Returns

Type	Description
ProductSearchParams

clear()

public ProductSearchParams.Builder clear()

Returns

Type	Description
ProductSearchParams.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBoundingPoly()

public ProductSearchParams.Builder clearBoundingPoly()

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
ProductSearchParams.Builder

clearCatalogName()

public ProductSearchParams.Builder clearCatalogName()

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

string catalog_name = 1;

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

clearCategory()

public ProductSearchParams.Builder clearCategory()

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
ProductSearchParams.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ProductSearchParams.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
ProductSearchParams.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public ProductSearchParams.Builder clearFilter()

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
ProductSearchParams.Builder	This builder for chaining.

clearNormalizedBoundingPoly()

public ProductSearchParams.Builder clearNormalizedBoundingPoly()

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
ProductSearchParams.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ProductSearchParams.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
ProductSearchParams.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearProductCategories()

public ProductSearchParams.Builder clearProductCategories()

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
ProductSearchParams.Builder	This builder for chaining.

clearProductCategory()

public ProductSearchParams.Builder clearProductCategory()

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
ProductSearchParams.Builder	This builder for chaining.

clearProductSet()

public ProductSearchParams.Builder clearProductSet()

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
ProductSearchParams.Builder	This builder for chaining.

clearView()

public ProductSearchParams.Builder clearView()

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

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

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

clone()

public ProductSearchParams.Builder clone()

Returns

Type	Description
ProductSearchParams.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBoundingPoly()

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

getBoundingPolyBuilder()

public BoundingPoly.Builder getBoundingPolyBuilder()

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.Builder

getBoundingPolyOrBuilder()

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

getDefaultInstanceForType()

public ProductSearchParams getDefaultInstanceForType()

Returns

Type	Description
ProductSearchParams

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

getNormalizedBoundingPolyBuilder()

public NormalizedBoundingPoly.Builder getNormalizedBoundingPolyBuilder()

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.Builder

getNormalizedBoundingPolyOrBuilder()

public 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 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 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 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 ProtocolStringList 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
ProtocolStringList	A list containing the productCategories.

getProductCategory()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeBoundingPoly(BoundingPoly value)

public ProductSearchParams.Builder mergeBoundingPoly(BoundingPoly value)

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;

Parameter

Name	Description
value	BoundingPoly

Returns

Type	Description
ProductSearchParams.Builder

mergeFrom(ProductSearchParams other)

public ProductSearchParams.Builder mergeFrom(ProductSearchParams other)

Parameter

Name	Description
other	ProductSearchParams

Returns

Type	Description
ProductSearchParams.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ProductSearchParams.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ProductSearchParams.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ProductSearchParams.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
ProductSearchParams.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeNormalizedBoundingPoly(NormalizedBoundingPoly value)

public ProductSearchParams.Builder mergeNormalizedBoundingPoly(NormalizedBoundingPoly value)

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;

Parameter

Name	Description
value	NormalizedBoundingPoly

Returns

Type	Description
ProductSearchParams.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ProductSearchParams.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ProductSearchParams.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setBoundingPoly(BoundingPoly value)

public ProductSearchParams.Builder setBoundingPoly(BoundingPoly value)

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;

Parameter

Name	Description
value	BoundingPoly

Returns

Type	Description
ProductSearchParams.Builder

setBoundingPoly(BoundingPoly.Builder builderForValue)

public ProductSearchParams.Builder setBoundingPoly(BoundingPoly.Builder builderForValue)

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;

Parameter

Name	Description
builderForValue	BoundingPoly.Builder

Returns

Type	Description
ProductSearchParams.Builder

setCatalogName(String value)

public ProductSearchParams.Builder setCatalogName(String value)

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

string catalog_name = 1;

Parameter

Name	Description
value	String The catalogName to set.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

setCatalogNameBytes(ByteString value)

public ProductSearchParams.Builder setCatalogNameBytes(ByteString value)

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

string catalog_name = 1;

Parameter

Name	Description
value	ByteString The bytes for catalogName to set.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

setCategory(ProductSearchCategory value)

public ProductSearchParams.Builder setCategory(ProductSearchCategory value)

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;

Parameter

Name	Description
value	ProductSearchCategory The category to set.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

setCategoryValue(int value)

public ProductSearchParams.Builder setCategoryValue(int value)

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;

Parameter

Name	Description
value	int The enum numeric value on the wire for category to set.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ProductSearchParams.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ProductSearchParams.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

public ProductSearchParams.Builder setFilter(String value)

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;

Parameter

Name	Description
value	String The filter to set.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

setFilterBytes(ByteString value)

public ProductSearchParams.Builder setFilterBytes(ByteString value)

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;

Parameter

Name	Description
value	ByteString The bytes for filter to set.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

setNormalizedBoundingPoly(NormalizedBoundingPoly value)

public ProductSearchParams.Builder setNormalizedBoundingPoly(NormalizedBoundingPoly value)

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;

Parameter

Name	Description
value	NormalizedBoundingPoly

Returns

Type	Description
ProductSearchParams.Builder

setNormalizedBoundingPoly(NormalizedBoundingPoly.Builder builderForValue)

public ProductSearchParams.Builder setNormalizedBoundingPoly(NormalizedBoundingPoly.Builder builderForValue)

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;

Parameter

Name	Description
builderForValue	NormalizedBoundingPoly.Builder

Returns

Type	Description
ProductSearchParams.Builder

setProductCategories(int index, String value)

public ProductSearchParams.Builder setProductCategories(int index, String value)

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

Name	Description
index	int The index to set the value at.
value	String The productCategories to set.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

setProductCategory(String value)

public ProductSearchParams.Builder setProductCategory(String value)

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;

Parameter

Name	Description
value	String The productCategory to set.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

setProductCategoryBytes(ByteString value)

public ProductSearchParams.Builder setProductCategoryBytes(ByteString value)

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;

Parameter

Name	Description
value	ByteString The bytes for productCategory to set.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

setProductSet(String value)

public ProductSearchParams.Builder setProductSet(String value)

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) = { ... }

Parameter

Name	Description
value	String The productSet to set.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

setProductSetBytes(ByteString value)

public ProductSearchParams.Builder setProductSetBytes(ByteString value)

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) = { ... }

Parameter

Name	Description
value	ByteString The bytes for productSet to set.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ProductSearchParams.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
ProductSearchParams.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ProductSearchParams.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ProductSearchParams.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setView(ProductSearchResultsView value)

public ProductSearchParams.Builder setView(ProductSearchResultsView value)

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

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

Parameter

Name	Description
value	ProductSearchResultsView The view to set.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.

setViewValue(int value)

public ProductSearchParams.Builder setViewValue(int value)

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

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

Parameter

Name	Description
value	int The enum numeric value on the wire for view to set.

Returns

Type	Description
ProductSearchParams.Builder	This builder for chaining.