google-cloud-vision-v1 0.1.4 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +6 -6
  3. data/README.md +1 -1
  4. data/lib/google/cloud/vision/v1.rb +1 -1
  5. data/lib/google/cloud/vision/v1/image_annotator.rb +1 -1
  6. data/lib/google/cloud/vision/v1/image_annotator/client.rb +108 -108
  7. data/lib/google/cloud/vision/v1/image_annotator/credentials.rb +1 -1
  8. data/lib/google/cloud/vision/v1/image_annotator/operations.rb +100 -100
  9. data/lib/google/cloud/vision/v1/image_annotator/paths.rb +3 -3
  10. data/lib/google/cloud/vision/v1/product_search.rb +4 -4
  11. data/lib/google/cloud/vision/v1/product_search/client.rb +377 -377
  12. data/lib/google/cloud/vision/v1/product_search/credentials.rb +1 -1
  13. data/lib/google/cloud/vision/v1/product_search/operations.rb +100 -100
  14. data/lib/google/cloud/vision/v1/product_search/paths.rb +12 -12
  15. data/lib/google/cloud/vision/v1/version.rb +1 -1
  16. data/proto_docs/google/api/resource.rb +12 -12
  17. data/proto_docs/google/cloud/vision/v1/geometry.rb +17 -17
  18. data/proto_docs/google/cloud/vision/v1/image_annotator.rb +204 -204
  19. data/proto_docs/google/cloud/vision/v1/product_search.rb +28 -28
  20. data/proto_docs/google/cloud/vision/v1/product_search_service.rb +144 -144
  21. data/proto_docs/google/cloud/vision/v1/text_annotation.rb +49 -49
  22. data/proto_docs/google/cloud/vision/v1/web_detection.rb +28 -28
  23. data/proto_docs/google/longrunning/operations.rb +30 -30
  24. data/proto_docs/google/protobuf/any.rb +4 -4
  25. data/proto_docs/google/protobuf/empty.rb +2 -2
  26. data/proto_docs/google/protobuf/field_mask.rb +3 -3
  27. data/proto_docs/google/protobuf/timestamp.rb +4 -4
  28. data/proto_docs/google/protobuf/wrappers.rb +27 -27
  29. data/proto_docs/google/rpc/status.rb +6 -6
  30. data/proto_docs/google/type/color.rb +6 -6
  31. data/proto_docs/google/type/latlng.rb +4 -4
  32. metadata +2 -2
@@ -23,17 +23,17 @@ module Google
23
23
  module V1
24
24
  # Parameters for a product search request.
25
25
  # @!attribute [rw] bounding_poly
26
- # @return [Google::Cloud::Vision::V1::BoundingPoly]
26
+ # @return [::Google::Cloud::Vision::V1::BoundingPoly]
27
27
  # The bounding polygon around the area of interest in the image.
28
28
  # Optional. If it is not specified, system discretion will be applied.
29
29
  # @!attribute [rw] product_set
30
- # @return [String]
31
- # The resource name of a {Google::Cloud::Vision::V1::ProductSet ProductSet} to be searched for similar images.
30
+ # @return [::String]
31
+ # The resource name of a {::Google::Cloud::Vision::V1::ProductSet ProductSet} to be searched for similar images.
32
32
  #
33
33
  # Format is:
34
34
  # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
35
35
  # @!attribute [rw] product_categories
36
- # @return [Array<String>]
36
+ # @return [::Array<::String>]
37
37
  # The list of product categories to search in. Currently, we only consider
38
38
  # the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",
39
39
  # "packagedgoods-v1", or "general-v1" should be specified. The legacy
@@ -42,7 +42,7 @@ module Google
42
42
  # or "toys-v2" for better product search accuracy. It is recommended to
43
43
  # migrate existing products to these categories as well.
44
44
  # @!attribute [rw] filter
45
- # @return [String]
45
+ # @return [::String]
46
46
  # The filtering expression. This can be used to restrict search results based
47
47
  # on Product labels. We currently support an AND of OR of key-value
48
48
  # expressions, where each expression within an OR must have the same key. An
@@ -52,80 +52,80 @@ module Google
52
52
  # acceptable, but "(color = red OR brand = Google)" is not acceptable.
53
53
  # "color: red" is not acceptable because it uses a ':' instead of an '='.
54
54
  class ProductSearchParams
55
- include Google::Protobuf::MessageExts
56
- extend Google::Protobuf::MessageExts::ClassMethods
55
+ include ::Google::Protobuf::MessageExts
56
+ extend ::Google::Protobuf::MessageExts::ClassMethods
57
57
  end
58
58
 
59
59
  # Results for a product search request.
60
60
  # @!attribute [rw] index_time
61
- # @return [Google::Protobuf::Timestamp]
61
+ # @return [::Google::Protobuf::Timestamp]
62
62
  # Timestamp of the index which provided these results. Products added to the
63
63
  # product set and products removed from the product set after this time are
64
64
  # not reflected in the current results.
65
65
  # @!attribute [rw] results
66
- # @return [Array<Google::Cloud::Vision::V1::ProductSearchResults::Result>]
66
+ # @return [::Array<::Google::Cloud::Vision::V1::ProductSearchResults::Result>]
67
67
  # List of results, one for each product match.
68
68
  # @!attribute [rw] product_grouped_results
