public static final class ProductSearchParams.Builder extends GeneratedMessageV3.Builder<ProductSearchParams.Builder> implements ProductSearchParamsOrBuilderParameters for a product search request.
Protobuf type google.cloud.vision.v1p4beta1.ProductSearchParams
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ProductSearchParams.BuilderImplements
ProductSearchParamsOrBuilderStatic 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-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.
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-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.
repeated string product_categories = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe 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-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.
repeated string product_categories = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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 |
|
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 |
|
clearBoundingPoly()
public ProductSearchParams.Builder clearBoundingPoly()The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.
.google.cloud.vision.v1p4beta1.BoundingPoly bounding_poly = 9;
| Returns | |
|---|---|
| Type | Description |
ProductSearchParams.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ProductSearchParams.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ProductSearchParams.Builder |
|
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. 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 '='.
string filter = 8;
| Returns | |
|---|---|
| Type | Description |
ProductSearchParams.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ProductSearchParams.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ProductSearchParams.Builder |
|
clearProductCategories()
public ProductSearchParams.Builder clearProductCategories()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.
repeated string product_categories = 7;
| 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. |
clone()
public ProductSearchParams.Builder clone()| Returns | |
|---|---|
| Type | Description |
ProductSearchParams.Builder |
|
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.
.google.cloud.vision.v1p4beta1.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. If it is not specified, system discretion will be applied.
.google.cloud.vision.v1p4beta1.BoundingPoly bounding_poly = 9;
| Returns | |
|---|---|
| Type | Description |
BoundingPoly.Builder |
|
getBoundingPolyOrBuilder()
public BoundingPolyOrBuilder getBoundingPolyOrBuilder()The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.
.google.cloud.vision.v1p4beta1.BoundingPoly bounding_poly = 9;
| Returns | |
|---|---|
| Type | Description |
BoundingPolyOrBuilder |
|
getDefaultInstanceForType()
public ProductSearchParams getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ProductSearchParams |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 '='.
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. 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 '='.
string filter = 8;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
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-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.
repeated string product_categories = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe 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-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.
repeated string product_categories = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe 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-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.
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-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.
repeated string product_categories = 7;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the productCategories. |
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. |
hasBoundingPoly()
public boolean hasBoundingPoly()The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.
.google.cloud.vision.v1p4beta1.BoundingPoly bounding_poly = 9;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the boundingPoly field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeBoundingPoly(BoundingPoly value)
public ProductSearchParams.Builder mergeBoundingPoly(BoundingPoly value)The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.
.google.cloud.vision.v1p4beta1.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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ProductSearchParams.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| 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 |
|
setBoundingPoly(BoundingPoly value)
public ProductSearchParams.Builder setBoundingPoly(BoundingPoly value)The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.
.google.cloud.vision.v1p4beta1.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. If it is not specified, system discretion will be applied.
.google.cloud.vision.v1p4beta1.BoundingPoly bounding_poly = 9;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
BoundingPoly.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductSearchParams.Builder |
|
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 |
|
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. 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 '='.
string filter = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe 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. 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 '='.
string filter = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ProductSearchParams.Builder |
This builder for chaining. |
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-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.
repeated string product_categories = 7;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe productCategories 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 |
StringThe 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 |
ByteStringThe 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ProductSearchParams.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ProductSearchParams.Builder |
|