google-cloud-vision-v1p3beta1 0.1.2 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +6 -6
  3. data/README.md +48 -1
  4. data/lib/google-cloud-vision-v1p3beta1.rb +21 -1
  5. data/lib/google/cloud/vision/v1p3beta1.rb +16 -0
  6. data/lib/google/cloud/vision/v1p3beta1/image_annotator.rb +33 -2
  7. data/lib/google/cloud/vision/v1p3beta1/image_annotator/client.rb +101 -97
  8. data/lib/google/cloud/vision/v1p3beta1/image_annotator/credentials.rb +1 -1
  9. data/lib/google/cloud/vision/v1p3beta1/image_annotator/operations.rb +139 -127
  10. data/lib/google/cloud/vision/v1p3beta1/image_annotator/paths.rb +3 -3
  11. data/lib/google/cloud/vision/v1p3beta1/product_search.rb +44 -2
  12. data/lib/google/cloud/vision/v1p3beta1/product_search/client.rb +500 -508
  13. data/lib/google/cloud/vision/v1p3beta1/product_search/credentials.rb +1 -1
  14. data/lib/google/cloud/vision/v1p3beta1/product_search/operations.rb +139 -127
  15. data/lib/google/cloud/vision/v1p3beta1/product_search/paths.rb +12 -12
  16. data/lib/google/cloud/vision/v1p3beta1/version.rb +1 -1
  17. data/proto_docs/google/api/resource.rb +12 -12
  18. data/proto_docs/google/cloud/vision/v1p3beta1/geometry.rb +20 -20
  19. data/proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb +172 -172
  20. data/proto_docs/google/cloud/vision/v1p3beta1/product_search.rb +29 -29
  21. data/proto_docs/google/cloud/vision/v1p3beta1/product_search_service.rb +133 -133
  22. data/proto_docs/google/cloud/vision/v1p3beta1/text_annotation.rb +49 -49
  23. data/proto_docs/google/cloud/vision/v1p3beta1/web_detection.rb +28 -28
  24. data/proto_docs/google/longrunning/operations.rb +30 -30
  25. data/proto_docs/google/protobuf/any.rb +4 -4
  26. data/proto_docs/google/protobuf/empty.rb +2 -2
  27. data/proto_docs/google/protobuf/field_mask.rb +3 -3
  28. data/proto_docs/google/protobuf/timestamp.rb +4 -4
  29. data/proto_docs/google/protobuf/wrappers.rb +27 -27
  30. data/proto_docs/google/rpc/status.rb +6 -6
  31. data/proto_docs/google/type/color.rb +6 -6
  32. data/proto_docs/google/type/latlng.rb +4 -4
  33. metadata +32 -5
  34. data/lib/google/cloud/common_resources_pb.rb +0 -15
data/proto_docs/google/cloud/vision/v1p3beta1/product_search.rb CHANGED
@@ -23,49 +23,49 @@ module Google
23
23
  module V1p3beta1
24
24
  # Parameters for a product search request.
25
25
  # @!attribute [rw] catalog_name
26
- # @return [String]
26
+ # @return [::String]
27
27
  # The resource name of the catalog to search.
28
28
  #
29
29
  # Format is: `productSearch/catalogs/CATALOG_NAME`.
30
30
  # @!attribute [rw] category
31
- # @return [Google::Cloud::Vision::V1p3beta1::ProductSearchCategory]
31
+ # @return [::Google::Cloud::Vision::V1p3beta1::ProductSearchCategory]
32
32
  # The category to search in.
33
33
  # Optional. It is inferred by the system if it is not specified.
34
34
  # [Deprecated] Use `product_category`.
35
35
  # @!attribute [rw] product_category
36
- # @return [String]
36
+ # @return [::String]
37
37
  # The product category to search in.
38
38
  # Optional. It is inferred by the system if it is not specified.
39
39
  # Supported values are `bag`, `shoe`, `sunglasses`, `dress`, `outerwear`,
40
40
  # `skirt`, `top`, `shorts`, and `pants`.
41
41
  # @!attribute [rw] normalized_bounding_poly
42
- # @return [Google::Cloud::Vision::V1p3beta1::NormalizedBoundingPoly]
42
+ # @return [::Google::Cloud::Vision::V1p3beta1::NormalizedBoundingPoly]
43
43
  # The bounding polygon around the area of interest in the image.
44
44
  # Optional. If it is not specified, system discretion will be applied.
45
45
  # [Deprecated] Use `bounding_poly`.
46
46
  # @!attribute [rw] bounding_poly
47
- # @return [Google::Cloud::Vision::V1p3beta1::BoundingPoly]
47
+ # @return [::Google::Cloud::Vision::V1p3beta1::BoundingPoly]
48
48
  # The bounding polygon around the area of interest in the image.
49
49
  # Optional. If it is not specified, system discretion will be applied.
50
50
  # @!attribute [rw] view
51
- # @return [Google::Cloud::Vision::V1p3beta1::ProductSearchResultsView]
51
+ # @return [::Google::Cloud::Vision::V1p3beta1::ProductSearchResultsView]
52
52
  # Specifies the verbosity of the product search results.
