Interface ProductOrBuilder (3.22.0)

public interface ProductOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getProductCategory()

public abstract String getProductCategory()

Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". 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
TypeDescription
String

The productCategory.

getProductCategoryBytes()

public abstract ByteString getProductCategoryBytes()

Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". 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
TypeDescription
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.v1p4beta1.Product.KeyValue product_labels = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1p4beta1.Product.KeyValue product_labels = 5;

Returns
TypeDescription
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.v1p4beta1.Product.KeyValue product_labels = 5;

Returns
TypeDescription
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.v1p4beta1.Product.KeyValue product_labels = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1p4beta1.Product.KeyValue product_labels = 5;

Returns
TypeDescription
List<? extends com.google.cloud.vision.v1p4beta1.Product.KeyValueOrBuilder>