- 3.52.0 (latest)
- 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 static final class Product.Builder extends GeneratedMessageV3.Builder<Product.Builder> implements ProductOrBuilderA Product contains ReferenceImages.
Protobuf type google.cloud.vision.v1.Product
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Product.BuilderImplements
ProductOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addAllProductLabels(Iterable<? extends Product.KeyValue> values)
public Product.Builder addAllProductLabels(Iterable<? extends Product.KeyValue> values)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;
| Name | Description |
| values | Iterable<? extends com.google.cloud.vision.v1.Product.KeyValue> |
| Type | Description |
| Product.Builder |
addProductLabels(Product.KeyValue value)
public Product.Builder addProductLabels(Product.KeyValue value)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;
| Name | Description |
| value | Product.KeyValue |
| Type | Description |
| Product.Builder |
addProductLabels(Product.KeyValue.Builder builderForValue)
public Product.Builder addProductLabels(Product.KeyValue.Builder builderForValue)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;
| Name | Description |
| builderForValue | Product.KeyValue.Builder |
| Type | Description |
| Product.Builder |
addProductLabels(int index, Product.KeyValue value)
public Product.Builder addProductLabels(int index, Product.KeyValue value)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;
| Name | Description |
| index | int |
| value | Product.KeyValue |
| Type | Description |
| Product.Builder |
addProductLabels(int index, Product.KeyValue.Builder builderForValue)
public Product.Builder addProductLabels(int index, Product.KeyValue.Builder builderForValue)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;
| Name | Description |
| index | int |
| builderForValue | Product.KeyValue.Builder |
| Type | Description |
| Product.Builder |
addProductLabelsBuilder()
public Product.KeyValue.Builder addProductLabelsBuilder()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;
| Type | Description |
| Product.KeyValue.Builder |
addProductLabelsBuilder(int index)
public Product.KeyValue.Builder addProductLabelsBuilder(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;
| Name | Description |
| index | int |
| Type | Description |
| Product.KeyValue.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Product.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| Product.Builder |
build()
public Product build()| Type | Description |
| Product |
buildPartial()
public Product buildPartial()| Type | Description |
| Product |
clear()
public Product.Builder clear()| Type | Description |
| Product.Builder |
clearDescription()
public Product.Builder clearDescription()User-provided metadata to be stored with this product. Must be at most 4096 characters long.
string description = 3;
| Type | Description |
| Product.Builder | This builder for chaining. |
clearDisplayName()
public Product.Builder clearDisplayName()The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
string display_name = 2;
| Type | Description |
| Product.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Product.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| Product.Builder |
clearName()
public Product.Builder clearName() 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;
| Type | Description |
| Product.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Product.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| Product.Builder |
clearProductCategory()
public Product.Builder clearProductCategory()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];
| Type | Description |
| Product.Builder | This builder for chaining. |
clearProductLabels()
public Product.Builder clearProductLabels()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;
| Type | Description |
| Product.Builder |
clone()
public Product.Builder clone()| Type | Description |
| Product.Builder |
getDefaultInstanceForType()
public Product getDefaultInstanceForType()| Type | Description |
| Product |
getDescription()
public String getDescription()User-provided metadata to be stored with this product. Must be at most 4096 characters long.
string description = 3;
| Type | Description |
| String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()User-provided metadata to be stored with this product. Must be at most 4096 characters long.
string description = 3;
| Type | Description |
| ByteString | The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getDisplayName()
public String getDisplayName()The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
string display_name = 2;
| Type | Description |
| String | The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
string display_name = 2;
| Type | Description |
| ByteString | The bytes for displayName. |
getName()
public 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;
| Type | Description |
| String | The name. |
getNameBytes()
public 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;
| Type | Description |
| ByteString | The bytes for name. |
getProductCategory()
public 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];
| Type | Description |
| String | The productCategory. |
getProductCategoryBytes()
public 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];
| Type | Description |
| ByteString | The bytes for productCategory. |
getProductLabels(int index)
public 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;
| Name | Description |
| index | int |
| Type | Description |
| Product.KeyValue |
getProductLabelsBuilder(int index)
public Product.KeyValue.Builder getProductLabelsBuilder(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;
| Name | Description |
| index | int |
| Type | Description |
| Product.KeyValue.Builder |
getProductLabelsBuilderList()
public List<Product.KeyValue.Builder> getProductLabelsBuilderList()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;
| Type | Description |
| List<Builder> |
getProductLabelsCount()
public 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;
| Type | Description |
| int |
getProductLabelsList()
public 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;
| Type | Description |
| List<KeyValue> |
getProductLabelsOrBuilder(int index)
public 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;
| Name | Description |
| index | int |
| Type | Description |
| Product.KeyValueOrBuilder |
getProductLabelsOrBuilderList()
public 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;
| Type | Description |
| List<? extends com.google.cloud.vision.v1.Product.KeyValueOrBuilder> |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(Product other)
public Product.Builder mergeFrom(Product other)| Name | Description |
| other | Product |
| Type | Description |
| Product.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Product.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Product.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public Product.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| Product.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Product.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| Product.Builder |
removeProductLabels(int index)
public Product.Builder removeProductLabels(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;
| Name | Description |
| index | int |
| Type | Description |
| Product.Builder |
setDescription(String value)
public Product.Builder setDescription(String value)User-provided metadata to be stored with this product. Must be at most 4096 characters long.
string description = 3;
| Name | Description |
| value | StringThe description to set. |
| Type | Description |
| Product.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public Product.Builder setDescriptionBytes(ByteString value)User-provided metadata to be stored with this product. Must be at most 4096 characters long.
string description = 3;
| Name | Description |
| value | ByteStringThe bytes for description to set. |
| Type | Description |
| Product.Builder | This builder for chaining. |
setDisplayName(String value)
public Product.Builder setDisplayName(String value)The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
string display_name = 2;
| Name | Description |
| value | StringThe displayName to set. |
| Type | Description |
| Product.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Product.Builder setDisplayNameBytes(ByteString value)The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
string display_name = 2;
| Name | Description |
| value | ByteStringThe bytes for displayName to set. |
| Type | Description |
| Product.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Product.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| Product.Builder |
setName(String value)
public Product.Builder setName(String value) 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;
| Name | Description |
| value | StringThe name to set. |
| Type | Description |
| Product.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Product.Builder setNameBytes(ByteString value) 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;
| Name | Description |
| value | ByteStringThe bytes for name to set. |
| Type | Description |
| Product.Builder | This builder for chaining. |
setProductCategory(String value)
public Product.Builder setProductCategory(String value)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];
| Name | Description |
| value | StringThe productCategory to set. |
| Type | Description |
| Product.Builder | This builder for chaining. |
setProductCategoryBytes(ByteString value)
public Product.Builder setProductCategoryBytes(ByteString value)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];
| Name | Description |
| value | ByteStringThe bytes for productCategory to set. |
| Type | Description |
| Product.Builder | This builder for chaining. |
setProductLabels(int index, Product.KeyValue value)
public Product.Builder setProductLabels(int index, Product.KeyValue value)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;
| Name | Description |
| index | int |
| value | Product.KeyValue |
| Type | Description |
| Product.Builder |
setProductLabels(int index, Product.KeyValue.Builder builderForValue)
public Product.Builder setProductLabels(int index, Product.KeyValue.Builder builderForValue)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;
| Name | Description |
| index | int |
| builderForValue | Product.KeyValue.Builder |
| Type | Description |
| Product.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Product.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| Product.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final Product.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| Product.Builder |