69
- # @return [Array<Google::Cloud::Vision::V1::ProductSearchResults::GroupedResult>]
69
+ # @return [::Array<::Google::Cloud::Vision::V1::ProductSearchResults::GroupedResult>]
70
70
  # List of results grouped by products detected in the query image. Each entry
71
71
  # corresponds to one bounding polygon in the query image, and contains the
72
72
  # matching products specific to that region. There may be duplicate product
73
73
  # matches in the union of all the per-product results.
74
74
  class ProductSearchResults
75
- include Google::Protobuf::MessageExts
76
- extend Google::Protobuf::MessageExts::ClassMethods
75
+ include ::Google::Protobuf::MessageExts
76
+ extend ::Google::Protobuf::MessageExts::ClassMethods
77
77
 
78
78
  # Information about a product.
79
79
  # @!attribute [rw] product
80
- # @return [Google::Cloud::Vision::V1::Product]
80
+ # @return [::Google::Cloud::Vision::V1::Product]
81
81
  # The Product.
82
82
  # @!attribute [rw] score
83
- # @return [Float]
83
+ # @return [::Float]
84
84
  # A confidence level on the match, ranging from 0 (no confidence) to
85
85
  # 1 (full confidence).
86
86
  # @!attribute [rw] image
87
- # @return [String]
87
+ # @return [::String]
88
88
  # The resource name of the image from the product that is the closest match
89
89
  # to the query.
90
90
  class Result
91
- include Google::Protobuf::MessageExts
92
- extend Google::Protobuf::MessageExts::ClassMethods
91
+ include ::Google::Protobuf::MessageExts
92
+ extend ::Google::Protobuf::MessageExts::ClassMethods
93
93
  end
94
94
 
95
95
  # Prediction for what the object in the bounding box is.
96
96
  # @!attribute [rw] mid
97
- # @return [String]
97
+ # @return [::String]
98
98
  # Object ID that should align with EntityAnnotation mid.
99
99
  # @!attribute [rw] language_code
100
- # @return [String]
100
+ # @return [::String]
101
101
  # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
102
102
  # information, see
103
103
  # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
104
104
  # @!attribute [rw] name
105
- # @return [String]
105
+ # @return [::String]
106
106
  # Object name, expressed in its `language_code` language.
107
107
  # @!attribute [rw] score
108
- # @return [Float]
108
+ # @return [::Float]
109
109
  # Score of the result. Range [0, 1].
110
110
  class ObjectAnnotation
111
- include Google::Protobuf::MessageExts
112
- extend Google::Protobuf::MessageExts::ClassMethods
111
+ include ::Google::Protobuf::MessageExts
112
+ extend ::Google::Protobuf::MessageExts::ClassMethods
113
113
  end
114
114
 
115
115
  # Information about the products similar to a single product in a query
116
116
  # image.
117
117
  # @!attribute [rw] bounding_poly
118
- # @return [Google::Cloud::Vision::V1::BoundingPoly]
118
+ # @return [::Google::Cloud::Vision::V1::BoundingPoly]
119
119
  # The bounding polygon around the product detected in the query image.
120
120
  # @!attribute [rw] results
121
- # @return [Array<Google::Cloud::Vision::V1::ProductSearchResults::Result>]
121
+ # @return [::Array<::Google::Cloud::Vision::V1::ProductSearchResults::Result>]
122
122
  # List of results, one for each product match.
123
123
  # @!attribute [rw] object_annotations
124
- # @return [Array<Google::Cloud::Vision::V1::ProductSearchResults::ObjectAnnotation>]
124
+ # @return [::Array<::Google::Cloud::Vision::V1::ProductSearchResults::ObjectAnnotation>]
125
125
  # List of generic predictions for the object in the bounding box.
126
126
  class GroupedResult
127
- include Google::Protobuf::MessageExts
128
- extend Google::Protobuf::MessageExts::ClassMethods
127
+ include ::Google::Protobuf::MessageExts
128
+ extend ::Google::Protobuf::MessageExts::ClassMethods
129
129
  end
130
130
  end
131
131
  end
@@ -23,7 +23,7 @@ module Google
23
23
  module V1
24
24
  # A Product contains ReferenceImages.
25
25
  # @!attribute [rw] name
26
- # @return [String]
26
+ # @return [::String]
27
27
  # The resource name of the product.
28
28
  #
29
29
  # Format is:
@@ -31,21 +31,21 @@ module Google
31
31
  #
32
32
  # This field is ignored when creating a product.
33
33
  # @!attribute [rw] display_name
34
- # @return [String]
34
+ # @return [::String]
35
35
  # The user-provided name for this Product. Must not be empty. Must be at most
36
36
  # 4096 characters long.
37
37
  # @!attribute [rw] description
38
- # @return [String]
38
+ # @return [::String]
39
39
  # User-provided metadata to be stored with this product. Must be at most 4096
40
40
  # characters long.
41
41
  # @!attribute [rw] product_category
42
- # @return [String]
42
+ # @return [::String]
43
43
  # Immutable. The category for the product identified by the reference image. This should
44
44
  # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories
45
45
  # "homegoods", "apparel", and "toys" are still supported, but these should
46
46
  # not be used for new products.
47
47
  # @!attribute [rw] product_labels
48
- # @return [Array<Google::Cloud::Vision::V1::Product::KeyValue>]
48
+ # @return [::Array<::Google::Cloud::Vision::V1::Product::KeyValue>]
49
49
  # Key-value pairs that can be attached to a product. At query time,
50
50
  # constraints can be specified based on the product_labels.
51
51
  #
