ProductArgs

data class ProductArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val productCategory: Output<String>? = null, val productId: Output<String>? = null, val productLabels: Output<List<KeyValueArgs>>? = null, val project: Output<String>? = null) : ConvertibleToJava<ProductArgs>

Creates and returns a new product resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is missing or invalid.

Constructors

Link copied to clipboard
fun ProductArgs(description: Output<String>? = null, displayName: Output<String>? = null, location: Output<String>? = null, name: Output<String>? = null, productCategory: Output<String>? = null, productId: Output<String>? = null, productLabels: Output<List<KeyValueArgs>>? = null, project: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): ProductArgs

Properties

Link copied to clipboard
val description: Output<String>? = null

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

Link copied to clipboard
val displayName: Output<String>? = null

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

Link copied to clipboard
val location: Output<String>? = null
Link copied to clipboard
val name: Output<String>? = null

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.

Link copied to clipboard
val productCategory: Output<String>? = null

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.

Link copied to clipboard
val productId: Output<String>? = null

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 /.

Link copied to clipboard
val productLabels: Output<List<KeyValueArgs>>? = null

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.

Link copied to clipboard
val project: Output<String>? = null