google-cloud-vision-v1p3beta1 0.1.2 → 0.1.3

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 25118e68e965d6aebbca33c568d3fc84ed0efb2a6e0a3e8c4a549a8807187234
4
- data.tar.gz: 9b577372473b092181d1f98df6b39ea0056a0c28079762cf01855ab8c80393f7
3
+ metadata.gz: e5d725cef5c7efe7de779a4695f95329f9e6dc072a6286ef24846bc8877b2323
4
+ data.tar.gz: c475196633214967d77da38bb5cc499b79ef3f6d8aa9bcd679c0a8d302728021
5
5
  SHA512:
6
- metadata.gz: d809982791134291d7ac7be1f5872766a81a5acf649040d4909eb6300f3d3712065cddfad19944e6af4e218d550f5bbb4463dda289776a4f3df18dc384c94794
7
- data.tar.gz: d17281f9a9cad8f027a65241d855bc70cb4db3fa6b570c27462eeda9a3d40d5663d9c2d851c82808f04f67865c0a83877340380c52fd16e9cf27c0e11150f753
6
+ metadata.gz: 20a621e8a1d61a407fc4e3fd5b8ae1df418b60dc95e1186800a06383d38687b2e66a0fef8d4d2ab5400e1dc2aa5a9c93e46f0a694b8f41088eab1e6d160cc6fe
7
+ data.tar.gz: a079bc6565cf4ed3f2fcd035f02d156031a3a6e7c35430eb7b1c3f9d59b4a36f32b0f4aedaf82603e642e6c1c79faf2b392da980c1842fc72d1d63aad676be98
data/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Cloud Vision V1p3beta1
1
+ # Ruby Client for the Cloud Vision V1p3beta1 API
2
2
 
3
3
  API Client library for the Cloud Vision V1p3beta1 API
4
4
 
@@ -12,6 +12,53 @@ https://github.com/googleapis/google-cloud-ruby
12
12
  $ gem install google-cloud-vision-v1p3beta1
13
13
  ```
14
14
 
15
+ ## Before You Begin
16
+
17
+ In order to use this library, you first need to go through the following steps:
18
+
19
+ 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
20
+ 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
21
+ 1. {file:AUTHENTICATION.md Set up authentication.}
22
+
23
+ ## Quick Start
24
+
25
+ ```ruby
26
+ require "google/cloud/vision/v1p3beta1"
27
+
28
+ client = Google::Cloud::Vision::V1p3beta1::ProductSearch::Client.new
29
+ request = my_create_request
30
+ response = client.create_product_set request
31
+ ```
32
+
33
+ View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-vision-v1p3beta1/latest)
34
+ for class and method documentation.
35
+
36
+ ## Enabling Logging
37
+
38
+ To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
39
+ The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
40
+ or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
41
+ that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
42
+ and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
43
+
44
+ Configuring a Ruby stdlib logger:
45
+
46
+ ```ruby
47
+ require "logger"
48
+
49
+ module MyLogger
50
+ LOGGER = Logger.new $stderr, level: Logger::WARN
51
+ def logger
52
+ LOGGER
53
+ end
54
+ end
55
+
56
+ # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
57
+ module GRPC
58
+ extend MyLogger
59
+ end
60
+ ```
61
+
15
62
  ## Supported Ruby Versions
16
63
 
17
64
  This library is supported on Ruby 2.4+.
@@ -1 +1,21 @@
1
- require "google/cloud/vision/v1p3beta1/version"
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ # This gem does not autoload during Bundler.require. To load this gem,
20
+ # issue explicit require statements for the packages desired, e.g.:
21
+ # require "google/cloud/vision/v1p3beta1"
@@ -18,3 +18,19 @@
18
18
 
19
19
  require "google/cloud/vision/v1p3beta1/product_search"
20
20
  require "google/cloud/vision/v1p3beta1/image_annotator"
21
+ require "google/cloud/vision/v1p3beta1/version"
22
+
23
+ module Google
24
+ module Cloud
25
+ module Vision
26
+ ##
27
+ # To load this package, including all its services, and instantiate a client:
28
+ #
29
+ # require "google/cloud/vision/v1p3beta1"
30
+ # client = Google::Cloud::Vision::V1p3beta1::ProductSearch::Client.new
31
+ #
32
+ module V1p3beta1
33
+ end
34
+ end
35
+ end
36
+ end
@@ -16,6 +16,37 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "google/cloud/vision/v1p3beta1/image_annotator/client"
20
- require "google/cloud/vision/v1p3beta1/image_annotator/operations"
19
+ require "gapic/common"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/vision/v1p3beta1/version"
24
+
21
25
  require "google/cloud/vision/v1p3beta1/image_annotator/credentials"
26
+ require "google/cloud/vision/v1p3beta1/image_annotator/paths"
27
+ require "google/cloud/vision/v1p3beta1/image_annotator/operations"
28
+ require "google/cloud/vision/v1p3beta1/image_annotator/client"
29
+
30
+ module Google
31
+ module Cloud
32
+ module Vision
33
+ module V1p3beta1
34
+ ##
35
+ # Service that performs Google Cloud Vision API detection tasks over client
36
+ # images, such as face, landmark, logo, label, and text detection. The
37
+ # ImageAnnotator service returns detected entities from the images.
38
+ #
39
+ # To load this service and instantiate a client:
40
+ #
41
+ # require "google/cloud/vision/v1p3beta1/image_annotator"
42
+ # client = Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Client.new
43
+ #
44
+ module ImageAnnotator
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
50
+
51
+ helper_path = ::File.join __dir__, "image_annotator", "helpers.rb"
52
+ require "google/cloud/vision/v1p3beta1/image_annotator/helpers" if ::File.file? helper_path
@@ -16,16 +16,8 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "gapic/common"
20
- require "gapic/config"
21
- require "gapic/config/method"
22
-
23
19
  require "google/cloud/errors"
24
- require "google/cloud/vision/v1p3beta1/version"
25
20
  require "google/cloud/vision/v1p3beta1/image_annotator_pb"
26
- require "google/cloud/vision/v1p3beta1/image_annotator/credentials"
27
- require "google/cloud/vision/v1p3beta1/image_annotator/paths"
28
- require "google/cloud/vision/v1p3beta1/image_annotator/operations"
29
21
 
30
22
  module Google
31
23
  module Cloud
@@ -177,15 +169,22 @@ module Google
177
169
  # Run image detection and annotation for a batch of images.
178
170
  #
179
171
  # @overload batch_annotate_images(request, options = nil)
180
- # @param request [Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesRequest | Hash]
181
- # Run image detection and annotation for a batch of images.
172
+ # Pass arguments to `batch_annotate_images` via a request object, either of type
173
+ # {Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesRequest} or an equivalent Hash.
174
+ #
175
+ # @param request [Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesRequest, Hash]
176
+ # A request object representing the call parameters. Required. To specify no
177
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
182
178
  # @param options [Gapic::CallOptions, Hash]
183
179
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
184
180
  #
185
181
  # @overload batch_annotate_images(requests: nil)
186
- # @param requests [Array<Google::Cloud::Vision::V1p3beta1::AnnotateImageRequest | Hash>]
187
- # Individual image annotation requests for this batch.
182
+ # Pass arguments to `batch_annotate_images` via keyword arguments. Note that at
183
+ # least one keyword argument is required. To specify no parameters, or to keep all
184
+ # the default parameter values, pass an empty Hash as a request object (see above).
188
185
  #
186
+ # @param requests [Array<Google::Cloud::Vision::V1p3beta1::AnnotateImageRequest, Hash>]
187
+ # Individual image annotation requests for this batch.
189
188
  #
190
189
  # @yield [response, operation] Access the result along with the RPC operation
191
190
  # @yieldparam response [Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesResponse]
@@ -235,20 +234,22 @@ module Google
235
234
  # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
236
235
  #
237
236
  # @overload async_batch_annotate_files(request, options = nil)
238
- # @param request [Google::Cloud::Vision::V1p3beta1::AsyncBatchAnnotateFilesRequest | Hash]
239
- # Run asynchronous image detection and annotation for a list of generic
240
- # files, such as PDF files, which may contain multiple pages and multiple
241
- # images per page. Progress and results can be retrieved through the
242
- # `google.longrunning.Operations` interface.
243
- # `Operation.metadata` contains `OperationMetadata` (metadata).
244
- # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
237
+ # Pass arguments to `async_batch_annotate_files` via a request object, either of type
238
+ # {Google::Cloud::Vision::V1p3beta1::AsyncBatchAnnotateFilesRequest} or an equivalent Hash.
239
+ #
240
+ # @param request [Google::Cloud::Vision::V1p3beta1::AsyncBatchAnnotateFilesRequest, Hash]
241
+ # A request object representing the call parameters. Required. To specify no
242
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
245
243
  # @param options [Gapic::CallOptions, Hash]
246
244
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
247
245
  #
248
246
  # @overload async_batch_annotate_files(requests: nil)
249
- # @param requests [Array<Google::Cloud::Vision::V1p3beta1::AsyncAnnotateFileRequest | Hash>]
250
- # Required. Individual async file annotation requests for this batch.
247
+ # Pass arguments to `async_batch_annotate_files` via keyword arguments. Note that at
248
+ # least one keyword argument is required. To specify no parameters, or to keep all
249
+ # the default parameter values, pass an empty Hash as a request object (see above).
251
250
  #
251
+ # @param requests [Array<Google::Cloud::Vision::V1p3beta1::AsyncAnnotateFileRequest, Hash>]
252
+ # Required. Individual async file annotation requests for this batch.
252
253
  #
253
254
  # @yield [response, operation] Access the result along with the RPC operation
254
255
  # @yieldparam response [Gapic::Operation]
@@ -450,13 +451,3 @@ module Google
450
451
  end
451
452
  end
452
453
  end
453
-
454
- # rubocop:disable Lint/HandleExceptions
455
-
456
- # Once client is loaded, load helpers.rb if it exists.
457
- begin
458
- require "google/cloud/vision/v1p3beta1/image_annotator/helpers"
459
- rescue LoadError
460
- end
461
-
462
- # rubocop:enable Lint/HandleExceptions
@@ -16,11 +16,7 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "gapic/common"
20
19
  require "gapic/operation"
21
-
22
- require "google/cloud/vision/v1p3beta1/version"
23
- require "google/cloud/vision/v1p3beta1/image_annotator/client"
24
20
  require "google/longrunning/operations_pb"
25
21
 
26
22
  module Google
@@ -109,16 +105,20 @@ module Google
109
105
  # to use different resource name schemes, such as `users/*/operations`.
110
106
  #
111
107
  # @overload list_operations(request, options = nil)
112
- # @param request [Google::Longrunning::ListOperationsRequest | Hash]
113
- # Lists operations that match the specified filter in the request. If the
114
- # server doesn't support this method, it returns `UNIMPLEMENTED`.
108
+ # Pass arguments to `list_operations` via a request object, either of type
109
+ # {Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
115
110
  #
116
- # NOTE: the `name` binding below allows API services to override the binding
117
- # to use different resource name schemes, such as `users/*/operations`.
111
+ # @param request [Google::Longrunning::ListOperationsRequest, Hash]
112
+ # A request object representing the call parameters. Required. To specify no
113
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
118
114
  # @param options [Gapic::CallOptions, Hash]
119
115
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
120
116
  #
121
117
  # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
118
+ # Pass arguments to `list_operations` via keyword arguments. Note that at
119
+ # least one keyword argument is required. To specify no parameters, or to keep all
120
+ # the default parameter values, pass an empty Hash as a request object (see above).
121
+ #
122
122
  # @param name [String]
123
123
  # The name of the operation collection.
124
124
  # @param filter [String]
@@ -128,7 +128,6 @@ module Google
128
128
  # @param page_token [String]
129
129
  # The standard list page token.
130
130
  #
131
- #
132
131
  # @yield [response, operation] Access the result along with the RPC operation
133
132
  # @yieldparam response [Gapic::PagedEnumerable<Gapic::Operation>]
134
133
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -182,18 +181,23 @@ module Google
182
181
  # service.
183
182
  #
184
183
  # @overload get_operation(request, options = nil)
185
- # @param request [Google::Longrunning::GetOperationRequest | Hash]
186
- # Gets the latest state of a long-running operation. Clients can use this
187
- # method to poll the operation result at intervals as recommended by the API
188
- # service.
184
+ # Pass arguments to `get_operation` via a request object, either of type
185
+ # {Google::Longrunning::GetOperationRequest} or an equivalent Hash.
186
+ #
187
+ # @param request [Google::Longrunning::GetOperationRequest, Hash]
188
+ # A request object representing the call parameters. Required. To specify no
189
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
189
190
  # @param options [Gapic::CallOptions, Hash]
190
191
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
191
192
  #
192
193
  # @overload get_operation(name: nil)
194
+ # Pass arguments to `get_operation` via keyword arguments. Note that at
195
+ # least one keyword argument is required. To specify no parameters, or to keep all
196
+ # the default parameter values, pass an empty Hash as a request object (see above).
197
+ #
193
198
  # @param name [String]
194
199
  # The name of the operation resource.
195
200
  #
196
- #
197
201
  # @yield [response, operation] Access the result along with the RPC operation
198
202
  # @yieldparam response [Gapic::Operation]
199
203
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -247,19 +251,23 @@ module Google
247
251
  # `google.rpc.Code.UNIMPLEMENTED`.
248
252
  #
249
253
  # @overload delete_operation(request, options = nil)
250
- # @param request [Google::Longrunning::DeleteOperationRequest | Hash]
251
- # Deletes a long-running operation. This method indicates that the client is
252
- # no longer interested in the operation result. It does not cancel the
253
- # operation. If the server doesn't support this method, it returns
254
- # `google.rpc.Code.UNIMPLEMENTED`.
254
+ # Pass arguments to `delete_operation` via a request object, either of type
255
+ # {Google::Longrunning::DeleteOperationRequest} or an equivalent Hash.
256
+ #
257
+ # @param request [Google::Longrunning::DeleteOperationRequest, Hash]
258
+ # A request object representing the call parameters. Required. To specify no
259
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
255
260
  # @param options [Gapic::CallOptions, Hash]
256
261
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
257
262
  #
258
263
  # @overload delete_operation(name: nil)
264
+ # Pass arguments to `delete_operation` via keyword arguments. Note that at
265
+ # least one keyword argument is required. To specify no parameters, or to keep all
266
+ # the default parameter values, pass an empty Hash as a request object (see above).
267
+ #
259
268
  # @param name [String]
260
269
  # The name of the operation resource to be deleted.
261
270
  #
262
- #
263
271
  # @yield [response, operation] Access the result along with the RPC operation
264
272
  # @yieldparam response [Google::Protobuf::Empty]
265
273
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -318,25 +326,23 @@ module Google
318
326
  # corresponding to `Code.CANCELLED`.
319
327
  #
320
328
  # @overload cancel_operation(request, options = nil)
321
- # @param request [Google::Longrunning::CancelOperationRequest | Hash]
322
- # Starts asynchronous cancellation on a long-running operation. The server
323
- # makes a best effort to cancel the operation, but success is not
324
- # guaranteed. If the server doesn't support this method, it returns
325
- # `google.rpc.Code.UNIMPLEMENTED`. Clients can use
326
- # Operations.GetOperation or
327
- # other methods to check whether the cancellation succeeded or whether the
328
- # operation completed despite cancellation. On successful cancellation,
329
- # the operation is not deleted; instead, it becomes an operation with
330
- # an {Google::Longrunning::Operation#error Operation.error} value with a {Google::Rpc::Status#code google.rpc.Status.code} of 1,
331
- # corresponding to `Code.CANCELLED`.
329
+ # Pass arguments to `cancel_operation` via a request object, either of type
330
+ # {Google::Longrunning::CancelOperationRequest} or an equivalent Hash.
331
+ #
332
+ # @param request [Google::Longrunning::CancelOperationRequest, Hash]
333
+ # A request object representing the call parameters. Required. To specify no
334
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
332
335
  # @param options [Gapic::CallOptions, Hash]
333
336
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
334
337
  #
335
338
  # @overload cancel_operation(name: nil)
339
+ # Pass arguments to `cancel_operation` via keyword arguments. Note that at
340
+ # least one keyword argument is required. To specify no parameters, or to keep all
341
+ # the default parameter values, pass an empty Hash as a request object (see above).
342
+ #
336
343
  # @param name [String]
337
344
  # The name of the operation resource to be cancelled.
338
345
  #
339
- #
340
346
  # @yield [response, operation] Access the result along with the RPC operation
341
347
  # @yieldparam response [Google::Protobuf::Empty]
342
348
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -16,6 +16,48 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "google/cloud/vision/v1p3beta1/product_search/client"
20
- require "google/cloud/vision/v1p3beta1/product_search/operations"
19
+ require "gapic/common"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/vision/v1p3beta1/version"
24
+
21
25
  require "google/cloud/vision/v1p3beta1/product_search/credentials"
26
+ require "google/cloud/vision/v1p3beta1/product_search/paths"
27
+ require "google/cloud/vision/v1p3beta1/product_search/operations"
28
+ require "google/cloud/vision/v1p3beta1/product_search/client"
29
+
30
+ module Google
31
+ module Cloud
32
+ module Vision
33
+ module V1p3beta1
34
+ ##
35
+ # Manages Products and ProductSets of reference images for use in product
36
+ # search. It uses the following resource model:
37
+ #
38
+ # - The API has a collection of {Google::Cloud::Vision::V1p3beta1::ProductSet ProductSet} resources, named
39
+ # `projects/*/locations/*/productSets/*`, which acts as a way to put different
40
+ # products into groups to limit identification.
41
+ #
42
+ # In parallel,
43
+ #
44
+ # - The API has a collection of {Google::Cloud::Vision::V1p3beta1::Product Product} resources, named
45
+ # `projects/*/locations/*/products/*`
46
+ #
47
+ # - Each {Google::Cloud::Vision::V1p3beta1::Product Product} has a collection of {Google::Cloud::Vision::V1p3beta1::ReferenceImage ReferenceImage} resources, named
48
+ # `projects/*/locations/*/products/*/referenceImages/*`
49
+ #
50
+ # To load this service and instantiate a client:
51
+ #
52
+ # require "google/cloud/vision/v1p3beta1/product_search"
53
+ # client = Google::Cloud::Vision::V1p3beta1::ProductSearch::Client.new
54
+ #
55
+ module ProductSearch
56
+ end
57
+ end
58
+ end
59
+ end
60
+ end
61
+
62
+ helper_path = ::File.join __dir__, "product_search", "helpers.rb"
63
+ require "google/cloud/vision/v1p3beta1/product_search/helpers" if ::File.file? helper_path
@@ -16,16 +16,8 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "gapic/common"
20
- require "gapic/config"
21
- require "gapic/config/method"
22
-
23
19
  require "google/cloud/errors"
24
- require "google/cloud/vision/v1p3beta1/version"
25
20
  require "google/cloud/vision/v1p3beta1/product_search_service_pb"
26
- require "google/cloud/vision/v1p3beta1/product_search/credentials"
27
- require "google/cloud/vision/v1p3beta1/product_search/paths"
28
- require "google/cloud/vision/v1p3beta1/product_search/operations"
29
21
 
30
22
  module Google
31
23
  module Cloud
@@ -321,22 +313,25 @@ module Google
321
313
  # 4096 characters.
322
314
  #
323
315
  # @overload create_product_set(request, options = nil)
324
- # @param request [Google::Cloud::Vision::V1p3beta1::CreateProductSetRequest | Hash]
325
- # Creates and returns a new ProductSet resource.
326
- #
327
- # Possible errors:
316
+ # Pass arguments to `create_product_set` via a request object, either of type
317
+ # {Google::Cloud::Vision::V1p3beta1::CreateProductSetRequest} or an equivalent Hash.
328
318
  #
329
- # * Returns INVALID_ARGUMENT if display_name is missing, or is longer than
330
- # 4096 characters.
319
+ # @param request [Google::Cloud::Vision::V1p3beta1::CreateProductSetRequest, Hash]
320
+ # A request object representing the call parameters. Required. To specify no
321
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
331
322
  # @param options [Gapic::CallOptions, Hash]
332
323
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
333
324
  #
334
325
  # @overload create_product_set(parent: nil, product_set: nil, product_set_id: nil)
326
+ # Pass arguments to `create_product_set` via keyword arguments. Note that at
327
+ # least one keyword argument is required. To specify no parameters, or to keep all
328
+ # the default parameter values, pass an empty Hash as a request object (see above).
329
+ #
335
330
  # @param parent [String]
336
331
  # Required. The project in which the ProductSet should be created.
337
332
  #
338
333
  # Format is `projects/PROJECT_ID/locations/LOC_ID`.
339
- # @param product_set [Google::Cloud::Vision::V1p3beta1::ProductSet | Hash]
334
+ # @param product_set [Google::Cloud::Vision::V1p3beta1::ProductSet, Hash]
340
335
  # Required. The ProductSet to create.
341
336
  # @param product_set_id [String]
342
337
  # A user-supplied resource id for this ProductSet. If set, the server will
@@ -344,7 +339,6 @@ module Google
344
339
  # error is returned with code ALREADY_EXISTS. Must be at most 128 characters
345
340
  # long. It cannot contain the character `/`.
346
341
  #
347
- #
348
342
  # @yield [response, operation] Access the result along with the RPC operation
349
343
  # @yieldparam response [Google::Cloud::Vision::V1p3beta1::ProductSet]
350
344
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -399,17 +393,20 @@ module Google
399
393
  # than 1.
400
394
  #
401
395
  # @overload list_product_sets(request, options = nil)
402
- # @param request [Google::Cloud::Vision::V1p3beta1::ListProductSetsRequest | Hash]
403
- # Lists ProductSets in an unspecified order.
404
- #
405
- # Possible errors:
396
+ # Pass arguments to `list_product_sets` via a request object, either of type
397
+ # {Google::Cloud::Vision::V1p3beta1::ListProductSetsRequest} or an equivalent Hash.
406
398
  #
407
- # * Returns INVALID_ARGUMENT if page_size is greater than 100, or less
408
- # than 1.
399
+ # @param request [Google::Cloud::Vision::V1p3beta1::ListProductSetsRequest, Hash]
400
+ # A request object representing the call parameters. Required. To specify no
401
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
409
402
  # @param options [Gapic::CallOptions, Hash]
410
403
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
411
404
  #
412
405
  # @overload list_product_sets(parent: nil, page_size: nil, page_token: nil)
406
+ # Pass arguments to `list_product_sets` via keyword arguments. Note that at
407
+ # least one keyword argument is required. To specify no parameters, or to keep all
408
+ # the default parameter values, pass an empty Hash as a request object (see above).
409
+ #
413
410
  # @param parent [String]
414
411
  # Required. The project from which ProductSets should be listed.
415
412
  #
@@ -419,7 +416,6 @@ module Google
419
416
  # @param page_token [String]
420
417
  # The next_page_token returned from a previous List request, if any.
421
418
  #
422
- #
423
419
  # @yield [response, operation] Access the result along with the RPC operation
424
420
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::Vision::V1p3beta1::ProductSet>]
425
421
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -474,23 +470,26 @@ module Google
474
470
  # * Returns NOT_FOUND if the ProductSet does not exist.
475
471
  #
476
472
  # @overload get_product_set(request, options = nil)
477
- # @param request [Google::Cloud::Vision::V1p3beta1::GetProductSetRequest | Hash]
478
- # Gets information associated with a ProductSet.
473
+ # Pass arguments to `get_product_set` via a request object, either of type
474
+ # {Google::Cloud::Vision::V1p3beta1::GetProductSetRequest} or an equivalent Hash.
479
475
  #
480
- # Possible errors:
481
- #
482
- # * Returns NOT_FOUND if the ProductSet does not exist.
476
+ # @param request [Google::Cloud::Vision::V1p3beta1::GetProductSetRequest, Hash]
477
+ # A request object representing the call parameters. Required. To specify no
478
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
483
479
  # @param options [Gapic::CallOptions, Hash]
484
480
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
485
481
  #
486
482
  # @overload get_product_set(name: nil)
483
+ # Pass arguments to `get_product_set` via keyword arguments. Note that at
484
+ # least one keyword argument is required. To specify no parameters, or to keep all
485
+ # the default parameter values, pass an empty Hash as a request object (see above).
486
+ #
487
487
  # @param name [String]
488
488
  # Required. Resource name of the ProductSet to get.
489
489
  #
490
490
  # Format is:
491
491
  # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
492
492
  #
493
- #
494
493
  # @yield [response, operation] Access the result along with the RPC operation
495
494
  # @yieldparam response [Google::Cloud::Vision::V1p3beta1::ProductSet]
496
495
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -547,28 +546,28 @@ module Google
547
546
  # missing from the request or longer than 4096 characters.
548
547
  #
549
548
  # @overload update_product_set(request, options = nil)
550
- # @param request [Google::Cloud::Vision::V1p3beta1::UpdateProductSetRequest | Hash]
551
- # Makes changes to a ProductSet resource.
552
- # Only display_name can be updated currently.
553
- #
554
- # Possible errors:
549
+ # Pass arguments to `update_product_set` via a request object, either of type
550
+ # {Google::Cloud::Vision::V1p3beta1::UpdateProductSetRequest} or an equivalent Hash.
555
551
  #
556
- # * Returns NOT_FOUND if the ProductSet does not exist.
557
- # * Returns INVALID_ARGUMENT if display_name is present in update_mask but
558
- # missing from the request or longer than 4096 characters.
552
+ # @param request [Google::Cloud::Vision::V1p3beta1::UpdateProductSetRequest, Hash]
553
+ # A request object representing the call parameters. Required. To specify no
554
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
559
555
  # @param options [Gapic::CallOptions, Hash]
560
556
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
561
557
  #
562
558
  # @overload update_product_set(product_set: nil, update_mask: nil)
563
- # @param product_set [Google::Cloud::Vision::V1p3beta1::ProductSet | Hash]
559
+ # Pass arguments to `update_product_set` via keyword arguments. Note that at
560
+ # least one keyword argument is required. To specify no parameters, or to keep all
561
+ # the default parameter values, pass an empty Hash as a request object (see above).
562
+ #
563
+ # @param product_set [Google::Cloud::Vision::V1p3beta1::ProductSet, Hash]
564
564
  # Required. The ProductSet resource which replaces the one on the server.
565
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
565
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
566
566
  # The {Google::Protobuf::FieldMask FieldMask} that specifies which fields to
567
567
  # update.
568
568
  # If update_mask isn't specified, all mutable fields are to be updated.
569
569
  # Valid mask path is `display_name`.
570
570
  #
571
- #
572
571
  # @yield [response, operation] Access the result along with the RPC operation
573
572
  # @yieldparam response [Google::Cloud::Vision::V1p3beta1::ProductSet]
574
573
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -625,26 +624,26 @@ module Google
625
624
  # * Returns NOT_FOUND if the ProductSet does not exist.
626
625
  #
627
626
  # @overload delete_product_set(request, options = nil)
628
- # @param request [Google::Cloud::Vision::V1p3beta1::DeleteProductSetRequest | Hash]
629
- # Permanently deletes a ProductSet. All Products and ReferenceImages in the
630
- # ProductSet will be deleted.
627
+ # Pass arguments to `delete_product_set` via a request object, either of type
628
+ # {Google::Cloud::Vision::V1p3beta1::DeleteProductSetRequest} or an equivalent Hash.
631
629
  #
632
- # The actual image files are not deleted from Google Cloud Storage.
633
- #
634
- # Possible errors:
635
- #
636
- # * Returns NOT_FOUND if the ProductSet does not exist.
630
+ # @param request [Google::Cloud::Vision::V1p3beta1::DeleteProductSetRequest, Hash]
631
+ # A request object representing the call parameters. Required. To specify no
632
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
637
633
  # @param options [Gapic::CallOptions, Hash]
638
634
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
639
635
  #
640
636
  # @overload delete_product_set(name: nil)
637
+ # Pass arguments to `delete_product_set` via keyword arguments. Note that at
638
+ # least one keyword argument is required. To specify no parameters, or to keep all
639
+ # the default parameter values, pass an empty Hash as a request object (see above).
640
+ #
641
641
  # @param name [String]
642
642
  # Required. Resource name of the ProductSet to delete.
643
643
  #
644
644
  # Format is:
645
645
  # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
646
646
  #
647
- #
648
647
  # @yield [response, operation] Access the result along with the RPC operation
649
648
  # @yieldparam response [Google::Protobuf::Empty]
650
649
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -701,25 +700,26 @@ module Google
701
700
  # * Returns INVALID_ARGUMENT if product_category is missing or invalid.
702
701
  #
703
702
  # @overload create_product(request, options = nil)
704
- # @param request [Google::Cloud::Vision::V1p3beta1::CreateProductRequest | Hash]
705
- # Creates and returns a new product resource.
703
+ # Pass arguments to `create_product` via a request object, either of type
704
+ # {Google::Cloud::Vision::V1p3beta1::CreateProductRequest} or an equivalent Hash.
706
705
  #
707
- # Possible errors:
708
- #
709
- # * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096
710
- # characters.
711
- # * Returns INVALID_ARGUMENT if description is longer than 4096 characters.
712
- # * Returns INVALID_ARGUMENT if product_category is missing or invalid.
706
+ # @param request [Google::Cloud::Vision::V1p3beta1::CreateProductRequest, Hash]
707
+ # A request object representing the call parameters. Required. To specify no
708
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
713
709
  # @param options [Gapic::CallOptions, Hash]
714
710
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
715
711
  #
716
712
  # @overload create_product(parent: nil, product: nil, product_id: nil)
713
+ # Pass arguments to `create_product` via keyword arguments. Note that at
714
+ # least one keyword argument is required. To specify no parameters, or to keep all
715
+ # the default parameter values, pass an empty Hash as a request object (see above).
716
+ #
717
717
  # @param parent [String]
718
718
  # Required. The project in which the Product should be created.
719
719
  #
720
720
  # Format is
721
721
  # `projects/PROJECT_ID/locations/LOC_ID`.
722
- # @param product [Google::Cloud::Vision::V1p3beta1::Product | Hash]
722
+ # @param product [Google::Cloud::Vision::V1p3beta1::Product, Hash]
723
723
  # Required. The product to create.
724
724
  # @param product_id [String]
725
725
  # A user-supplied resource id for this Product. If set, the server will
@@ -727,7 +727,6 @@ module Google
727
727
  # error is returned with code ALREADY_EXISTS. Must be at most 128 characters
728
728
  # long. It cannot contain the character `/`.
729
729
  #
730
- #
731
730
  # @yield [response, operation] Access the result along with the RPC operation
732
731
  # @yieldparam response [Google::Cloud::Vision::V1p3beta1::Product]
733
732
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -781,16 +780,20 @@ module Google
781
780
  # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
782
781
  #
783
782
  # @overload list_products(request, options = nil)
784
- # @param request [Google::Cloud::Vision::V1p3beta1::ListProductsRequest | Hash]
785
- # Lists products in an unspecified order.
786
- #
787
- # Possible errors:
783
+ # Pass arguments to `list_products` via a request object, either of type
784
+ # {Google::Cloud::Vision::V1p3beta1::ListProductsRequest} or an equivalent Hash.
788
785
  #
789
- # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
786
+ # @param request [Google::Cloud::Vision::V1p3beta1::ListProductsRequest, Hash]
787
+ # A request object representing the call parameters. Required. To specify no
788
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
790
789
  # @param options [Gapic::CallOptions, Hash]
791
790
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
792
791
  #
793
792
  # @overload list_products(parent: nil, page_size: nil, page_token: nil)
793
+ # Pass arguments to `list_products` via keyword arguments. Note that at
794
+ # least one keyword argument is required. To specify no parameters, or to keep all
795
+ # the default parameter values, pass an empty Hash as a request object (see above).
796
+ #
794
797
  # @param parent [String]
795
798
  # Required. The project OR ProductSet from which Products should be listed.
796
799
  #
@@ -801,7 +804,6 @@ module Google
801
804
  # @param page_token [String]
802
805
  # The next_page_token returned from a previous List request, if any.
803
806
  #
804
- #
805
807
  # @yield [response, operation] Access the result along with the RPC operation
806
808
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::Vision::V1p3beta1::Product>]
807
809
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -856,23 +858,26 @@ module Google
856
858
  # * Returns NOT_FOUND if the Product does not exist.
857
859
  #
858
860
  # @overload get_product(request, options = nil)
859
- # @param request [Google::Cloud::Vision::V1p3beta1::GetProductRequest | Hash]
860
- # Gets information associated with a Product.
861
+ # Pass arguments to `get_product` via a request object, either of type
862
+ # {Google::Cloud::Vision::V1p3beta1::GetProductRequest} or an equivalent Hash.
861
863
  #
862
- # Possible errors:
863
- #
864
- # * Returns NOT_FOUND if the Product does not exist.
864
+ # @param request [Google::Cloud::Vision::V1p3beta1::GetProductRequest, Hash]
865
+ # A request object representing the call parameters. Required. To specify no
866
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
865
867
  # @param options [Gapic::CallOptions, Hash]
866
868
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
867
869
  #
868
870
  # @overload get_product(name: nil)
871
+ # Pass arguments to `get_product` via keyword arguments. Note that at
872
+ # least one keyword argument is required. To specify no parameters, or to keep all
873
+ # the default parameter values, pass an empty Hash as a request object (see above).
874
+ #
869
875
  # @param name [String]
870
876
  # Required. Resource name of the Product to get.
871
877
  #
872
878
  # Format is:
873
879
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
874
880
  #
875
- #
876
881
  # @yield [response, operation] Access the result along with the RPC operation
877
882
  # @yieldparam response [Google::Cloud::Vision::V1p3beta1::Product]
878
883
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -935,36 +940,30 @@ module Google
935
940
  # * Returns INVALID_ARGUMENT if product_category is present in update_mask.
936
941
  #
937
942
  # @overload update_product(request, options = nil)
938
- # @param request [Google::Cloud::Vision::V1p3beta1::UpdateProductRequest | Hash]
939
- # Makes changes to a Product resource.
940
- # Only display_name, description and labels can be updated right now.
941
- #
942
- # If labels are updated, the change will not be reflected in queries until
943
- # the next index time.
943
+ # Pass arguments to `update_product` via a request object, either of type
944
+ # {Google::Cloud::Vision::V1p3beta1::UpdateProductRequest} or an equivalent Hash.
944
945
  #
945
- # Possible errors:
946
- #
947
- # * Returns NOT_FOUND if the Product does not exist.
948
- # * Returns INVALID_ARGUMENT if display_name is present in update_mask but is
949
- # missing from the request or longer than 4096 characters.
950
- # * Returns INVALID_ARGUMENT if description is present in update_mask but is
951
- # longer than 4096 characters.
952
- # * Returns INVALID_ARGUMENT if product_category is present in update_mask.
946
+ # @param request [Google::Cloud::Vision::V1p3beta1::UpdateProductRequest, Hash]
947
+ # A request object representing the call parameters. Required. To specify no
948
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
953
949
  # @param options [Gapic::CallOptions, Hash]
954
950
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
955
951
  #
956
952
  # @overload update_product(product: nil, update_mask: nil)
957
- # @param product [Google::Cloud::Vision::V1p3beta1::Product | Hash]
953
+ # Pass arguments to `update_product` via keyword arguments. Note that at
954
+ # least one keyword argument is required. To specify no parameters, or to keep all
955
+ # the default parameter values, pass an empty Hash as a request object (see above).
956
+ #
957
+ # @param product [Google::Cloud::Vision::V1p3beta1::Product, Hash]
958
958
  # Required. The Product resource which replaces the one on the server.
959
959
  # product.name is immutable.
960
- # @param update_mask [Google::Protobuf::FieldMask | Hash]
960
+ # @param update_mask [Google::Protobuf::FieldMask, Hash]
961
961
  # The {Google::Protobuf::FieldMask FieldMask} that specifies which fields
962
962
  # to update.
963
963
  # If update_mask isn't specified, all mutable fields are to be updated.
964
964
  # Valid mask paths include `product_labels`, `display_name`, and
965
965
  # `description`.
966
966
  #
967
- #
968
967
  # @yield [response, operation] Access the result along with the RPC operation
969
968
  # @yieldparam response [Google::Cloud::Vision::V1p3beta1::Product]
970
969
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1022,27 +1021,26 @@ module Google
1022
1021
  # * Returns NOT_FOUND if the product does not exist.
1023
1022
  #
1024
1023
  # @overload delete_product(request, options = nil)
1025
- # @param request [Google::Cloud::Vision::V1p3beta1::DeleteProductRequest | Hash]
1026
- # Permanently deletes a product and its reference images.
1027
- #
1028
- # Metadata of the product and all its images will be deleted right away, but
1029
- # search queries against ProductSets containing the product may still work
1030
- # until all related caches are refreshed.
1024
+ # Pass arguments to `delete_product` via a request object, either of type
1025
+ # {Google::Cloud::Vision::V1p3beta1::DeleteProductRequest} or an equivalent Hash.
1031
1026
  #
1032
- # Possible errors:
1033
- #
1034
- # * Returns NOT_FOUND if the product does not exist.
1027
+ # @param request [Google::Cloud::Vision::V1p3beta1::DeleteProductRequest, Hash]
1028
+ # A request object representing the call parameters. Required. To specify no
1029
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1035
1030
  # @param options [Gapic::CallOptions, Hash]
1036
1031
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1037
1032
  #
1038
1033
  # @overload delete_product(name: nil)
1034
+ # Pass arguments to `delete_product` via keyword arguments. Note that at
1035
+ # least one keyword argument is required. To specify no parameters, or to keep all
1036
+ # the default parameter values, pass an empty Hash as a request object (see above).
1037
+ #
1039
1038
  # @param name [String]
1040
1039
  # Required. Resource name of product to delete.
1041
1040
  #
1042
1041
  # Format is:
1043
1042
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
1044
1043
  #
1045
- #
1046
1044
  # @yield [response, operation] Access the result along with the RPC operation
1047
1045
  # @yieldparam response [Google::Protobuf::Empty]
1048
1046
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1110,36 +1108,26 @@ module Google
1110
1108
  # * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.
1111
1109
  #
1112
1110
  # @overload create_reference_image(request, options = nil)
1113
- # @param request [Google::Cloud::Vision::V1p3beta1::CreateReferenceImageRequest | Hash]
1114
- # Creates and returns a new ReferenceImage resource.
1115
- #
1116
- # The `bounding_poly` field is optional. If `bounding_poly` is not specified,
1117
- # the system will try to detect regions of interest in the image that are
1118
- # compatible with the product_category on the parent product. If it is
1119
- # specified, detection is ALWAYS skipped. The system converts polygons into
1120
- # non-rotated rectangles.
1121
- #
1122
- # Note that the pipeline will resize the image if the image resolution is too
1123
- # large to process (above 50MP).
1124
- #
1125
- # Possible errors:
1126
- #
1127
- # * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096
1128
- # characters.
1129
- # * Returns INVALID_ARGUMENT if the product does not exist.
1130
- # * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing
1131
- # compatible with the parent product's product_category is detected.
1132
- # * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.
1111
+ # Pass arguments to `create_reference_image` via a request object, either of type
1112
+ # {Google::Cloud::Vision::V1p3beta1::CreateReferenceImageRequest} or an equivalent Hash.
1113
+ #
1114
+ # @param request [Google::Cloud::Vision::V1p3beta1::CreateReferenceImageRequest, Hash]
1115
+ # A request object representing the call parameters. Required. To specify no
1116
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1133
1117
  # @param options [Gapic::CallOptions, Hash]
1134
1118
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1135
1119
  #
1136
1120
  # @overload create_reference_image(parent: nil, reference_image: nil, reference_image_id: nil)
1121
+ # Pass arguments to `create_reference_image` via keyword arguments. Note that at
1122
+ # least one keyword argument is required. To specify no parameters, or to keep all
1123
+ # the default parameter values, pass an empty Hash as a request object (see above).
1124
+ #
1137
1125
  # @param parent [String]
1138
1126
  # Required. Resource name of the product in which to create the reference image.
1139
1127
  #
1140
1128
  # Format is
1141
1129
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
1142
- # @param reference_image [Google::Cloud::Vision::V1p3beta1::ReferenceImage | Hash]
1130
+ # @param reference_image [Google::Cloud::Vision::V1p3beta1::ReferenceImage, Hash]
1143
1131
  # Required. The reference image to create.
1144
1132
  # If an image ID is specified, it is ignored.
1145
1133
  # @param reference_image_id [String]
@@ -1148,7 +1136,6 @@ module Google
1148
1136
  # already in use, an error is returned with code ALREADY_EXISTS. Must be at
1149
1137
  # most 128 characters long. It cannot contain the character `/`.
1150
1138
  #
1151
- #
1152
1139
  # @yield [response, operation] Access the result along with the RPC operation
1153
1140
  # @yieldparam response [Google::Cloud::Vision::V1p3beta1::ReferenceImage]
1154
1141
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1208,22 +1195,20 @@ module Google
1208
1195
  # * Returns NOT_FOUND if the reference image does not exist.
1209
1196
  #
1210
1197
  # @overload delete_reference_image(request, options = nil)
1211
- # @param request [Google::Cloud::Vision::V1p3beta1::DeleteReferenceImageRequest | Hash]
1212
- # Permanently deletes a reference image.
1198
+ # Pass arguments to `delete_reference_image` via a request object, either of type
1199
+ # {Google::Cloud::Vision::V1p3beta1::DeleteReferenceImageRequest} or an equivalent Hash.
1213
1200
  #
1214
- # The image metadata will be deleted right away, but search queries
1215
- # against ProductSets containing the image may still work until all related
1216
- # caches are refreshed.
1217
- #
1218
- # The actual image files are not deleted from Google Cloud Storage.
1219
- #
1220
- # Possible errors:
1221
- #
1222
- # * Returns NOT_FOUND if the reference image does not exist.
1201
+ # @param request [Google::Cloud::Vision::V1p3beta1::DeleteReferenceImageRequest, Hash]
1202
+ # A request object representing the call parameters. Required. To specify no
1203
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1223
1204
  # @param options [Gapic::CallOptions, Hash]
1224
1205
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1225
1206
  #
1226
1207
  # @overload delete_reference_image(name: nil)
1208
+ # Pass arguments to `delete_reference_image` via keyword arguments. Note that at
1209
+ # least one keyword argument is required. To specify no parameters, or to keep all
1210
+ # the default parameter values, pass an empty Hash as a request object (see above).
1211
+ #
1227
1212
  # @param name [String]
1228
1213
  # Required. The resource name of the reference image to delete.
1229
1214
  #
@@ -1231,7 +1216,6 @@ module Google
1231
1216
  #
1232
1217
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`
1233
1218
  #
1234
- #
1235
1219
  # @yield [response, operation] Access the result along with the RPC operation
1236
1220
  # @yieldparam response [Google::Protobuf::Empty]
1237
1221
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1287,18 +1271,20 @@ module Google
1287
1271
  # than 1.
1288
1272
  #
1289
1273
  # @overload list_reference_images(request, options = nil)
1290
- # @param request [Google::Cloud::Vision::V1p3beta1::ListReferenceImagesRequest | Hash]
1291
- # Lists reference images.
1292
- #
1293
- # Possible errors:
1274
+ # Pass arguments to `list_reference_images` via a request object, either of type
1275
+ # {Google::Cloud::Vision::V1p3beta1::ListReferenceImagesRequest} or an equivalent Hash.
1294
1276
  #
1295
- # * Returns NOT_FOUND if the parent product does not exist.
1296
- # * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less
1297
- # than 1.
1277
+ # @param request [Google::Cloud::Vision::V1p3beta1::ListReferenceImagesRequest, Hash]
1278
+ # A request object representing the call parameters. Required. To specify no
1279
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1298
1280
  # @param options [Gapic::CallOptions, Hash]
1299
1281
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1300
1282
  #
1301
1283
  # @overload list_reference_images(parent: nil, page_size: nil, page_token: nil)
1284
+ # Pass arguments to `list_reference_images` via keyword arguments. Note that at
1285
+ # least one keyword argument is required. To specify no parameters, or to keep all
1286
+ # the default parameter values, pass an empty Hash as a request object (see above).
1287
+ #
1302
1288
  # @param parent [String]
1303
1289
  # Required. Resource name of the product containing the reference images.
1304
1290
  #
@@ -1312,7 +1298,6 @@ module Google
1312
1298
  #
1313
1299
  # Defaults to the first page if not specified.
1314
1300
  #
1315
- #
1316
1301
  # @yield [response, operation] Access the result along with the RPC operation
1317
1302
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::Vision::V1p3beta1::ReferenceImage>]
1318
1303
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1367,16 +1352,20 @@ module Google
1367
1352
  # * Returns NOT_FOUND if the specified image does not exist.
1368
1353
  #
1369
1354
  # @overload get_reference_image(request, options = nil)
1370
- # @param request [Google::Cloud::Vision::V1p3beta1::GetReferenceImageRequest | Hash]
1371
- # Gets information associated with a ReferenceImage.
1355
+ # Pass arguments to `get_reference_image` via a request object, either of type
1356
+ # {Google::Cloud::Vision::V1p3beta1::GetReferenceImageRequest} or an equivalent Hash.
1372
1357
  #
1373
- # Possible errors:
1374
- #
1375
- # * Returns NOT_FOUND if the specified image does not exist.
1358
+ # @param request [Google::Cloud::Vision::V1p3beta1::GetReferenceImageRequest, Hash]
1359
+ # A request object representing the call parameters. Required. To specify no
1360
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1376
1361
  # @param options [Gapic::CallOptions, Hash]
1377
1362
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1378
1363
  #
1379
1364
  # @overload get_reference_image(name: nil)
1365
+ # Pass arguments to `get_reference_image` via keyword arguments. Note that at
1366
+ # least one keyword argument is required. To specify no parameters, or to keep all
1367
+ # the default parameter values, pass an empty Hash as a request object (see above).
1368
+ #
1380
1369
  # @param name [String]
1381
1370
  # Required. The resource name of the ReferenceImage to get.
1382
1371
  #
@@ -1384,7 +1373,6 @@ module Google
1384
1373
  #
1385
1374
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.
1386
1375
  #
1387
- #
1388
1376
  # @yield [response, operation] Access the result along with the RPC operation
1389
1377
  # @yieldparam response [Google::Cloud::Vision::V1p3beta1::ReferenceImage]
1390
1378
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1441,19 +1429,20 @@ module Google
1441
1429
  # * Returns NOT_FOUND if the Product or the ProductSet doesn't exist.
1442
1430
  #
1443
1431
  # @overload add_product_to_product_set(request, options = nil)
1444
- # @param request [Google::Cloud::Vision::V1p3beta1::AddProductToProductSetRequest | Hash]
1445
- # Adds a Product to the specified ProductSet. If the Product is already
1446
- # present, no change is made.
1447
- #
1448
- # One Product can be added to at most 100 ProductSets.
1432
+ # Pass arguments to `add_product_to_product_set` via a request object, either of type
1433
+ # {Google::Cloud::Vision::V1p3beta1::AddProductToProductSetRequest} or an equivalent Hash.
1449
1434
  #
1450
- # Possible errors:
1451
- #
1452
- # * Returns NOT_FOUND if the Product or the ProductSet doesn't exist.
1435
+ # @param request [Google::Cloud::Vision::V1p3beta1::AddProductToProductSetRequest, Hash]
1436
+ # A request object representing the call parameters. Required. To specify no
1437
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1453
1438
  # @param options [Gapic::CallOptions, Hash]
1454
1439
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1455
1440
  #
1456
1441
  # @overload add_product_to_product_set(name: nil, product: nil)
1442
+ # Pass arguments to `add_product_to_product_set` via keyword arguments. Note that at
1443
+ # least one keyword argument is required. To specify no parameters, or to keep all
1444
+ # the default parameter values, pass an empty Hash as a request object (see above).
1445
+ #
1457
1446
  # @param name [String]
1458
1447
  # Required. The resource name for the ProductSet to modify.
1459
1448
  #
@@ -1465,7 +1454,6 @@ module Google
1465
1454
  # Format is:
1466
1455
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
1467
1456
  #
1468
- #
1469
1457
  # @yield [response, operation] Access the result along with the RPC operation
1470
1458
  # @yieldparam response [Google::Protobuf::Empty]
1471
1459
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1519,16 +1507,20 @@ module Google
1519
1507
  # * Returns NOT_FOUND If the Product is not found under the ProductSet.
1520
1508
  #
1521
1509
  # @overload remove_product_from_product_set(request, options = nil)
1522
- # @param request [Google::Cloud::Vision::V1p3beta1::RemoveProductFromProductSetRequest | Hash]
1523
- # Removes a Product from the specified ProductSet.
1524
- #
1525
- # Possible errors:
1510
+ # Pass arguments to `remove_product_from_product_set` via a request object, either of type
1511
+ # {Google::Cloud::Vision::V1p3beta1::RemoveProductFromProductSetRequest} or an equivalent Hash.
1526
1512
  #
1527
- # * Returns NOT_FOUND If the Product is not found under the ProductSet.
1513
+ # @param request [Google::Cloud::Vision::V1p3beta1::RemoveProductFromProductSetRequest, Hash]
1514
+ # A request object representing the call parameters. Required. To specify no
1515
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1528
1516
  # @param options [Gapic::CallOptions, Hash]
1529
1517
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1530
1518
  #
1531
1519
  # @overload remove_product_from_product_set(name: nil, product: nil)
1520
+ # Pass arguments to `remove_product_from_product_set` via keyword arguments. Note that at
1521
+ # least one keyword argument is required. To specify no parameters, or to keep all
1522
+ # the default parameter values, pass an empty Hash as a request object (see above).
1523
+ #
1532
1524
  # @param name [String]
1533
1525
  # Required. The resource name for the ProductSet to modify.
1534
1526
  #
@@ -1540,7 +1532,6 @@ module Google
1540
1532
  # Format is:
1541
1533
  # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
1542
1534
  #
1543
- #
1544
1535
  # @yield [response, operation] Access the result along with the RPC operation
1545
1536
  # @yieldparam response [Google::Protobuf::Empty]
1546
1537
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1596,18 +1587,20 @@ module Google
1596
1587
  # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
1597
1588
  #
1598
1589
  # @overload list_products_in_product_set(request, options = nil)
1599
- # @param request [Google::Cloud::Vision::V1p3beta1::ListProductsInProductSetRequest | Hash]
1600
- # Lists the Products in a ProductSet, in an unspecified order. If the
1601
- # ProductSet does not exist, the products field of the response will be
1602
- # empty.
1590
+ # Pass arguments to `list_products_in_product_set` via a request object, either of type
1591
+ # {Google::Cloud::Vision::V1p3beta1::ListProductsInProductSetRequest} or an equivalent Hash.
1603
1592
  #
1604
- # Possible errors:
1605
- #
1606
- # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
1593
+ # @param request [Google::Cloud::Vision::V1p3beta1::ListProductsInProductSetRequest, Hash]
1594
+ # A request object representing the call parameters. Required. To specify no
1595
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1607
1596
  # @param options [Gapic::CallOptions, Hash]
1608
1597
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1609
1598
  #
1610
1599
  # @overload list_products_in_product_set(name: nil, page_size: nil, page_token: nil)
1600
+ # Pass arguments to `list_products_in_product_set` via keyword arguments. Note that at
1601
+ # least one keyword argument is required. To specify no parameters, or to keep all
1602
+ # the default parameter values, pass an empty Hash as a request object (see above).
1603
+ #
1611
1604
  # @param name [String]
1612
1605
  # Required. The ProductSet resource for which to retrieve Products.
1613
1606
  #
@@ -1618,7 +1611,6 @@ module Google
1618
1611
  # @param page_token [String]
1619
1612
  # The next_page_token returned from a previous List request, if any.
1620
1613
  #
1621
- #
1622
1614
  # @yield [response, operation] Access the result along with the RPC operation
1623
1615
  # @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::Vision::V1p3beta1::Product>]
1624
1616
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -1679,30 +1671,27 @@ module Google
1679
1671
  # {Google::Cloud::Vision::V1p3beta1::ImportProductSetsGcsSource#csv_file_uri ImportProductSetsGcsSource.csv_file_uri}.
1680
1672
  #
1681
1673
  # @overload import_product_sets(request, options = nil)
1682
- # @param request [Google::Cloud::Vision::V1p3beta1::ImportProductSetsRequest | Hash]
1683
- # Asynchronous API that imports a list of reference images to specified
1684
- # product sets based on a list of image information.
1685
- #
1686
- # The {Google::Longrunning::Operation google.longrunning.Operation} API can be
1687
- # used to keep track of the progress and results of the request.
1688
- # `Operation.metadata` contains `BatchOperationMetadata`. (progress)
1689
- # `Operation.response` contains `ImportProductSetsResponse`. (results)
1690
- #
1691
- # The input source of this method is a csv file on Google Cloud Storage.
1692
- # For the format of the csv file please see
1693
- # {Google::Cloud::Vision::V1p3beta1::ImportProductSetsGcsSource#csv_file_uri ImportProductSetsGcsSource.csv_file_uri}.
1674
+ # Pass arguments to `import_product_sets` via a request object, either of type
1675
+ # {Google::Cloud::Vision::V1p3beta1::ImportProductSetsRequest} or an equivalent Hash.
1676
+ #
1677
+ # @param request [Google::Cloud::Vision::V1p3beta1::ImportProductSetsRequest, Hash]
1678
+ # A request object representing the call parameters. Required. To specify no
1679
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1694
1680
  # @param options [Gapic::CallOptions, Hash]
1695
1681
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1696
1682
  #
1697
1683
  # @overload import_product_sets(parent: nil, input_config: nil)
1684
+ # Pass arguments to `import_product_sets` via keyword arguments. Note that at
1685
+ # least one keyword argument is required. To specify no parameters, or to keep all
1686
+ # the default parameter values, pass an empty Hash as a request object (see above).
1687
+ #
1698
1688
  # @param parent [String]
1699
1689
  # Required. The project in which the ProductSets should be imported.
1700
1690
  #
1701
1691
  # Format is `projects/PROJECT_ID/locations/LOC_ID`.
1702
- # @param input_config [Google::Cloud::Vision::V1p3beta1::ImportProductSetsInputConfig | Hash]
1692
+ # @param input_config [Google::Cloud::Vision::V1p3beta1::ImportProductSetsInputConfig, Hash]
1703
1693
  # Required. The input content for the list of requests.
1704
1694
  #
1705
- #
1706
1695
  # @yield [response, operation] Access the result along with the RPC operation
1707
1696
  # @yieldparam response [Gapic::Operation]
1708
1697
  # @yieldparam operation [GRPC::ActiveCall::Operation]
@@ -2021,13 +2010,3 @@ module Google
2021
2010
  end
2022
2011
  end
2023
2012
  end
2024
-
2025
- # rubocop:disable Lint/HandleExceptions
2026
-
2027
- # Once client is loaded, load helpers.rb if it exists.
2028
- begin
2029
- require "google/cloud/vision/v1p3beta1/product_search/helpers"
2030
- rescue LoadError
2031
- end
2032
-
2033
- # rubocop:enable Lint/HandleExceptions