@@ -60,21 +60,21 @@ module Google
60
60
  # in one ProductSet cannot exceed 1M, otherwise the product search pipeline
61
61
  # will refuse to work for that ProductSet.
62
62
  class Product
63
- include Google::Protobuf::MessageExts
64
- extend Google::Protobuf::MessageExts::ClassMethods
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
65
 
66
66
  # A product label represented as a key-value pair.
67
67
  # @!attribute [rw] key
68
- # @return [String]
68
+ # @return [::String]
69
69
  # The key of the label attached to the product. Cannot be empty and cannot
70
70
  # exceed 128 bytes.
71
71
  # @!attribute [rw] value
72
- # @return [String]
72
+ # @return [::String]
73
73
  # The value of the label attached to the product. Cannot be empty and
74
74
  # cannot exceed 128 bytes.
75
75
  class KeyValue
76
- include Google::Protobuf::MessageExts
77
- extend Google::Protobuf::MessageExts::ClassMethods
76
+ include ::Google::Protobuf::MessageExts
77
+ extend ::Google::Protobuf::MessageExts::ClassMethods
78
78
  end
79
79
  end
80
80
 
@@ -82,7 +82,7 @@ module Google
82
82
  # million reference images. If the limit is exceeded, periodic indexing will
83
83
  # fail.
84
84
  # @!attribute [rw] name
85
- # @return [String]
85
+ # @return [::String]
86
86
  # The resource name of the ProductSet.
87
87
  #
88
88
  # Format is:
@@ -90,11 +90,11 @@ module Google
90
90
  #
91
91
  # This field is ignored when creating a ProductSet.
92
92
  # @!attribute [rw] display_name
93
- # @return [String]
93
+ # @return [::String]
94
94
  # The user-provided name for this ProductSet. Must not be empty. Must be at
95
95
  # most 4096 characters long.
96
96
  # @!attribute [r] index_time
97
- # @return [Google::Protobuf::Timestamp]
97
+ # @return [::Google::Protobuf::Timestamp]
98
98
  # Output only. The time at which this ProductSet was last indexed. Query
99
99
  # results will reflect all updates before this time. If this ProductSet has
100
100
  # never been indexed, this timestamp is the default value
@@ -102,20 +102,20 @@ module Google
102
102
  #
103
103
  # This field is ignored when creating a ProductSet.
104
104
  # @!attribute [r] index_error
105
- # @return [Google::Rpc::Status]
105
+ # @return [::Google::Rpc::Status]
106
106
  # Output only. If there was an error with indexing the product set, the field
107
107
  # is populated.
108
108
  #
109
109
  # This field is ignored when creating a ProductSet.
110
110
  class ProductSet
111
- include Google::Protobuf::MessageExts
112
- extend Google::Protobuf::MessageExts::ClassMethods
111
+ include ::Google::Protobuf::MessageExts
112
+ extend ::Google::Protobuf::MessageExts::ClassMethods
113
113
  end
114
114
 
115
115
  # A `ReferenceImage` represents a product image and its associated metadata,
116
116
  # such as bounding boxes.
117
117
  # @!attribute [rw] name
118
- # @return [String]
118
+ # @return [::String]
119
119
  # The resource name of the reference image.
120
120
  #
121
121
  # Format is:
@@ -124,12 +124,12 @@ module Google
124
124
  #
125
125
  # This field is ignored when creating a reference image.
126
126
  # @!attribute [rw] uri
127
- # @return [String]
127
+ # @return [::String]
128
128
  # Required. The Google Cloud Storage URI of the reference image.
129
129
  #
130
130
  # The URI must start with `gs://`.
131
131
  # @!attribute [rw] bounding_polys
132
- # @return [Array<Google::Cloud::Vision::V1::BoundingPoly>]
132
+ # @return [::Array<::Google::Cloud::Vision::V1::BoundingPoly>]
133
133
  # Optional. Bounding polygons around the areas of interest in the reference image.
134
134
  # If this field is empty, the system will try to detect regions of
135
135
  # interest. At most 10 bounding polygons will be used.
@@ -139,347 +139,347 @@ module Google
139
139
  # to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5
140
140
  # is not).
141
141
  class ReferenceImage
142
- include Google::Protobuf::MessageExts
143
- extend Google::Protobuf::MessageExts::ClassMethods
142
+ include ::Google::Protobuf::MessageExts
143
+ extend ::Google::Protobuf::MessageExts::ClassMethods
144
144
  end
145
145
 
146
146
  # Request message for the `CreateProduct` method.
147
147
  # @!attribute [rw] parent
148
- # @return [String]
148
+ # @return [::String]
149
149
  # Required. The project in which the Product should be created.
150
150
  #
151
151
  # Format is
152
152
  # `projects/PROJECT_ID/locations/LOC_ID`.
153
153
  # @!attribute [rw] product
154
- # @return [Google::Cloud::Vision::V1::Product]
154
+ # @return [::Google::Cloud::Vision::V1::Product]
155
155
  # Required. The product to create.
156
156
  # @!attribute [rw] product_id
157
- # @return [String]
157
+ # @return [::String]
158
158
  # A user-supplied resource id for this Product. If set, the server will
159
159
  # attempt to use this value as the resource id. If it is already in use, an
160
160
  # error is returned with code ALREADY_EXISTS. Must be at most 128 characters
161
161
  # long. It cannot contain the character `/`.
162
162
  class CreateProductRequest