53
53
  # Optional. Defaults to `BASIC`.
54
54
  # @!attribute [rw] product_set
55
- # @return [String]
55
+ # @return [::String]
56
56
  # The resource name of a
57
- # {Google::Cloud::Vision::V1p3beta1::ProductSet ProductSet} to be searched for
57
+ # {::Google::Cloud::Vision::V1p3beta1::ProductSet ProductSet} to be searched for
58
58
  # similar images.
59
59
  #
60
60
  # Format is:
61
61
  # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
62
62
  # @!attribute [rw] product_categories
63
- # @return [Array<String>]
63
+ # @return [::Array<::String>]
64
64
  # The list of product categories to search in. Currently, we only consider
65
65
  # the first category, and either "homegoods" or "apparel" should be
66
66
  # specified.
67
67
  # @!attribute [rw] filter
68
- # @return [String]
68
+ # @return [::String]
69
69
  # The filtering expression. This can be used to restrict search results based
70
70
  # on Product labels. We currently support an AND of OR of key-value
71
71
  # expressions, where each expression within an OR must have the same key.
@@ -73,74 +73,74 @@ module Google
73
73
  # For example, "(color = red OR color = blue) AND brand = Google" is
74
74
  # acceptable, but not "(color = red OR brand = Google)" or "color: red".
75
75
  class ProductSearchParams
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
 
80
80
  # Results for a product search request.
81
81
  # @!attribute [rw] category
82
- # @return [Google::Cloud::Vision::V1p3beta1::ProductSearchCategory]
82
+ # @return [::Google::Cloud::Vision::V1p3beta1::ProductSearchCategory]
83
83
  # Product category.
84
84
  # [Deprecated] Use `product_category`.
85
85
  # @!attribute [rw] product_category
86
- # @return [String]
86
+ # @return [::String]
87
87
  # Product category.
88
88
  # Supported values are `bag` and `shoe`.
89
89
  # [Deprecated] `product_category` is provided in each Product.
90
90
  # @!attribute [rw] index_time
91
- # @return [Google::Protobuf::Timestamp]
91
+ # @return [::Google::Protobuf::Timestamp]
92
92
  # Timestamp of the index which provided these results. Changes made after
93
93
  # this time are not reflected in the current results.
94
94
  # @!attribute [rw] products
95
- # @return [Array<Google::Cloud::Vision::V1p3beta1::ProductSearchResults::ProductInfo>]
95
+ # @return [::Array<::Google::Cloud::Vision::V1p3beta1::ProductSearchResults::ProductInfo>]
96
96
  # List of detected products.
97
97
  # @!attribute [rw] results
98
- # @return [Array<Google::Cloud::Vision::V1p3beta1::ProductSearchResults::Result>]
98
+ # @return [::Array<::Google::Cloud::Vision::V1p3beta1::ProductSearchResults::Result>]
99
99
  # List of results, one for each product match.
100
100
  class ProductSearchResults
101
- include Google::Protobuf::MessageExts
102
- extend Google::Protobuf::MessageExts::ClassMethods
101
+ include ::Google::Protobuf::MessageExts
102
+ extend ::Google::Protobuf::MessageExts::ClassMethods
103
103
 
104
104
  # Information about a product.
105
105
  # @!attribute [rw] product_id
106
- # @return [String]
106
+ # @return [::String]
107
107
  # Product ID.
108
108
  # @!attribute [rw] image_uri
109
- # @return [String]
109
+ # @return [::String]
110
110
  # The URI of the image which matched the query image.
111
111
  #
112
112
  # This field is returned only if `view` is set to `FULL` in
113
113
  # the request.
114
114
  # @!attribute [rw] score
115
- # @return [Float]
115
+ # @return [::Float]
116
116
  # A confidence level on the match, ranging from 0 (no confidence) to
117
117
  # 1 (full confidence).
118
118
  #
119
119
  # This field is returned only if `view` is set to `FULL` in
120
120
  # the request.
121
121
  class ProductInfo
122
- include Google::Protobuf::MessageExts
123
- extend Google::Protobuf::MessageExts::ClassMethods
122
+ include ::Google::Protobuf::MessageExts
123
+ extend ::Google::Protobuf::MessageExts::ClassMethods
124
124
  end
125
125
 
126
126
  # Information about a product.
127
127
  # @!attribute [rw] product
128
- # @return [Google::Cloud::Vision::V1p3beta1::Product]
128
+ # @return [::Google::Cloud::Vision::V1p3beta1::Product]
129
129
  # The Product.
130
130
  # @!attribute [rw] score
131
- # @return [Float]
131
+ # @return [::Float]
132
132
  # A confidence level on the match, ranging from 0 (no confidence) to
133
133
  # 1 (full confidence).
134
134
  #
135
135
  # This field is returned only if `view` is set to `FULL` in
136
136
  # the request.
137
137
  # @!attribute [rw] image
138
- # @return [String]
138
+ # @return [::String]
139
139
  # The resource name of the image from the product that is the closest match
140
140
  # to the query.
