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

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



11995
11996
11997
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 11995

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)


11956
11957
11958
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 11956

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)


11962
11963
11964
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 11962

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)


11970
11971
11972
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 11970

def name
  @name
end

#product_categoryString

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)


11979
11980
11981
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 11979

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



11993
11994
11995
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 11993

def product_labels
  @product_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12000
12001
12002
12003
12004
12005
12006
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 12000

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