163
- include Google::Protobuf::MessageExts
164
- extend Google::Protobuf::MessageExts::ClassMethods
163
+ include ::Google::Protobuf::MessageExts
164
+ extend ::Google::Protobuf::MessageExts::ClassMethods
165
165
  end
166
166
 
167
167
  # Request message for the `ListProducts` method.
168
168
  # @!attribute [rw] parent
169
- # @return [String]
169
+ # @return [::String]
170
170
  # Required. The project OR ProductSet from which Products should be listed.
171
171
  #
172
172
  # Format:
173
173
  # `projects/PROJECT_ID/locations/LOC_ID`
174
174
  # @!attribute [rw] page_size
175
- # @return [Integer]
175
+ # @return [::Integer]
176
176
  # The maximum number of items to return. Default 10, maximum 100.
177
177
  # @!attribute [rw] page_token
178
- # @return [String]
178
+ # @return [::String]
179
179
  # The next_page_token returned from a previous List request, if any.
180
180
  class ListProductsRequest
181
- include Google::Protobuf::MessageExts
182
- extend Google::Protobuf::MessageExts::ClassMethods
181
+ include ::Google::Protobuf::MessageExts
182
+ extend ::Google::Protobuf::MessageExts::ClassMethods
183
183
  end
184
184
 
185
185
  # Response message for the `ListProducts` method.
186
186
  # @!attribute [rw] products
187
- # @return [Array<Google::Cloud::Vision::V1::Product>]
187
+ # @return [::Array<::Google::Cloud::Vision::V1::Product>]
188
188
  # List of products.
189
189
  # @!attribute [rw] next_page_token
190
- # @return [String]
190
+ # @return [::String]
191
191
  # Token to retrieve the next page of results, or empty if there are no more
192
192
  # results in the list.
193
193
  class ListProductsResponse
194
- include Google::Protobuf::MessageExts
195
- extend Google::Protobuf::MessageExts::ClassMethods
194
+ include ::Google::Protobuf::MessageExts
195
+ extend ::Google::Protobuf::MessageExts::ClassMethods
196
196
  end
197
197
 
198
198
  # Request message for the `GetProduct` method.
199
199
  # @!attribute [rw] name
200
- # @return [String]
200
+ # @return [::String]
201
201
  # Required. Resource name of the Product to get.
202
202
  #
203
203
  # Format is:
204
204
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
205
205
  class GetProductRequest
206
- include Google::Protobuf::MessageExts
207
- extend Google::Protobuf::MessageExts::ClassMethods
206
+ include ::Google::Protobuf::MessageExts
207
+ extend ::Google::Protobuf::MessageExts::ClassMethods
208
208
  end
209
209
 
210
210
  # Request message for the `UpdateProduct` method.
211
211
  # @!attribute [rw] product
212
- # @return [Google::Cloud::Vision::V1::Product]
212
+ # @return [::Google::Cloud::Vision::V1::Product]
213
213
  # Required. The Product resource which replaces the one on the server.
214
214
  # product.name is immutable.
215
215
  # @!attribute [rw] update_mask
216
- # @return [Google::Protobuf::FieldMask]
217
- # The {Google::Protobuf::FieldMask FieldMask} that specifies which fields
216
+ # @return [::Google::Protobuf::FieldMask]
217
+ # The {::Google::Protobuf::FieldMask FieldMask} that specifies which fields
218
218
  # to update.
219
219
  # If update_mask isn't specified, all mutable fields are to be updated.
220
220
  # Valid mask paths include `product_labels`, `display_name`, and
221
221
  # `description`.
222
222
  class UpdateProductRequest
223
- include Google::Protobuf::MessageExts
224
- extend Google::Protobuf::MessageExts::ClassMethods
223
+ include ::Google::Protobuf::MessageExts
224
+ extend ::Google::Protobuf::MessageExts::ClassMethods
225
225
  end
226
226
 
227
227
  # Request message for the `DeleteProduct` method.
228
228
  # @!attribute [rw] name
229
- # @return [String]
229
+ # @return [::String]
230
230
  # Required. Resource name of product to delete.
231
231
  #
232
232
  # Format is:
233
233
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
234
234
  class DeleteProductRequest
235
- include Google::Protobuf::MessageExts
236
- extend Google::Protobuf::MessageExts::ClassMethods
235
+ include ::Google::Protobuf::MessageExts
236
+ extend ::Google::Protobuf::MessageExts::ClassMethods
237
237
  end
238
238
 
239
239
  # Request message for the `CreateProductSet` method.
240
240
  # @!attribute [rw] parent
241
- # @return [String]
241
+ # @return [::String]
242
242
  # Required. The project in which the ProductSet should be created.
243
243
  #
244
244
  # Format is `projects/PROJECT_ID/locations/LOC_ID`.
245
245
  # @!attribute [rw] product_set
246
- # @return [Google::Cloud::Vision::V1::ProductSet]
246
+ # @return [::Google::Cloud::Vision::V1::ProductSet]
247
247
  # Required. The ProductSet to create.
248
248
  # @!attribute [rw] product_set_id
249
- # @return [String]
249
+ # @return [::String]
250
250
  # A user-supplied resource id for this ProductSet. If set, the server will
251
251
  # attempt to use this value as the resource id. If it is already in use, an
252
252
  # error is returned with code ALREADY_EXISTS. Must be at most 128 characters
253
253
  # long. It cannot contain the character `/`.
254
254
  class CreateProductSetRequest
