CatalogItemArgs class

The set of arguments for CatalogItem. The set of arguments for CatalogItem.

Constructors

CatalogItemArgs({required Input<String> catalogId, required Input<List<GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy>> categoryHierarchies, Input<String>? description, required Input<String> id, Input<GoogleCloudRecommendationengineV1beta1FeatureMap>? itemAttributes, Input<String>? itemGroupId, Input<String>? languageCode, Input<String>? location, Input<GoogleCloudRecommendationengineV1beta1ProductCatalogItem>? productMetadata, Input<String>? project, Input<List<String>>? tags, required Input<String> title})
Creates a new CatalogItemArgs. catalogId Required. categoryHierarchies Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both "Shoes & Accessories" -&gt; "Shoes" and "Sports & Fitness" -&gt; "Athletic Clothing" -&gt; "Shoes", it could be represented as: "categoryHierarchies": [ { "categories": "Shoes & Accessories", "Shoes"}, { "categories": "Sports & Fitness", "Athletic Clothing", "Shoes" } ] description Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB. id Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog. itemAttributes Optional. Highly encouraged. Extra catalog item attributes to be included in the recommendation model. For example, for retail products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the item attributes here. itemGroupId Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. Learn more. languageCode Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance. location Optional. productMetadata Optional. Metadata specific to retail products. project Optional. tags Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter. title Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.
const
CatalogItemArgs.fromMap(Map<String, dynamic> map)
factory

Properties

catalogId → Input<String>
final
categoryHierarchies → Input<List<GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy>>
Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both "Shoes & Accessories" -&gt; "Shoes" and "Sports & Fitness" -&gt; "Athletic Clothing" -&gt; "Shoes", it could be represented as: "categoryHierarchies": [ { "categories": "Shoes & Accessories", "Shoes"}, { "categories": "Sports & Fitness", "Athletic Clothing", "Shoes" } ]
final
description → Input<String>?
Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.
final
hashCode → int
The hash code for this object.
no setterinherited
id → Input<String>
Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog.
final
itemAttributes → Input<GoogleCloudRecommendationengineV1beta1FeatureMap>?
Optional. Highly encouraged. Extra catalog item attributes to be included in the recommendation model. For example, for retail products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the item attributes here.
final
itemGroupId → Input<String>?
Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. Learn more.
final
languageCode → Input<String>?
Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance.
final
location → Input<String>?
final
productMetadata → Input<GoogleCloudRecommendationengineV1beta1ProductCatalogItem>?
Optional. Metadata specific to retail products.
final
project → Input<String>?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags → Input<List<String>>?
Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter.
final
title → Input<String>
Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.
final

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