public final class ProductSearchParams extends GeneratedMessageV3 implements ProductSearchParamsOrBuilder
Parameters for a product search request.
Protobuf type google.cloud.vision.v1p3beta1.ProductSearchParams
Static Fields
BOUNDING_POLY_FIELD_NUMBER
public static final int BOUNDING_POLY_FIELD_NUMBER
Field Value
CATALOG_NAME_FIELD_NUMBER
public static final int CATALOG_NAME_FIELD_NUMBER
Field Value
CATEGORY_FIELD_NUMBER
public static final int CATEGORY_FIELD_NUMBER
Field Value
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
NORMALIZED_BOUNDING_POLY_FIELD_NUMBER
public static final int NORMALIZED_BOUNDING_POLY_FIELD_NUMBER
Field Value
PRODUCT_CATEGORIES_FIELD_NUMBER
public static final int PRODUCT_CATEGORIES_FIELD_NUMBER
Field Value
PRODUCT_CATEGORY_FIELD_NUMBER
public static final int PRODUCT_CATEGORY_FIELD_NUMBER
Field Value
PRODUCT_SET_FIELD_NUMBER
public static final int PRODUCT_SET_FIELD_NUMBER
Field Value
VIEW_FIELD_NUMBER
public static final int VIEW_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.
Optional. If it is not specified, system discretion will be applied.
.google.cloud.vision.v1p3beta1.BoundingPoly bounding_poly = 9;
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;
getCatalogName()
public String getCatalogName()
The resource name of the catalog to search.
Format is: productSearch/catalogs/CATALOG_NAME.
string catalog_name = 1;
| 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;
| 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;
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;
| Type | Description |
| int | The enum numeric value on the wire for category.
|
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.
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;
| 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;
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;
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;
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" or "apparel" should be
specified.
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" or "apparel" should be
specified.
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" or "apparel" should be
specified.
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" or "apparel" should be
specified.
repeated string product_categories = 7;
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;
| 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;
| 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) = { ... }
| 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
getView()
public ProductSearchResultsView getView()
Specifies the verbosity of the product search results.
Optional. Defaults to BASIC.
.google.cloud.vision.v1p3beta1.ProductSearchResultsView view = 4;
getViewValue()
public int getViewValue()
Specifies the verbosity of the product search results.
Optional. Defaults to BASIC.
.google.cloud.vision.v1p3beta1.ProductSearchResultsView view = 4;
| 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;
| 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;
| Type | Description |
| boolean | Whether the normalizedBoundingPoly 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