255
- include Google::Protobuf::MessageExts
256
- extend Google::Protobuf::MessageExts::ClassMethods
255
+ include ::Google::Protobuf::MessageExts
256
+ extend ::Google::Protobuf::MessageExts::ClassMethods
257
257
  end
258
258
 
259
259
  # Request message for the `ListProductSets` method.
260
260
  # @!attribute [rw] parent
261
- # @return [String]
261
+ # @return [::String]
262
262
  # Required. The project from which ProductSets should be listed.
263
263
  #
264
264
  # Format is `projects/PROJECT_ID/locations/LOC_ID`.
265
265
  # @!attribute [rw] page_size
266
- # @return [Integer]
266
+ # @return [::Integer]
267
267
  # The maximum number of items to return. Default 10, maximum 100.
268
268
  # @!attribute [rw] page_token
269
- # @return [String]
269
+ # @return [::String]
270
270
  # The next_page_token returned from a previous List request, if any.
271
271
  class ListProductSetsRequest
272
- include Google::Protobuf::MessageExts
273
- extend Google::Protobuf::MessageExts::ClassMethods
272
+ include ::Google::Protobuf::MessageExts
273
+ extend ::Google::Protobuf::MessageExts::ClassMethods
274
274
  end
275
275
 
276
276
  # Response message for the `ListProductSets` method.
277
277
  # @!attribute [rw] product_sets
278
- # @return [Array<Google::Cloud::Vision::V1::ProductSet>]
278
+ # @return [::Array<::Google::Cloud::Vision::V1::ProductSet>]
279
279
  # List of ProductSets.
280
280
  # @!attribute [rw] next_page_token
281
- # @return [String]
281
+ # @return [::String]
282
282
  # Token to retrieve the next page of results, or empty if there are no more
283
283
  # results in the list.
284
284
  class ListProductSetsResponse
285
- include Google::Protobuf::MessageExts
286
- extend Google::Protobuf::MessageExts::ClassMethods
285
+ include ::Google::Protobuf::MessageExts
286
+ extend ::Google::Protobuf::MessageExts::ClassMethods
287
287
  end
288
288
 
289
289
  # Request message for the `GetProductSet` method.
290
290
  # @!attribute [rw] name
291
- # @return [String]
291
+ # @return [::String]
292
292
  # Required. Resource name of the ProductSet to get.
293
293
  #
294
294
  # Format is:
295
295
  # `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID`
296
296
  class GetProductSetRequest
297
- include Google::Protobuf::MessageExts
298
- extend Google::Protobuf::MessageExts::ClassMethods
297
+ include ::Google::Protobuf::MessageExts
298
+ extend ::Google::Protobuf::MessageExts::ClassMethods
299
299
  end
300
300
 
301
301
  # Request message for the `UpdateProductSet` method.
302
302
  # @!attribute [rw] product_set
303
- # @return [Google::Cloud::Vision::V1::ProductSet]
303
+ # @return [::Google::Cloud::Vision::V1::ProductSet]
304
304
  # Required. The ProductSet resource which replaces the one on the server.
305
305
  # @!attribute [rw] update_mask
306
- # @return [Google::Protobuf::FieldMask]
307
- # The {Google::Protobuf::FieldMask FieldMask} that specifies which fields to
306
+ # @return [::Google::Protobuf::FieldMask]
307
+ # The {::Google::Protobuf::FieldMask FieldMask} that specifies which fields to
308
308
  # update.
309
309
  # If update_mask isn't specified, all mutable fields are to be updated.
310
310
  # Valid mask path is `display_name`.
311
311
  class UpdateProductSetRequest
312
- include Google::Protobuf::MessageExts
313
- extend Google::Protobuf::MessageExts::ClassMethods
312
+ include ::Google::Protobuf::MessageExts
313
+ extend ::Google::Protobuf::MessageExts::ClassMethods
314
314
  end
315
315
 
316
316
  # Request message for the `DeleteProductSet` method.
317
317
  # @!attribute [rw] name
318
- # @return [String]
318
+ # @return [::String]
319
319
  # Required. Resource name of the ProductSet to delete.
320
320
  #
321
321
  # Format is:
322
322
  # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
323
323
  class DeleteProductSetRequest
324
- include Google::Protobuf::MessageExts
325
- extend Google::Protobuf::MessageExts::ClassMethods
324
+ include ::Google::Protobuf::MessageExts
325
+ extend ::Google::Protobuf::MessageExts::ClassMethods
326
326
  end
327
327
 
328
328
  # Request message for the `CreateReferenceImage` method.
329
329
  # @!attribute [rw] parent
330
- # @return [String]
330
+ # @return [::String]
331
331
  # Required. Resource name of the product in which to create the reference image.
332
332
  #
333
333
  # Format is
334
334
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
335
335
  # @!attribute [rw] reference_image
336
- # @return [Google::Cloud::Vision::V1::ReferenceImage]
336
+ # @return [::Google::Cloud::Vision::V1::ReferenceImage]
337
337
  # Required. The reference image to create.
338
338
  # If an image ID is specified, it is ignored.
339
339
  # @!attribute [rw] reference_image_id
340
- # @return [String]
340
+ # @return [::String]
341
341
  # A user-supplied resource id for the ReferenceImage to be added. If set,
342
342
  # the server will attempt to use this value as the resource id. If it is
343
343
  # already in use, an error is returned with code ALREADY_EXISTS. Must be at
344
344
  # most 128 characters long. It cannot contain the character `/`.