141
141
  class Result
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
  end
146
146
 
data/proto_docs/google/cloud/vision/v1p3beta1/product_search_service.rb CHANGED
@@ -23,7 +23,7 @@ module Google
23
23
  module V1p3beta1
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::V1p3beta1::Product::KeyValue>]
48
+ # @return [::Array<::Google::Cloud::Vision::V1p3beta1::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
  #
@@ -56,21 +56,21 @@ module Google
56
56
  # Multiple values can be assigned to the same key. One product may have up to
57
57
  # 100 product_labels.
58
58
  class Product
59
- include Google::Protobuf::MessageExts
60
- extend Google::Protobuf::MessageExts::ClassMethods
59
+ include ::Google::Protobuf::MessageExts
60
+ extend ::Google::Protobuf::MessageExts::ClassMethods
61
61
 
62
62
  # A product label represented as a key-value pair.
63
63
  # @!attribute [rw] key
64
- # @return [String]
64
+ # @return [::String]
65
65
  # The key of the label attached to the product. Cannot be empty and cannot
66
66
  # exceed 128 bytes.
67
67
  # @!attribute [rw] value
68
- # @return [String]
68
+ # @return [::String]
69
69
  # The value of the label attached to the product. Cannot be empty and
70
70
  # cannot exceed 128 bytes.
71
71
  class KeyValue
72
- include Google::Protobuf::MessageExts
73
- extend Google::Protobuf::MessageExts::ClassMethods
72
+ include ::Google::Protobuf::MessageExts
73
+ extend ::Google::Protobuf::MessageExts::ClassMethods
74
74
  end
75
75
  end
76
76
 
@@ -78,7 +78,7 @@ module Google
78
78
  # million reference images. If the limit is exceeded, periodic indexing will
79
79
  # fail.
80
80
  # @!attribute [rw] name
81
- # @return [String]
81
+ # @return [::String]
82
82
  # The resource name of the ProductSet.
83
83
  #
84
84
  # Format is:
@@ -86,31 +86,31 @@ module Google
86
86
  #
87
87
  # This field is ignored when creating a ProductSet.
88
88
  # @!attribute [rw] display_name
89
- # @return [String]
89
+ # @return [::String]
90
90
  # The user-provided name for this ProductSet. Must not be empty. Must be at
91
91
  # most 4096 characters long.
92
92
  # @!attribute [r] index_time
93
- # @return [Google::Protobuf::Timestamp]
93
+ # @return [::Google::Protobuf::Timestamp]
94
94
  # Output only. The time at which this ProductSet was last indexed. Query
95
95
  # results will reflect all updates before this time. If this ProductSet has
96
96
  # never been indexed, this field is 0.
97
97
  #
98
98
  # This field is ignored when creating a ProductSet.
99
99
  # @!attribute [r] index_error
100
- # @return [Google::Rpc::Status]
100
+ # @return [::Google::Rpc::Status]
101
101
  # Output only. If there was an error with indexing the product set, the field
102
102
  # is populated.
103
103
  #
104
104
  # This field is ignored when creating a ProductSet.
105
105
  class ProductSet
106
- include Google::Protobuf::MessageExts
107
- extend Google::Protobuf::MessageExts::ClassMethods
106
+ include ::Google::Protobuf::MessageExts
107
+ extend ::Google::Protobuf::MessageExts::ClassMethods
108
108
  end
109
109
 
110
110
  # A `ReferenceImage` represents a product image and its associated metadata,
111
111
  # such as bounding boxes.
112
112
  # @!attribute [rw] name
113
- # @return [String]
113
+ # @return [::String]
114
114
  # The resource name of the reference image.
115
115
  #
116
116
  # Format is:
@@ -119,12 +119,12 @@ module Google
119
119
  #
120
120
  # This field is ignored when creating a reference image.
121
121
  # @!attribute [rw] uri
122
- # @return [String]
122
+ # @return [::String]
123
123
  # Required. The Google Cloud Storage URI of the reference image.
124
124
  #
125
125
  # The URI must start with `gs://`.
126
126
  # @!attribute [rw] bounding_polys
127
- # @return [Array<Google::Cloud::Vision::V1p3beta1::BoundingPoly>]
127
+ # @return [::Array<::Google::Cloud::Vision::V1p3beta1::BoundingPoly>]
128
128
  # Optional. Bounding polygons around the areas of interest in the reference image.
129
129
  # If this field is empty, the system will try to detect regions of
130
130
  # interest. At most 10 bounding polygons will be used.
@@ -134,347 +134,347 @@ module Google
134
134
  # to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5
135
135
  # is not).
136
136
  class ReferenceImage
137
- include Google::Protobuf::MessageExts
138
- extend Google::Protobuf::MessageExts::ClassMethods
137
+ include ::Google::Protobuf::MessageExts
138
+ extend ::Google::Protobuf::MessageExts::ClassMethods
139
139
  end
140
140
 
141
141
  # Request message for the `CreateProduct` method.
142
142
  # @!attribute [rw] parent
143
- # @return [String]
143
+ # @return [::String]
144
144
  # Required. The project in which the Product should be created.
