Package-level declarations

Types

Link copied to clipboard
class Product : KotlinCustomResource

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.

Link copied to clipboard
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.

Link copied to clipboard
Link copied to clipboard
object ProductMapper : ResourceMapper<Product>
Link copied to clipboard
Link copied to clipboard
class ProductSet : KotlinCustomResource

Creates and returns a new ProductSet resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.

Link copied to clipboard
data class ProductSetArgs(val displayName: Output<String>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val productSetId: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<ProductSetArgs>

Creates and returns a new ProductSet resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.

Link copied to clipboard
Link copied to clipboard
object ProductSetMapper : ResourceMapper<ProductSet>
Link copied to clipboard
Link copied to clipboard
class ReferenceImage : KotlinCustomResource

Creates and returns a new ReferenceImage resource. The bounding_poly field is optional. If bounding_poly is not specified, the system will try to detect regions of interest in the image that are compatible with the product_category on the parent product. If it is specified, detection is ALWAYS skipped. The system converts polygons into non-rotated rectangles. Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP). Possible errors: * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if the product does not exist. * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected. * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.

Link copied to clipboard
data class ReferenceImageArgs(val boundingPolys: Output<List<BoundingPolyArgs>>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val productId: Output<String>? = null, val project: Output<String>? = null, val referenceImageId: Output<String>? = null, val uri: Output<String>? = null) : ConvertibleToJava<ReferenceImageArgs>

Creates and returns a new ReferenceImage resource. The bounding_poly field is optional. If bounding_poly is not specified, the system will try to detect regions of interest in the image that are compatible with the product_category on the parent product. If it is specified, detection is ALWAYS skipped. The system converts polygons into non-rotated rectangles. Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP). Possible errors: * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if the product does not exist. * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected. * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.

Link copied to clipboard
Link copied to clipboard
object ReferenceImageMapper : ResourceMapper<ReferenceImage>
Link copied to clipboard

Functions

Link copied to clipboard
fun product(name: String): Product
suspend fun product(name: String, block: suspend ProductResourceBuilder.() -> Unit): Product
Link copied to clipboard
suspend fun productSet(name: String, block: suspend ProductSetResourceBuilder.() -> Unit): ProductSet
Link copied to clipboard