345
345
  class CreateReferenceImageRequest
346
- include Google::Protobuf::MessageExts
347
- extend Google::Protobuf::MessageExts::ClassMethods
346
+ include ::Google::Protobuf::MessageExts
347
+ extend ::Google::Protobuf::MessageExts::ClassMethods
348
348
  end
349
349
 
350
350
  # Request message for the `ListReferenceImages` method.
351
351
  # @!attribute [rw] parent
352
- # @return [String]
352
+ # @return [::String]
353
353
  # Required. Resource name of the product containing the reference images.
354
354
  #
355
355
  # Format is
356
356
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
357
357
  # @!attribute [rw] page_size
358
- # @return [Integer]
358
+ # @return [::Integer]
359
359
  # The maximum number of items to return. Default 10, maximum 100.
360
360
  # @!attribute [rw] page_token
361
- # @return [String]
361
+ # @return [::String]
362
362
  # A token identifying a page of results to be returned. This is the value
363
363
  # of `nextPageToken` returned in a previous reference image list request.
364
364
  #
365
365
  # Defaults to the first page if not specified.
366
366
  class ListReferenceImagesRequest
367
- include Google::Protobuf::MessageExts
368
- extend Google::Protobuf::MessageExts::ClassMethods
367
+ include ::Google::Protobuf::MessageExts
368
+ extend ::Google::Protobuf::MessageExts::ClassMethods
369
369
  end
370
370
 
371
371
  # Response message for the `ListReferenceImages` method.
372
372
  # @!attribute [rw] reference_images
373
- # @return [Array<Google::Cloud::Vision::V1::ReferenceImage>]
373
+ # @return [::Array<::Google::Cloud::Vision::V1::ReferenceImage>]
374
374
  # The list of reference images.
375
375
  # @!attribute [rw] page_size
376
- # @return [Integer]
376
+ # @return [::Integer]
377
377
  # The maximum number of items to return. Default 10, maximum 100.
378
378
  # @!attribute [rw] next_page_token
379
- # @return [String]
379
+ # @return [::String]
380
380
  # The next_page_token returned from a previous List request, if any.
381
381
  class ListReferenceImagesResponse
382
- include Google::Protobuf::MessageExts
383
- extend Google::Protobuf::MessageExts::ClassMethods
382
+ include ::Google::Protobuf::MessageExts
383
+ extend ::Google::Protobuf::MessageExts::ClassMethods
384
384
  end
385
385
 
386
386
  # Request message for the `GetReferenceImage` method.
387
387
  # @!attribute [rw] name
388
- # @return [String]
388
+ # @return [::String]
389
389
  # Required. The resource name of the ReferenceImage to get.
390
390
  #
391
391
  # Format is:
392
392
  #
393
393
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.
394
394
  class GetReferenceImageRequest
395
- include Google::Protobuf::MessageExts
396
- extend Google::Protobuf::MessageExts::ClassMethods
395
+ include ::Google::Protobuf::MessageExts
396
+ extend ::Google::Protobuf::MessageExts::ClassMethods
397
397
  end
398
398
 
399
399
  # Request message for the `DeleteReferenceImage` method.
400
400
  # @!attribute [rw] name
401
- # @return [String]
401
+ # @return [::String]
402
402
  # Required. The resource name of the reference image to delete.
403
403
  #
404
404
  # Format is:
405
405
  #
