Google Cloud Native v0.30.0, Apr 14 23

google-native.vision/v1.getProduct

Explore with Pulumi AI

Gets information associated with a Product. Possible errors: * Returns NOT_FOUND if the Product does not exist.

Using getProduct

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getProduct(args: GetProductArgs, opts?: InvokeOptions): Promise<GetProductResult>
function getProductOutput(args: GetProductOutputArgs, opts?: InvokeOptions): Output<GetProductResult>

def get_product(location: Optional[str] = None,
                product_id: Optional[str] = None,
                project: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetProductResult
def get_product_output(location: Optional[pulumi.Input[str]] = None,
                product_id: Optional[pulumi.Input[str]] = None,
                project: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetProductResult]

func LookupProduct(ctx *Context, args *LookupProductArgs, opts ...InvokeOption) (*LookupProductResult, error)
func LookupProductOutput(ctx *Context, args *LookupProductOutputArgs, opts ...InvokeOption) LookupProductResultOutput

> Note: This function is named LookupProduct in the Go SDK.

public static class GetProduct 
{
    public static Task<GetProductResult> InvokeAsync(GetProductArgs args, InvokeOptions? opts = null)
    public static Output<GetProductResult> Invoke(GetProductInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetProductResult> getProduct(GetProductArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:vision/v1:getProduct
  arguments:
    # arguments dictionary

The following arguments are supported:

Location string
ProductId string
Project string

Location string
ProductId string
Project string

location String
productId String
project String

location string
productId string
project string

location str
product_id str
project str

location String
productId String
project String

getProduct Result

The following output properties are available:

Description string: User-provided metadata to be stored with this product. Must be at most 4096 characters long.
DisplayName string: The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
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.
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.
ProductLabels List<Pulumi.GoogleNative.Vision.V1.Outputs.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.

Description string: User-provided metadata to be stored with this product. Must be at most 4096 characters long.
DisplayName string: The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
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.
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.
ProductLabels []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.

description String: User-provided metadata to be stored with this product. Must be at most 4096 characters long.
displayName String: The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
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.
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.
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.

description string: User-provided metadata to be stored with this product. Must be at most 4096 characters long.
displayName string: The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
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.
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.
productLabels 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.

description str: User-provided metadata to be stored with this product. Must be at most 4096 characters long.
display_name str: The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
name str: 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.
product_category str: 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.
product_labels Sequence[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.

description String: User-provided metadata to be stored with this product. Must be at most 4096 characters long.
displayName String: The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
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.
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.
productLabels List<Property Map>: 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.

Supporting Types

KeyValueResponse

Key string: The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.
Value string: The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.

Key string: The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.
Value string: The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.

key String: The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.
value String: The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.

key string: The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.
value string: The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.

key str: The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.
value str: The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.

key String: The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.
value String: The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0