GetProductResult class
Result data returned by getProduct.
Constructors
-
GetProductResult({required String description, required String displayName, required String name, required String productCategory, required List<
KeyValueResponse> productLabels}) -
Creates a new GetProductResult.
descriptionUser-provided metadata to be stored with this product. Must be at most 4096 characters long.displayNameThe user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.nameThe resource name of the product. Format is:projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID. This field is ignored when creating a product.productCategoryImmutable. 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.productLabelsKey-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.const -
GetProductResult.fromMap(Map<
String, dynamic> map) -
factory
Properties
- description → String
-
User-provided metadata to be stored with this product. Must be at most 4096 characters long.
final
- displayName → 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
- 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.final - productCategory → 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
-
productLabels
→ List<
KeyValueResponse> -
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
- 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