406
406
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`
407
407
  class DeleteReferenceImageRequest
408
- include Google::Protobuf::MessageExts
409
- extend Google::Protobuf::MessageExts::ClassMethods
408
+ include ::Google::Protobuf::MessageExts
409
+ extend ::Google::Protobuf::MessageExts::ClassMethods
410
410
  end
411
411
 
412
412
  # Request message for the `AddProductToProductSet` method.
413
413
  # @!attribute [rw] name
414
- # @return [String]
414
+ # @return [::String]
415
415
  # Required. The resource name for the ProductSet to modify.
416
416
  #
417
417
  # Format is:
418
418
  # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
419
419
  # @!attribute [rw] product
420
- # @return [String]
420
+ # @return [::String]
421
421
  # Required. The resource name for the Product to be added to this ProductSet.
422
422
  #
423
423
  # Format is:
424
424
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
425
425
  class AddProductToProductSetRequest
426
- include Google::Protobuf::MessageExts
427
- extend Google::Protobuf::MessageExts::ClassMethods
426
+ include ::Google::Protobuf::MessageExts
427
+ extend ::Google::Protobuf::MessageExts::ClassMethods
428
428
  end
429
429
 
430
430
  # Request message for the `RemoveProductFromProductSet` method.
431
431
  # @!attribute [rw] name
432
- # @return [String]
432
+ # @return [::String]
433
433
  # Required. The resource name for the ProductSet to modify.
434
434
  #
435
435
  # Format is:
436
436
  # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
437
437
  # @!attribute [rw] product
438
- # @return [String]
438
+ # @return [::String]
439
439
  # Required. The resource name for the Product to be removed from this ProductSet.
440
440
  #
441
441
  # Format is:
442
442
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
443
443
  class RemoveProductFromProductSetRequest
444
- include Google::Protobuf::MessageExts
445
- extend Google::Protobuf::MessageExts::ClassMethods
444
+ include ::Google::Protobuf::MessageExts
445
+ extend ::Google::Protobuf::MessageExts::ClassMethods
446
446
  end
447
447
 
448
448
  # Request message for the `ListProductsInProductSet` method.
449
449
  # @!attribute [rw] name
450
- # @return [String]
450
+ # @return [::String]
451
451
  # Required. The ProductSet resource for which to retrieve Products.
452
452
  #
453
453
  # Format is:
454
454
  # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
455
455
  # @!attribute [rw] page_size
456
- # @return [Integer]
456
+ # @return [::Integer]
457
457
  # The maximum number of items to return. Default 10, maximum 100.
458
458
  # @!attribute [rw] page_token
459
- # @return [String]
459
+ # @return [::String]
460
460
  # The next_page_token returned from a previous List request, if any.
461
461
  class ListProductsInProductSetRequest
462
- include Google::Protobuf::MessageExts
463
- extend Google::Protobuf::MessageExts::ClassMethods
462
+ include ::Google::Protobuf::MessageExts
463
+ extend ::Google::Protobuf::MessageExts::ClassMethods
464
464
  end
465
465
 
466
466
  # Response message for the `ListProductsInProductSet` method.
467
467
  # @!attribute [rw] products
468
- # @return [Array<Google::Cloud::Vision::V1::Product>]
468
+ # @return [::Array<::Google::Cloud::Vision::V1::Product>]
469
469
  # The list of Products.
470
470
  # @!attribute [rw] next_page_token
471
- # @return [String]
471
+ # @return [::String]
472
472
  # Token to retrieve the next page of results, or empty if there are no more
473
473
  # results in the list.
474
474
  class ListProductsInProductSetResponse
475
- include Google::Protobuf::MessageExts
476
- extend Google::Protobuf::MessageExts::ClassMethods
475
+ include ::Google::Protobuf::MessageExts
476
+ extend ::Google::Protobuf::MessageExts::ClassMethods
477
477
  end
478
478
 
479
479
  # The Google Cloud Storage location for a csv file which preserves a list of
480
480
  # ImportProductSetRequests in each line.
481
481
  # @!attribute [rw] csv_file_uri
482
- # @return [String]
482
+ # @return [::String]
483
483
  # The Google Cloud Storage URI of the input csv file.
484
484
  #
485
485
  # The URI must start with `gs://`.
@@ -503,16 +503,16 @@ module Google
503
503
  # `product-id` values does not exist, then the system will create a new
504
504
  # `ProductSet` or `Product` for the image. In this case, the
505
505
  # `product-display-name` column refers to
506
- # {Google::Cloud::Vision::V1::Product#display_name display_name}, the
506
+ # {::Google::Cloud::Vision::V1::Product#display_name display_name}, the
507
507
  # `product-category` column refers to
508
- # {Google::Cloud::Vision::V1::Product#product_category product_category}, and the
509
- # `labels` column refers to {Google::Cloud::Vision::V1::Product#product_labels product_labels}.
508
+ # {::Google::Cloud::Vision::V1::Product#product_category product_category}, and the
509
+ # `labels` column refers to {::Google::Cloud::Vision::V1::Product#product_labels product_labels}.
510
510
  #
511
511
  # The `image-id` column is optional but must be unique if provided. If it is
512
512
  # empty, the system will automatically assign a unique id to the image.
513
513
  #
514
514
  # The `product-display-name` column is optional. If it is empty, the system
515
- # sets the {Google::Cloud::Vision::V1::Product#display_name display_name} field for the product to a
515
+ # sets the {::Google::Cloud::Vision::V1::Product#display_name display_name} field for the product to a
516
516
  # space (" "). You can update the `display_name` later by using the API.
517
517
  #
518
518
  # If a `Product` with the specified `product-id` already exists, then the
@@ -542,44 +542,44 @@ module Google
542
542
  # The system will resize the image if the image resolution is too
543
543
  # large to process (larger than 20MP).
544
544
  class ImportProductSetsGcsSource
545
- include Google::Protobuf::MessageExts
546
- extend Google::Protobuf::MessageExts::ClassMethods
545
+ include ::Google::Protobuf::MessageExts
546
+ extend ::Google::Protobuf::MessageExts::ClassMethods
547
547
  end
548
548
 
549
549
  # The input content for the `ImportProductSets` method.
550
550
  # @!attribute [rw] gcs_source
551
- # @return [Google::Cloud::Vision::V1::ImportProductSetsGcsSource]
551
+ # @return [::Google::Cloud::Vision::V1::ImportProductSetsGcsSource]
552
552
  # The Google Cloud Storage location for a csv file which preserves a list
553
553
  # of ImportProductSetRequests in each line.
554
554
  class ImportProductSetsInputConfig
555
- include Google::Protobuf::MessageExts
556
- extend Google::Protobuf::MessageExts::ClassMethods
555
+ include ::Google::Protobuf::MessageExts
556
+ extend ::Google::Protobuf::MessageExts::ClassMethods
557
557
  end
558
558
 
559
559
  # Request message for the `ImportProductSets` method.
560
560
  # @!attribute [rw] parent
561
- # @return [String]
561
+ # @return [::String]
562
562
  # Required. The project in which the ProductSets should be imported.
563
563
  #
564
564
  # Format is `projects/PROJECT_ID/locations/LOC_ID`.
565
565
  # @!attribute [rw] input_config
566
- # @return [Google::Cloud::Vision::V1::ImportProductSetsInputConfig]
566
+ # @return [::Google::Cloud::Vision::V1::ImportProductSetsInputConfig]
567
567
  # Required. The input content for the list of requests.
568
568
  class ImportProductSetsRequest