145
145
  #
146
146
  # Format is
147
147
  # `projects/PROJECT_ID/locations/LOC_ID`.
148
148
  # @!attribute [rw] product
149
- # @return [Google::Cloud::Vision::V1p3beta1::Product]
149
+ # @return [::Google::Cloud::Vision::V1p3beta1::Product]
150
150
  # Required. The product to create.
151
151
  # @!attribute [rw] product_id
152
- # @return [String]
152
+ # @return [::String]
153
153
  # A user-supplied resource id for this Product. If set, the server will
154
154
  # attempt to use this value as the resource id. If it is already in use, an
155
155
  # error is returned with code ALREADY_EXISTS. Must be at most 128 characters
156
156
  # long. It cannot contain the character `/`.
157
157
  class CreateProductRequest
158
- include Google::Protobuf::MessageExts
159
- extend Google::Protobuf::MessageExts::ClassMethods
158
+ include ::Google::Protobuf::MessageExts
159
+ extend ::Google::Protobuf::MessageExts::ClassMethods
160
160
  end
161
161
 
162
162
  # Request message for the `ListProducts` method.
163
163
  # @!attribute [rw] parent
164
- # @return [String]
164
+ # @return [::String]
165
165
  # Required. The project OR ProductSet from which Products should be listed.
166
166
  #
167
167
  # Format:
168
168
  # `projects/PROJECT_ID/locations/LOC_ID`
169
169
  # @!attribute [rw] page_size
170
- # @return [Integer]
170
+ # @return [::Integer]
171
171
  # The maximum number of items to return. Default 10, maximum 100.
172
172
  # @!attribute [rw] page_token
173
- # @return [String]
173
+ # @return [::String]
174
174
  # The next_page_token returned from a previous List request, if any.
175
175
  class ListProductsRequest
176
- include Google::Protobuf::MessageExts
177
- extend Google::Protobuf::MessageExts::ClassMethods
176
+ include ::Google::Protobuf::MessageExts
177
+ extend ::Google::Protobuf::MessageExts::ClassMethods
178
178
  end
179
179
 
180
180
  # Response message for the `ListProducts` method.
181
181
  # @!attribute [rw] products
182
- # @return [Array<Google::Cloud::Vision::V1p3beta1::Product>]
182
+ # @return [::Array<::Google::Cloud::Vision::V1p3beta1::Product>]
183
183
  # List of products.
184
184
  # @!attribute [rw] next_page_token
185
- # @return [String]
185
+ # @return [::String]
186
186
  # Token to retrieve the next page of results, or empty if there are no more
187
187
  # results in the list.
188
188
  class ListProductsResponse
189
- include Google::Protobuf::MessageExts
190
- extend Google::Protobuf::MessageExts::ClassMethods
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
191
  end
192
192
 
193
193
  # Request message for the `GetProduct` method.
194
194
  # @!attribute [rw] name
195
- # @return [String]
195
+ # @return [::String]
196
196
  # Required. Resource name of the Product to get.
197
197
  #
198
198
  # Format is:
199
199
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
200
200
  class GetProductRequest
201
- include Google::Protobuf::MessageExts
202
- extend Google::Protobuf::MessageExts::ClassMethods
201
+ include ::Google::Protobuf::MessageExts
202
+ extend ::Google::Protobuf::MessageExts::ClassMethods
203
203
  end
204
204
 
205
205
  # Request message for the `UpdateProduct` method.
206
206
  # @!attribute [rw] product
207
- # @return [Google::Cloud::Vision::V1p3beta1::Product]
207
+ # @return [::Google::Cloud::Vision::V1p3beta1::Product]
208
208
  # Required. The Product resource which replaces the one on the server.
209
209
  # product.name is immutable.
210
210
  # @!attribute [rw] update_mask
211
- # @return [Google::Protobuf::FieldMask]
212
- # The {Google::Protobuf::FieldMask FieldMask} that specifies which fields
211
+ # @return [::Google::Protobuf::FieldMask]
212
+ # The {::Google::Protobuf::FieldMask FieldMask} that specifies which fields
213
213
  # to update.
214
214
  # If update_mask isn't specified, all mutable fields are to be updated.
215
215
  # Valid mask paths include `product_labels`, `display_name`, and
216
216
  # `description`.
217
217
  class UpdateProductRequest
218
- include Google::Protobuf::MessageExts
219
- extend Google::Protobuf::MessageExts::ClassMethods
218
+ include ::Google::Protobuf::MessageExts
219
+ extend ::Google::Protobuf::MessageExts::ClassMethods
220
220
  end
221
221
 
222
222
  # Request message for the `DeleteProduct` method.
223
223
  # @!attribute [rw] name
224
- # @return [String]
224
+ # @return [::String]
225
225
  # Required. Resource name of product to delete.
226
226
  #
227
227
  # Format is:
228
228
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
229
229
  class DeleteProductRequest
230
- include Google::Protobuf::MessageExts
231
- extend Google::Protobuf::MessageExts::ClassMethods
230
+ include ::Google::Protobuf::MessageExts
231
+ extend ::Google::Protobuf::MessageExts::ClassMethods
232
232
  end
