Cloud Vision V1 Client - Class Product (1.9.3)

Reference documentation and code samples for the Cloud Vision V1 Client class Product.

A Product contains ReferenceImages.

Generated from protobuf message google.cloud.vision.v1.Product

Namespace

Google \ Cloud \ Vision \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

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.

↳ display_name string

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

↳ description string

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

↳ product_category string

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.

↳ product_labels array<Google\Cloud\Vision\V1\Product\KeyValue>

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.

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
Type Description
string

setName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

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

Returns
Type Description
string

setDisplayName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

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

Returns
Type Description
string

setDescription

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

Parameter
Name Description
var string
Returns
Type Description
$this

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
Type Description
string

setProductCategory

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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
Type Description
Google\Protobuf\Internal\RepeatedField

setProductLabels

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.

Parameter
Name Description
var array<Google\Cloud\Vision\V1\Product\KeyValue>
Returns
Type Description
$this