public static final class ProductSearchParams.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ProductSearchParams.Builder> implements ProductSearchParamsOrBuilder
Parameters for a product search request.Protobuf type
google.cloud.vision.v1p3beta1.ProductSearchParams| Modifier and Type | Method and Description |
|---|---|
ProductSearchParams.Builder |
addAllProductCategories(Iterable<String> values)
The list of product categories to search in.
|
ProductSearchParams.Builder |
addProductCategories(String value)
The list of product categories to search in.
|
ProductSearchParams.Builder |
addProductCategoriesBytes(com.google.protobuf.ByteString value)
The list of product categories to search in.
|
ProductSearchParams.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ProductSearchParams |
build() |
ProductSearchParams |
buildPartial() |
ProductSearchParams.Builder |
clear() |
ProductSearchParams.Builder |
clearBoundingPoly()
The bounding polygon around the area of interest in the image.
|
ProductSearchParams.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
ProductSearchParams.Builder |
clearFilter()
The filtering expression.
|
ProductSearchParams.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
ProductSearchParams.Builder |
clearProductCategories()
The list of product categories to search in.
|
ProductSearchParams.Builder |
clearProductSet()
The resource name of a [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be searched for similar images.
|
ProductSearchParams.Builder |
clone() |
BoundingPoly |
getBoundingPoly()
The bounding polygon around the area of interest in the image.
|
BoundingPoly.Builder |
getBoundingPolyBuilder()
The bounding polygon around the area of interest in the image.
|
BoundingPolyOrBuilder |
getBoundingPolyOrBuilder()
The bounding polygon around the area of interest in the image.
|
ProductSearchParams |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getFilter()
The filtering expression.
|
com.google.protobuf.ByteString |
getFilterBytes()
The filtering expression.
|
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.
|
com.google.protobuf.ProtocolStringList |
getProductCategoriesList()
The list of product categories 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.
|
boolean |
hasBoundingPoly()
The bounding polygon around the area of interest in the image.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ProductSearchParams.Builder |
mergeBoundingPoly(BoundingPoly value)
The bounding polygon around the area of interest in the image.
|
ProductSearchParams.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ProductSearchParams.Builder |
mergeFrom(com.google.protobuf.Message other) |
ProductSearchParams.Builder |
mergeFrom(ProductSearchParams other) |
ProductSearchParams.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
ProductSearchParams.Builder |
setBoundingPoly(BoundingPoly.Builder builderForValue)
The bounding polygon around the area of interest in the image.
|
ProductSearchParams.Builder |
setBoundingPoly(BoundingPoly value)
The bounding polygon around the area of interest in the image.
|
ProductSearchParams.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ProductSearchParams.Builder |
setFilter(String value)
The filtering expression.
|
ProductSearchParams.Builder |
setFilterBytes(com.google.protobuf.ByteString value)
The filtering expression.
|
ProductSearchParams.Builder |
setProductCategories(int index,
String value)
The list of product categories to search in.
|
ProductSearchParams.Builder |
setProductSet(String value)
The resource name of a [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be searched for similar images.
|
ProductSearchParams.Builder |
setProductSetBytes(com.google.protobuf.ByteString value)
The resource name of a [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be searched for similar images.
|
ProductSearchParams.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
ProductSearchParams.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ProductSearchParams.Builder>public ProductSearchParams.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<ProductSearchParams.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ProductSearchParams.Builder>public ProductSearchParams getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic ProductSearchParams build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic ProductSearchParams buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic ProductSearchParams.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<ProductSearchParams.Builder>public ProductSearchParams.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<ProductSearchParams.Builder>public ProductSearchParams.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<ProductSearchParams.Builder>public ProductSearchParams.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ProductSearchParams.Builder>public ProductSearchParams.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ProductSearchParams.Builder>public ProductSearchParams.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ProductSearchParams.Builder>public ProductSearchParams.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProductSearchParams.Builder>public ProductSearchParams.Builder mergeFrom(ProductSearchParams other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ProductSearchParams.Builder>public ProductSearchParams.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProductSearchParams.Builder>IOExceptionpublic 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.v1p3beta1.BoundingPoly bounding_poly = 9;hasBoundingPoly in interface ProductSearchParamsOrBuilderpublic 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.v1p3beta1.BoundingPoly bounding_poly = 9;getBoundingPoly in interface ProductSearchParamsOrBuilderpublic 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.v1p3beta1.BoundingPoly bounding_poly = 9;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.v1p3beta1.BoundingPoly bounding_poly = 9;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.v1p3beta1.BoundingPoly bounding_poly = 9;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.v1p3beta1.BoundingPoly bounding_poly = 9;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.v1p3beta1.BoundingPoly bounding_poly = 9;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.v1p3beta1.BoundingPoly bounding_poly = 9;getBoundingPolyOrBuilder in interface ProductSearchParamsOrBuilderpublic 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) = { ... }getProductSet in interface ProductSearchParamsOrBuilderpublic 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) = { ... }getProductSetBytes in interface ProductSearchParamsOrBuilderpublic ProductSearchParams.Builder setProductSet(String value)
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) = { ... }value - The productSet to set.public ProductSearchParams.Builder clearProductSet()
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) = { ... }public ProductSearchParams.Builder setProductSetBytes(com.google.protobuf.ByteString value)
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) = { ... }value - The bytes for productSet to set.public com.google.protobuf.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;getProductCategoriesList in interface ProductSearchParamsOrBuilderpublic 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;getProductCategoriesCount in interface ProductSearchParamsOrBuilderpublic 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;getProductCategories in interface ProductSearchParamsOrBuilderindex - The index of the element to return.public 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-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;getProductCategoriesBytes in interface ProductSearchParamsOrBuilderindex - The index of the value to return.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;index - The index to set the value at.value - The productCategories to set.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;value - The productCategories to add.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;values - The productCategories to add.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;public ProductSearchParams.Builder addProductCategoriesBytes(com.google.protobuf.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;value - The bytes of the productCategories to add.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;getFilter in interface ProductSearchParamsOrBuilderpublic 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. 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;getFilterBytes in interface ProductSearchParamsOrBuilderpublic 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;value - The filter to set.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;public ProductSearchParams.Builder setFilterBytes(com.google.protobuf.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;value - The bytes for filter to set.public final ProductSearchParams.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ProductSearchParams.Builder>public final ProductSearchParams.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ProductSearchParams.Builder>Copyright © 2023 Google LLC. All rights reserved.