233
233
 
234
234
  # Request message for the `CreateProductSet` method.
235
235
  # @!attribute [rw] parent
236
- # @return [String]
236
+ # @return [::String]
237
237
  # Required. The project in which the ProductSet should be created.
238
238
  #
239
239
  # Format is `projects/PROJECT_ID/locations/LOC_ID`.
240
240
  # @!attribute [rw] product_set
241
- # @return [Google::Cloud::Vision::V1p3beta1::ProductSet]
241
+ # @return [::Google::Cloud::Vision::V1p3beta1::ProductSet]
242
242
  # Required. The ProductSet to create.
243
243
  # @!attribute [rw] product_set_id
244
- # @return [String]
244
+ # @return [::String]
245
245
  # A user-supplied resource id for this ProductSet. If set, the server will
246
246
  # attempt to use this value as the resource id. If it is already in use, an
247
247
  # error is returned with code ALREADY_EXISTS. Must be at most 128 characters
248
248
  # long. It cannot contain the character `/`.
249
249
  class CreateProductSetRequest
250
- include Google::Protobuf::MessageExts
251
- extend Google::Protobuf::MessageExts::ClassMethods
250
+ include ::Google::Protobuf::MessageExts
251
+ extend ::Google::Protobuf::MessageExts::ClassMethods
252
252
  end
253
253
 
254
254
  # Request message for the `ListProductSets` method.
255
255
  # @!attribute [rw] parent
256
- # @return [String]
256
+ # @return [::String]
257
257
  # Required. The project from which ProductSets should be listed.
258
258
  #
259
259
  # Format is `projects/PROJECT_ID/locations/LOC_ID`.
260
260
  # @!attribute [rw] page_size
261
- # @return [Integer]
261
+ # @return [::Integer]
262
262
  # The maximum number of items to return. Default 10, maximum 100.
263
263
  # @!attribute [rw] page_token
264
- # @return [String]
264
+ # @return [::String]
265
265
  # The next_page_token returned from a previous List request, if any.
266
266
  class ListProductSetsRequest
267
- include Google::Protobuf::MessageExts
268
- extend Google::Protobuf::MessageExts::ClassMethods
267
+ include ::Google::Protobuf::MessageExts
268
+ extend ::Google::Protobuf::MessageExts::ClassMethods
269
269
  end
270
270
 
271
271
  # Response message for the `ListProductSets` method.
272
272
  # @!attribute [rw] product_sets
273
- # @return [Array<Google::Cloud::Vision::V1p3beta1::ProductSet>]
273
+ # @return [::Array<::Google::Cloud::Vision::V1p3beta1::ProductSet>]
274
274
  # List of ProductSets.
275
275
  # @!attribute [rw] next_page_token
276
- # @return [String]
276
+ # @return [::String]
277
277
  # Token to retrieve the next page of results, or empty if there are no more
278
278
  # results in the list.
279
279
  class ListProductSetsResponse
280
- include Google::Protobuf::MessageExts
281
- extend Google::Protobuf::MessageExts::ClassMethods
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
282
  end
283
283
 
284
284
  # Request message for the `GetProductSet` method.
285
285
  # @!attribute [rw] name
286
- # @return [String]
286
+ # @return [::String]
287
287
  # Required. Resource name of the ProductSet to get.
288
288
  #
289
289
  # Format is:
290
290
  # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
291
291
  class GetProductSetRequest
292
- include Google::Protobuf::MessageExts
293
- extend Google::Protobuf::MessageExts::ClassMethods
292
+ include ::Google::Protobuf::MessageExts
293
+ extend ::Google::Protobuf::MessageExts::ClassMethods
294
294
  end
295
295
 
296
296
  # Request message for the `UpdateProductSet` method.
297
297
  # @!attribute [rw] product_set
298
- # @return [Google::Cloud::Vision::V1p3beta1::ProductSet]
298
+ # @return [::Google::Cloud::Vision::V1p3beta1::ProductSet]
299
299
  # Required. The ProductSet resource which replaces the one on the server.
300
300
  # @!attribute [rw] update_mask
301
- # @return [Google::Protobuf::FieldMask]
302
- # The {Google::Protobuf::FieldMask FieldMask} that specifies which fields to
301
+ # @return [::Google::Protobuf::FieldMask]
302
+ # The {::Google::Protobuf::FieldMask FieldMask} that specifies which fields to
303
303
  # update.
304
304
  # If update_mask isn't specified, all mutable fields are to be updated.
305
305
  # Valid mask path is `display_name`.
306
306
  class UpdateProductSetRequest
307
- include Google::Protobuf::MessageExts
308
- extend Google::Protobuf::MessageExts::ClassMethods
307
+ include ::Google::Protobuf::MessageExts
308
+ extend ::Google::Protobuf::MessageExts::ClassMethods
309
309
  end
310
310
 
311
311
  # Request message for the `DeleteProductSet` method.
312
312
  # @!attribute [rw] name
