Cloud Vision V1p4beta1 API - Class Google::Cloud::Vision::V1p4beta1::Product (v0.5.1)

Reference documentation and code samples for the Cloud Vision V1p4beta1 API class Google::Cloud::Vision::V1p4beta1::Product.

A Product contains ReferenceImages.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String
Returns
  • (::String) — User-provided metadata to be stored with this product. Must be at most 4096 characters long.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — User-provided metadata to be stored with this product. Must be at most 4096 characters long.
Returns
  • (::String) — User-provided metadata to be stored with this product. Must be at most 4096 characters long.

#display_name

def display_name() -> ::String
Returns
  • (::String) — The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
Returns
  • (::String) — The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#product_category

def product_category() -> ::String
Returns
  • (::String) — Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products.

#product_category=

def product_category=(value) -> ::String
Parameter
  • value (::String) — Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products.
Returns
  • (::String) — Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products.

#product_labels

def product_labels() -> ::Array<::Google::Cloud::Vision::V1p4beta1::Product::KeyValue>
Returns
  • (::Array<::Google::Cloud::Vision::V1p4beta1::Product::KeyValue>) — 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.

#product_labels=

def product_labels=(value) -> ::Array<::Google::Cloud::Vision::V1p4beta1::Product::KeyValue>
Parameter
  • value (::Array<::Google::Cloud::Vision::V1p4beta1::Product::KeyValue>) — 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.

Returns
  • (::Array<::Google::Cloud::Vision::V1p4beta1::Product::KeyValue>) — 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.