Class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1Product
- Inherits:
-
Object
- Object
- Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1Product
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/vision_v1p2beta1/classes.rb,
generated/google/apis/vision_v1p2beta1/representations.rb,
generated/google/apis/vision_v1p2beta1/representations.rb
Overview
A Product contains ReferenceImages.
Instance Attribute Summary collapse
-
#description ⇒ String
User-provided metadata to be stored with this product.
-
#display_name ⇒ String
The user-provided name for this Product.
-
#name ⇒ String
The resource name of the product.
-
#product_category ⇒ String
The category for the product identified by the reference image.
-
#product_labels ⇒ Array<Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductKeyValue>
Key-value pairs that can be attached to a product.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudVisionV1p2beta1Product
constructor
A new instance of GoogleCloudVisionV1p2beta1Product.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudVisionV1p2beta1Product
Returns a new instance of GoogleCloudVisionV1p2beta1Product
4388 4389 4390 |
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 4388 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
4349 4350 4351 |
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 4349 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
4355 4356 4357 |
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 4355 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
4363 4364 4365 |
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 4363 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
4372 4373 4374 |
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 4372 def product_category @product_category end |
#product_labels ⇒ Array<Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductKeyValue>
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
4386 4387 4388 |
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 4386 def product_labels @product_labels end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4393 4394 4395 4396 4397 4398 4399 |
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 4393 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 |