ProductArgs class

The set of arguments for Product. The set of arguments for Product.

Constructors

ProductArgs({Input<String>? description, Input<String>? displayName, Input<String>? location, Input<String>? name, Input<String>? productCategory, Input<String>? productId, Input<List<KeyValue>>? productLabels, Input<String>? project})
Creates a new ProductArgs. description User-provided metadata to be stored with this product. Must be at most 4096 characters long. displayName The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. location Optional. 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. 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. productId A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character /. 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. project Optional.
const
ProductArgs.fromMap(Map<String, dynamic> map)
factory

Properties

description → Input<String>?
User-provided metadata to be stored with this product. Must be at most 4096 characters long.
final
displayName → Input<String>?
The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
final
hashCode → int
The hash code for this object.
no setterinherited
location → Input<String>?
final
name → Input<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.
final
productCategory → Input<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.
final
productId → Input<String>?
A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character /.
final
productLabels → Input<List<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.
final
project → Input<String>?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited