public final class ProductSearchParams extends GeneratedMessageV3 implements ProductSearchParamsOrBuilder
Parameters for a product search request.
Protobuf type google.cloud.vision.v1.ProductSearchParams
Static Fields
BOUNDING_POLY_FIELD_NUMBER
public static final int BOUNDING_POLY_FIELD_NUMBER
Field Value
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
PRODUCT_CATEGORIES_FIELD_NUMBER
public static final int PRODUCT_CATEGORIES_FIELD_NUMBER
Field Value
PRODUCT_SET_FIELD_NUMBER
public static final int PRODUCT_SET_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ProductSearchParams getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ProductSearchParams.Builder newBuilder()
Returns
newBuilder(ProductSearchParams prototype)
public static ProductSearchParams.Builder newBuilder(ProductSearchParams prototype)
Parameter
Returns
public static ProductSearchParams parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ProductSearchParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ProductSearchParams parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ProductSearchParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ProductSearchParams parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ProductSearchParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ProductSearchParams parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ProductSearchParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ProductSearchParams parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ProductSearchParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ProductSearchParams parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ProductSearchParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ProductSearchParams> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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.v1.BoundingPoly bounding_poly = 9;
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.v1.BoundingPoly bounding_poly = 9;
getDefaultInstanceForType()
public ProductSearchParams getDefaultInstanceForType()
Returns
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;
| 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;
getParserForType()
public Parser<ProductSearchParams> getParserForType()
Returns
Overrides
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;
| 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-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;
| 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-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;
| 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;
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) = { ... }
| 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) = { ... }
| Type |
Description |
| ByteString |
The bytes for productSet.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.v1.BoundingPoly bounding_poly = 9;
| Type |
Description |
| boolean |
Whether the boundingPoly field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ProductSearchParams.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ProductSearchParams.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ProductSearchParams.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