313
- # @return [String]
313
+ # @return [::String]
314
314
  # Required. Resource name of the ProductSet to delete.
315
315
  #
316
316
  # Format is:
317
317
  # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
318
318
  class DeleteProductSetRequest
319
- include Google::Protobuf::MessageExts
320
- extend Google::Protobuf::MessageExts::ClassMethods
319
+ include ::Google::Protobuf::MessageExts
320
+ extend ::Google::Protobuf::MessageExts::ClassMethods
321
321
  end
322
322
 
323
323
  # Request message for the `CreateReferenceImage` method.
324
324
  # @!attribute [rw] parent
325
- # @return [String]
325
+ # @return [::String]
326
326
  # Required. Resource name of the product in which to create the reference image.
327
327
  #
328
328
  # Format is
329
329
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
330
330
  # @!attribute [rw] reference_image
331
- # @return [Google::Cloud::Vision::V1p3beta1::ReferenceImage]
331
+ # @return [::Google::Cloud::Vision::V1p3beta1::ReferenceImage]
332
332
  # Required. The reference image to create.
333
333
  # If an image ID is specified, it is ignored.
334
334
  # @!attribute [rw] reference_image_id
335
- # @return [String]
335
+ # @return [::String]
336
336
  # A user-supplied resource id for the ReferenceImage to be added. If set,
337
337
  # the server will attempt to use this value as the resource id. If it is
338
338
  # already in use, an error is returned with code ALREADY_EXISTS. Must be at
339
339
  # most 128 characters long. It cannot contain the character `/`.
340
340
  class CreateReferenceImageRequest
341
- include Google::Protobuf::MessageExts
342
- extend Google::Protobuf::MessageExts::ClassMethods
341
+ include ::Google::Protobuf::MessageExts
342
+ extend ::Google::Protobuf::MessageExts::ClassMethods
343
343
  end
344
344
 
345
345
  # Request message for the `ListReferenceImages` method.
346
346
  # @!attribute [rw] parent
347
- # @return [String]
347
+ # @return [::String]
348
348
  # Required. Resource name of the product containing the reference images.
349
349
  #
350
350
  # Format is
351
351
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
352
352
  # @!attribute [rw] page_size
353
- # @return [Integer]
353
+ # @return [::Integer]
354
354
  # The maximum number of items to return. Default 10, maximum 100.
355
355
  # @!attribute [rw] page_token
356
- # @return [String]
356
+ # @return [::String]
357
357
  # A token identifying a page of results to be returned. This is the value
358
358
  # of `nextPageToken` returned in a previous reference image list request.
359
359
  #
360
360
  # Defaults to the first page if not specified.
361
361
  class ListReferenceImagesRequest
362
- include Google::Protobuf::MessageExts
363
- extend Google::Protobuf::MessageExts::ClassMethods
362
+ include ::Google::Protobuf::MessageExts
363
+ extend ::Google::Protobuf::MessageExts::ClassMethods
364
364
  end
365
365
 
366
366
  # Response message for the `ListReferenceImages` method.
367
367
  # @!attribute [rw] reference_images
368
- # @return [Array<Google::Cloud::Vision::V1p3beta1::ReferenceImage>]
368
+ # @return [::Array<::Google::Cloud::Vision::V1p3beta1::ReferenceImage>]
369
369
  # The list of reference images.
370
370
  # @!attribute [rw] page_size
371
- # @return [Integer]
371
+ # @return [::Integer]
372
372
  # The maximum number of items to return. Default 10, maximum 100.
373
373
  # @!attribute [rw] next_page_token
374
- # @return [String]
374
+ # @return [::String]
375
375
  # The next_page_token returned from a previous List request, if any.
376
376
  class ListReferenceImagesResponse
377
- include Google::Protobuf::MessageExts
378
- extend Google::Protobuf::MessageExts::ClassMethods
377
+ include ::Google::Protobuf::MessageExts
378
+ extend ::Google::Protobuf::MessageExts::ClassMethods
379
379
  end
380
380
 
381
381
  # Request message for the `GetReferenceImage` method.
382
382
  # @!attribute [rw] name
383
- # @return [String]
383
+ # @return [::String]
384
384
  # Required. The resource name of the ReferenceImage to get.
385
385
  #
386
386
  # Format is:
387
387
  #
388
388
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.
389
389
  class GetReferenceImageRequest
390
- include Google::Protobuf::MessageExts
391
- extend Google::Protobuf::MessageExts::ClassMethods
390
+ include ::Google::Protobuf::MessageExts
391
+ extend ::Google::Protobuf::MessageExts::ClassMethods
392
392
  end
393
393
 
394
394
  # Request message for the `DeleteReferenceImage` method.
395
395
  # @!attribute [rw] name
396
- # @return [String]
396
+ # @return [::String]
397
397
  # Required. The resource name of the reference image to delete.
398
398
  #
399
399
  # Format is:
400
400
  #
