Class: Google::Apis::VisionV1p1beta1::Product

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/vision_v1p1beta1/classes.rb,
generated/google/apis/vision_v1p1beta1/representations.rb,
generated/google/apis/vision_v1p1beta1/representations.rb

Overview

A Product contains ReferenceImages.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Product

Returns a new instance of Product.



9266
9267
9268
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9266

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#descriptionString

User-provided metadata to be stored with this product. Must be at most 4096 characters long. Corresponds to the JSON property description

Returns:

  • (String)


9232
9233
9234
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9232

def description
  @description
end

#display_nameString

The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. Corresponds to the JSON property displayName

Returns:

  • (String)


9238
9239
9240
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9238

def display_name
  @display_name
end

#nameString

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. Corresponds to the JSON property name

Returns:

  • (String)


9244
9245
9246
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9244

def name
  @name
end

#product_categoryString

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. Corresponds to the JSON property productCategory

Returns:

  • (String)


9252
9253
9254
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9252

def product_category
  @product_category
end

#product_labelsArray<Google::Apis::VisionV1p1beta1::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. Corresponds to the JSON property productLabels



9264
9265
9266
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9264

def product_labels
  @product_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9271
9272
9273
9274
9275
9276
9277
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9271

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @name = args[:name] if args.key?(:name)
  @product_category = args[:product_category] if args.key?(:product_category)
  @product_labels = args[:product_labels] if args.key?(:product_labels)
end