569
- include Google::Protobuf::MessageExts
570
- extend Google::Protobuf::MessageExts::ClassMethods
569
+ include ::Google::Protobuf::MessageExts
570
+ extend ::Google::Protobuf::MessageExts::ClassMethods
571
571
  end
572
572
 
573
573
  # Response message for the `ImportProductSets` method.
574
574
  #
575
575
  # This message is returned by the
576
576
  # google.longrunning.Operations.GetOperation method in the returned
577
- # {Google::Longrunning::Operation#response google.longrunning.Operation.response} field.
577
+ # {::Google::Longrunning::Operation#response google.longrunning.Operation.response} field.
578
578
  # @!attribute [rw] reference_images
579
- # @return [Array<Google::Cloud::Vision::V1::ReferenceImage>]
579
+ # @return [::Array<::Google::Cloud::Vision::V1::ReferenceImage>]
580
580
  # The list of reference_images that are imported successfully.
581
581
  # @!attribute [rw] statuses
582
- # @return [Array<Google::Rpc::Status>]
582
+ # @return [::Array<::Google::Rpc::Status>]
583
583
  # The rpc status for each ImportProductSet request, including both successes
584
584
  # and errors.
585
585
  #
@@ -587,8 +587,8 @@ module Google
587
587
  # and statuses[i] stores the success or failure status of processing the i-th
588
588
  # line of the csv, starting from line 0.
589
589
  class ImportProductSetsResponse
590
- include Google::Protobuf::MessageExts
591
- extend Google::Protobuf::MessageExts::ClassMethods
590
+ include ::Google::Protobuf::MessageExts
591
+ extend ::Google::Protobuf::MessageExts::ClassMethods
592
592
  end
593
593
 
594
594
  # Metadata for the batch operations such as the current state.
@@ -596,18 +596,18 @@ module Google
596
596
  # This is included in the `metadata` field of the `Operation` returned by the
597
597
  # `GetOperation` call of the `google::longrunning::Operations` service.
598
598
  # @!attribute [rw] state
599
- # @return [Google::Cloud::Vision::V1::BatchOperationMetadata::State]
599
+ # @return [::Google::Cloud::Vision::V1::BatchOperationMetadata::State]
600
600
  # The current state of the batch operation.
601
601
  # @!attribute [rw] submit_time
602
- # @return [Google::Protobuf::Timestamp]
602
+ # @return [::Google::Protobuf::Timestamp]
603
603
  # The time when the batch request was submitted to the server.
604
604
  # @!attribute [rw] end_time
605
- # @return [Google::Protobuf::Timestamp]
605
+ # @return [::Google::Protobuf::Timestamp]
606
606
  # The time when the batch request is finished and
607
- # {Google::Longrunning::Operation#done google.longrunning.Operation.done} is set to true.
607
+ # {::Google::Longrunning::Operation#done google.longrunning.Operation.done} is set to true.
608
608
  class BatchOperationMetadata
609
- include Google::Protobuf::MessageExts
610
- extend Google::Protobuf::MessageExts::ClassMethods
609
+ include ::Google::Protobuf::MessageExts
610
+ extend ::Google::Protobuf::MessageExts::ClassMethods
611
611
 
612
612
  # Enumerates the possible states that the batch request can be in.
613
613
  module State
@@ -633,35 +633,35 @@ module Google
633
633
 
634
634
  # Config to control which ProductSet contains the Products to be deleted.
635
635
  # @!attribute [rw] product_set_id
636
- # @return [String]
636
+ # @return [::String]
637
637
  # The ProductSet that contains the Products to delete. If a Product is a
638
638
  # member of product_set_id in addition to other ProductSets, the Product will
639
639
  # still be deleted.
640
640
  class ProductSetPurgeConfig
641
- include Google::Protobuf::MessageExts
642
- extend Google::Protobuf::MessageExts::ClassMethods
641
+ include ::Google::Protobuf::MessageExts
642
+ extend ::Google::Protobuf::MessageExts::ClassMethods
643
643
  end
644
644
 
645
645
  # Request message for the `PurgeProducts` method.
646
646
  # @!attribute [rw] product_set_purge_config
647
- # @return [Google::Cloud::Vision::V1::ProductSetPurgeConfig]
647
+ # @return [::Google::Cloud::Vision::V1::ProductSetPurgeConfig]
648
648
  # Specify which ProductSet contains the Products to be deleted.
649
649
  # @!attribute [rw] delete_orphan_products
650
- # @return [Boolean]
650
+ # @return [::Boolean]
651
651
  # If delete_orphan_products is true, all Products that are not in any
652
652
  # ProductSet will be deleted.
653
653
  # @!attribute [rw] parent
654
- # @return [String]
654
+ # @return [::String]
655
655
  # Required. The project and location in which the Products should be deleted.
656
656
  #
657
657
  # Format is `projects/PROJECT_ID/locations/LOC_ID`.
658
658
  # @!attribute [rw] force
659
- # @return [Boolean]
659
+ # @return [::Boolean]
660
660
  # The default value is false. Override this value to true to actually perform
661
661
  # the purge.
662
662
  class PurgeProductsRequest
663
- include Google::Protobuf::MessageExts
664
- extend Google::Protobuf::MessageExts::ClassMethods
663
+ include ::Google::Protobuf::MessageExts
664
+ extend ::Google::Protobuf::MessageExts::ClassMethods
665
665
  end
666
666
  end
667
667
  end