401
401
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`
402
402
  class DeleteReferenceImageRequest
403
- include Google::Protobuf::MessageExts
404
- extend Google::Protobuf::MessageExts::ClassMethods
403
+ include ::Google::Protobuf::MessageExts
404
+ extend ::Google::Protobuf::MessageExts::ClassMethods
405
405
  end
406
406
 
407
407
  # Request message for the `AddProductToProductSet` method.
408
408
  # @!attribute [rw] name
409
- # @return [String]
409
+ # @return [::String]
410
410
  # Required. The resource name for the ProductSet to modify.
411
411
  #
412
412
  # Format is:
413
413
  # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
414
414
  # @!attribute [rw] product
415
- # @return [String]
415
+ # @return [::String]
416
416
  # Required. The resource name for the Product to be added to this ProductSet.
417
417
  #
418
418
  # Format is:
419
419
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
420
420
  class AddProductToProductSetRequest
421
- include Google::Protobuf::MessageExts
422
- extend Google::Protobuf::MessageExts::ClassMethods
421
+ include ::Google::Protobuf::MessageExts
422
+ extend ::Google::Protobuf::MessageExts::ClassMethods
423
423
  end
424
424
 
425
425
  # Request message for the `RemoveProductFromProductSet` method.
426
426
  # @!attribute [rw] name
427
- # @return [String]
427
+ # @return [::String]
428
428
  # Required. The resource name for the ProductSet to modify.
429
429
  #
430
430
  # Format is:
431
431
  # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
432
432
  # @!attribute [rw] product
433
- # @return [String]
433
+ # @return [::String]
434
434
  # Required. The resource name for the Product to be removed from this ProductSet.
435
435
  #
436
436
  # Format is:
437
437
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
438
438
  class RemoveProductFromProductSetRequest
439
- include Google::Protobuf::MessageExts
440
- extend Google::Protobuf::MessageExts::ClassMethods
439
+ include ::Google::Protobuf::MessageExts
440
+ extend ::Google::Protobuf::MessageExts::ClassMethods
441
441
  end
442
442
 
443
443
  # Request message for the `ListProductsInProductSet` method.
444
444
  # @!attribute [rw] name
445
- # @return [String]
445
+ # @return [::String]
446
446
  # Required. The ProductSet resource for which to retrieve Products.
447
447
  #
448
448
  # Format is:
449
449
  # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
450
450
  # @!attribute [rw] page_size
451
- # @return [Integer]
451
+ # @return [::Integer]
452
452
  # The maximum number of items to return. Default 10, maximum 100.
453
453
  # @!attribute [rw] page_token
454
- # @return [String]
454
+ # @return [::String]
455
455
  # The next_page_token returned from a previous List request, if any.
456
456
  class ListProductsInProductSetRequest
457
- include Google::Protobuf::MessageExts
458
- extend Google::Protobuf::MessageExts::ClassMethods
457
+ include ::Google::Protobuf::MessageExts
458
+ extend ::Google::Protobuf::MessageExts::ClassMethods
459
459
  end
460
460
 
461
461
  # Response message for the `ListProductsInProductSet` method.
462
462
  # @!attribute [rw] products
463
- # @return [Array<Google::Cloud::Vision::V1p3beta1::Product>]
463
+ # @return [::Array<::Google::Cloud::Vision::V1p3beta1::Product>]
464
464
  # The list of Products.
465
465
  # @!attribute [rw] next_page_token
466
- # @return [String]
466
+ # @return [::String]
467
467
  # Token to retrieve the next page of results, or empty if there are no more
468
468
  # results in the list.
469
469
  class ListProductsInProductSetResponse
470
- include Google::Protobuf::MessageExts
471
- extend Google::Protobuf::MessageExts::ClassMethods
470
+ include ::Google::Protobuf::MessageExts
471
+ extend ::Google::Protobuf::MessageExts::ClassMethods
472
472
  end
473
473
 
474
474
  # The Google Cloud Storage location for a csv file which preserves a list of
475
475
  # ImportProductSetRequests in each line.
476
476
  # @!attribute [rw] csv_file_uri
477
- # @return [String]
477
+ # @return [::String]
478
478
  # The Google Cloud Storage URI of the input csv file.
479
479
  #
480
480
  # The URI must start with `gs://`.
@@ -507,9 +507,9 @@ module Google
507
507
  #
508
508
  # If a Product doesn't exist and needs to be created on the fly, the
509
509
  # product_display_name field refers to
510
- # {Google::Cloud::Vision::V1p3beta1::Product#display_name Product.display_name},
510
+ # {::Google::Cloud::Vision::V1p3beta1::Product#display_name Product.display_name},
511
511
  # the product_category field refers to
512
- # {Google::Cloud::Vision::V1p3beta1::Product#product_category Product.product_category},
512
+ # {::Google::Cloud::Vision::V1p3beta1::Product#product_category Product.product_category},
513
513
  # and the labels field refers to [Product.labels][].
514
514
  #
515
515
  # Labels (optional) should be a line containing a list of comma-separated
@@ -533,32 +533,32 @@ module Google
533
533
  # integers should be used for absolute bounding polygons, and float values
534
534
  # in [0, 1] should be used for normalized bounding polygons.
535
535
  class ImportProductSetsGcsSource
