com.google.api.services.vision.v1.model

Class Product

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.vision.v1.model.Product

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Product
extends GenericJson

A Product contains ReferenceImages.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Vision API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Product()

Method Summary

Modifier and Type	Method and Description
Product	clone()
String	getDescription() User-provided metadata to be stored with this product.
String	getDisplayName() The user-provided name for this Product.
String	getName() The resource name of the product.
String	getProductCategory() Immutable.
List<KeyValue>	getProductLabels() Key-value pairs that can be attached to a product.
Product	set(String fieldName, Object value)
Product	setDescription(String description) User-provided metadata to be stored with this product.
Product	setDisplayName(String displayName) The user-provided name for this Product.
Product	setName(String name) The resource name of the product.
Product	setProductCategory(String productCategory) Immutable.
Product	setProductLabels(List<KeyValue> productLabels) Key-value pairs that can be attached to a product.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Product

public Product()

Method Detail

getDescription

public String getDescription()

User-provided metadata to be stored with this product. Must be at most 4096 characters long.

Returns:

value or null for none

setDescription

public Product setDescription(String description)

User-provided metadata to be stored with this product. Must be at most 4096 characters long.

Parameters:

description - description or null for none

getDisplayName

public String getDisplayName()

The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.

Returns:

value or null for none

setDisplayName

public Product setDisplayName(String displayName)

The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.

Parameters:

displayName - displayName or null for none

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.

Returns:

value or null for none

setName

public Product setName(String name)

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.

Parameters:

name - name or null for none

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.

Returns:

value or null for none

setProductCategory

public Product setProductCategory(String productCategory)

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.

Parameters:

productCategory - productCategory or null for none

getProductLabels

public List<KeyValue> getProductLabels()

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.

Returns:

value or null for none

setProductLabels

public Product setProductLabels(List<KeyValue> productLabels)

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.

Parameters:

productLabels - productLabels or null for none

set

public Product set(String fieldName,
                   Object value)

Overrides:

set in class GenericJson

clone

public Product clone()

Overrides:

clone in class GenericJson