Class: Google::Apis::VisionV1::Product

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

Overview

A Product contains ReferenceImages.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Product

Returns a new instance of Product



11715
11716
11717
 
# File 'generated/google/apis/vision_v1/classes.rb', line 11715

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

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (String) 


11676
11677
11678
 
# File 'generated/google/apis/vision_v1/classes.rb', line 11676

def description
  @description
end

#display_name ⇒ String

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) 


11682
11683
11684
 
# File 'generated/google/apis/vision_v1/classes.rb', line 11682

def display_name
  @display_name
end

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

Returns:

  • (String) 


11690
11691
11692
 
# File 'generated/google/apis/vision_v1/classes.rb', line 11690

def name
  @name
end

#product_category ⇒ String

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. This field is immutable. Corresponds to the JSON property productCategory

Returns:

  • (String) 


11699
11700
11701
 
# File 'generated/google/apis/vision_v1/classes.rb', line 11699

def product_category
  @product_category
end

#product_labels ⇒ Array<Google::Apis::VisionV1::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

Returns:



11713
11714
11715
 
# File 'generated/google/apis/vision_v1/classes.rb', line 11713

def product_labels
  @product_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11720
11721
11722
11723
11724
11725
11726
 
# File 'generated/google/apis/vision_v1/classes.rb', line 11720

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