public final class Product extends GeneratedMessageV3 implements ProductOrBuilder
A Product contains ReferenceImages.
Protobuf type google.cloud.vision.v1.Product
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PRODUCT_CATEGORY_FIELD_NUMBER
public static final int PRODUCT_CATEGORY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PRODUCT_LABELS_FIELD_NUMBER
public static final int PRODUCT_LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Product getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Product.Builder newBuilder()
newBuilder(Product prototype)
public static Product.Builder newBuilder(Product prototype)
| Parameter |
| Name |
Description |
prototype |
Product
|
public static Product parseDelimitedFrom(InputStream input)
public static Product parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Product parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Product parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Product parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Product parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Product parseFrom(CodedInputStream input)
public static Product parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Product parseFrom(InputStream input)
public static Product parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Product parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Product parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Product> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Product getDefaultInstanceForType()
getDescription()
public 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 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 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 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()
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 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.
|
getParserForType()
public Parser<Product> getParserForType()
Overrides
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];
| Returns |
| 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];
| Returns |
| 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;
| Parameter |
| Name |
Description |
index |
int
|
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;
| Returns |
| 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;
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;
| Parameter |
| Name |
Description |
index |
int
|
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;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.vision.v1.Product.KeyValueOrBuilder> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Product.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Product.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Product.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
