import * as pulumi from "@pulumi/pulumi"; import { input as inputs, output as outputs } from "../../types"; /** * Creates a catalog item. */ export declare class CatalogCatalogItem extends pulumi.CustomResource { /** * Get an existing CatalogCatalogItem resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): CatalogCatalogItem; /** * Returns true if the given object is an instance of CatalogCatalogItem. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is CatalogCatalogItem; /** * Required. 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" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categoryHierarchies": [ { "categories": ["Shoes & Accessories", "Shoes"]}, { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] } ] */ readonly categoryHierarchies: pulumi.Output; /** * Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB. */ readonly description: pulumi.Output; /** * 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. */ readonly itemAttributes: pulumi.Output; /** * 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](/recommendations-ai/docs/catalog#item-group-id). */ readonly itemGroupId: pulumi.Output; /** * Optional. Metadata specific to retail products. */ readonly productMetadata: pulumi.Output; /** * 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. */ readonly tags: pulumi.Output; /** * Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB. */ readonly title: pulumi.Output; /** * Create a CatalogCatalogItem resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: CatalogCatalogItemArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a CatalogCatalogItem resource. */ export interface CatalogCatalogItemArgs { readonly catalogItemsId: pulumi.Input; readonly catalogsId: pulumi.Input; /** * Required. 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" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categoryHierarchies": [ { "categories": ["Shoes & Accessories", "Shoes"]}, { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] } ] */ readonly categoryHierarchies?: pulumi.Input[]>; /** * Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB. */ readonly description?: pulumi.Input; /** * Required. 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. */ readonly id?: pulumi.Input; /** * 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. */ readonly itemAttributes?: pulumi.Input; /** * 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](/recommendations-ai/docs/catalog#item-group-id). */ readonly itemGroupId?: pulumi.Input; readonly locationsId: pulumi.Input; /** * Optional. Metadata specific to retail products. */ readonly productMetadata?: pulumi.Input; readonly projectsId: pulumi.Input; /** * 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. */ readonly tags?: pulumi.Input[]>; /** * Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB. */ readonly title?: pulumi.Input; }