- 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 interface ProductOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDescription()
public abstract String getDescription()User-provided metadata to be stored with this product. Must be at most 4096 characters long.
string description = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()User-provided metadata to be stored with this product. Must be at most 4096 characters long.
string description = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDisplayName()
public abstract String getDisplayName()The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes()The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getName()
public abstract String getName()The resource name of the product.
Format is:
projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.
This field is ignored when creating a product.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes()The resource name of the product.
Format is:
projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.
This field is ignored when creating a product.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getProductCategory()
public abstract String getProductCategory()Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products.
string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String |
The productCategory. |
getProductCategoryBytes()
public abstract ByteString getProductCategoryBytes()Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products.
string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for productCategory. |
getProductLabels(int index)
public abstract Product.KeyValue getProductLabels(int index)Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels.
Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon.
Multiple values can be assigned to the same key. One product may have up to 500 product_labels.
Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.
repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Product.KeyValue |
|
getProductLabelsCount()
public abstract int getProductLabelsCount()Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels.
Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon.
Multiple values can be assigned to the same key. One product may have up to 500 product_labels.
Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.
repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;
| Returns | |
|---|---|
| Type | Description |
int |
|
getProductLabelsList()
public abstract List<Product.KeyValue> getProductLabelsList()Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels.
Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon.
Multiple values can be assigned to the same key. One product may have up to 500 product_labels.
Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.
repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;
| Returns | |
|---|---|
| Type | Description |
List<KeyValue> |
|
getProductLabelsOrBuilder(int index)
public abstract Product.KeyValueOrBuilder getProductLabelsOrBuilder(int index)Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels.
Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon.
Multiple values can be assigned to the same key. One product may have up to 500 product_labels.
Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.
repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Product.KeyValueOrBuilder |
|
getProductLabelsOrBuilderList()
public abstract List<? extends Product.KeyValueOrBuilder> getProductLabelsOrBuilderList()Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels.
Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon.
Multiple values can be assigned to the same key. One product may have up to 500 product_labels.
Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.
repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.vision.v1.Product.KeyValueOrBuilder> |
|