536
- include Google::Protobuf::MessageExts
537
- extend Google::Protobuf::MessageExts::ClassMethods
536
+ include ::Google::Protobuf::MessageExts
537
+ extend ::Google::Protobuf::MessageExts::ClassMethods
538
538
  end
539
539
 
540
540
  # The input content for the `ImportProductSets` method.
541
541
  # @!attribute [rw] gcs_source
542
- # @return [Google::Cloud::Vision::V1p3beta1::ImportProductSetsGcsSource]
542
+ # @return [::Google::Cloud::Vision::V1p3beta1::ImportProductSetsGcsSource]
543
543
  # The Google Cloud Storage location for a csv file which preserves a list
544
544
  # of ImportProductSetRequests in each line.
545
545
  class ImportProductSetsInputConfig
546
- include Google::Protobuf::MessageExts
547
- extend Google::Protobuf::MessageExts::ClassMethods
546
+ include ::Google::Protobuf::MessageExts
547
+ extend ::Google::Protobuf::MessageExts::ClassMethods
548
548
  end
549
549
 
550
550
  # Request message for the `ImportProductSets` method.
551
551
  # @!attribute [rw] parent
552
- # @return [String]
552
+ # @return [::String]
553
553
  # Required. The project in which the ProductSets should be imported.
554
554
  #
555
555
  # Format is `projects/PROJECT_ID/locations/LOC_ID`.
556
556
  # @!attribute [rw] input_config
557
- # @return [Google::Cloud::Vision::V1p3beta1::ImportProductSetsInputConfig]
557
+ # @return [::Google::Cloud::Vision::V1p3beta1::ImportProductSetsInputConfig]
558
558
  # Required. The input content for the list of requests.
559
559
  class ImportProductSetsRequest
560
- include Google::Protobuf::MessageExts
561
- extend Google::Protobuf::MessageExts::ClassMethods
560
+ include ::Google::Protobuf::MessageExts
561
+ extend ::Google::Protobuf::MessageExts::ClassMethods
562
562
  end
563
563
 
564
564
  # Response message for the `ImportProductSets` method.
@@ -566,13 +566,13 @@ module Google
566
566
  # This message is returned by the
567
567
  # google.longrunning.Operations.GetOperation
568
568
  # method in the returned
569
- # {Google::Longrunning::Operation#response google.longrunning.Operation.response}
569
+ # {::Google::Longrunning::Operation#response google.longrunning.Operation.response}
570
570
  # field.
571
571
  # @!attribute [rw] reference_images
572
- # @return [Array<Google::Cloud::Vision::V1p3beta1::ReferenceImage>]
572
+ # @return [::Array<::Google::Cloud::Vision::V1p3beta1::ReferenceImage>]
573
573
  # The list of reference_images that are imported successfully.
574
574
  # @!attribute [rw] statuses
575
- # @return [Array<Google::Rpc::Status>]
575
+ # @return [::Array<::Google::Rpc::Status>]
576
576
  # The rpc status for each ImportProductSet request, including both successes
577
577
  # and errors.
578
578
  #
@@ -580,8 +580,8 @@ module Google
580
580
  # and statuses[i] stores the success or failure status of processing the i-th
581
581
  # line of the csv, starting from line 0.
582
582
  class ImportProductSetsResponse
583
- include Google::Protobuf::MessageExts
584
- extend Google::Protobuf::MessageExts::ClassMethods
583
+ include ::Google::Protobuf::MessageExts
584
+ extend ::Google::Protobuf::MessageExts::ClassMethods
585
585
  end
586
586
 
587
587
  # Metadata for the batch operations such as the current state.
@@ -589,19 +589,19 @@ module Google
589
589
  # This is included in the `metadata` field of the `Operation` returned by the
590
590
  # `GetOperation` call of the `google::longrunning::Operations` service.
591
591
  # @!attribute [rw] state
592
- # @return [Google::Cloud::Vision::V1p3beta1::BatchOperationMetadata::State]
592
+ # @return [::Google::Cloud::Vision::V1p3beta1::BatchOperationMetadata::State]
593
593
  # The current state of the batch operation.
594
594
  # @!attribute [rw] submit_time
595
- # @return [Google::Protobuf::Timestamp]
595
+ # @return [::Google::Protobuf::Timestamp]
596
596
  # The time when the batch request was submitted to the server.
597
597
  # @!attribute [rw] end_time
598
- # @return [Google::Protobuf::Timestamp]
598
+ # @return [::Google::Protobuf::Timestamp]
599
599
  # The time when the batch request is finished and
600
- # {Google::Longrunning::Operation#done google.longrunning.Operation.done} is
600
+ # {::Google::Longrunning::Operation#done google.longrunning.Operation.done} is
601
601
  # set to true.
602
602
  class BatchOperationMetadata
603
- include Google::Protobuf::MessageExts
604
- extend Google::Protobuf::MessageExts::ClassMethods
603
+ include ::Google::Protobuf::MessageExts
604
+ extend ::Google::Protobuf::MessageExts::ClassMethods
605
605
 
606
606
  # Enumerates the possible states that the batch request can be in.
607
607
  module State