google-cloud-vision-v1 0.6.2 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5a3c9ebef2896d55b17cff05339936083b3b4ec22edbca16053c54eb39fa7874
4
- data.tar.gz: ebc0237ffc4dcdcbdce65e7e9b8df7fa280e7675813d6b2d368fa8e94fca9db9
3
+ metadata.gz: 3f969984ea1c1ac65548fa14bec2c85b0d028438238b9e28bacb922211b037a1
4
+ data.tar.gz: c3ab61ae57c70debc27f27a68d6cc4f3aed59938b08a9f3dad9d7eddd48e8ae8
5
5
  SHA512:
6
- metadata.gz: 93ce5266be80fca58013099e590816764f8bc2e1dd35927125530a28ce855b2fb3aa2909838ea60c2179595c2c543ccdc312a1ff3044c3a31b3371f0e7b57783
7
- data.tar.gz: 183d6b758a9f0d75e1135df7ecccd3e1560a02ffc641790f70454b91a5cb9445be33d218b08a085315afee9493c613e4d26541794fd9a8a0c80f14e3531aa6a0
6
+ metadata.gz: 0cff33062e853c17b4de13ac8150d599ef1834d524b3b60f263ac487481f079c7a27250183d9ace7e5d224736395d7172f4815ef88cfc43b20e5f66dca03c437
7
+ data.tar.gz: ab81ba5cc871075c6c7291b1294457ed3d38ef55ac965a6a897f44c0bccce7b59c089073f270ea20c06696f0cca26f76f1be779926c88e00c311eb5026c87524
data/.yardopts CHANGED
@@ -1,5 +1,5 @@
1
1
  --no-private
2
- --title=Cloud Vision V1 API
2
+ --title="Cloud Vision V1 API"
3
3
  --exclude _pb\.rb$
4
4
  --markup markdown
5
5
  --markup-provider redcarpet
data/AUTHENTICATION.md CHANGED
@@ -120,15 +120,6 @@ To configure your system for this, simply:
120
120
  **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
121
  *should* only be used during development.
122
122
 
123
- [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
124
- [dev-console]: https://console.cloud.google.com/project
125
-
126
- [enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
127
-
128
- [create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
129
- [create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
130
- [reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
131
-
132
123
  ## Creating a Service Account
133
124
 
134
125
  Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
139
130
  [Google Cloud Platform environments](#google-cloud-platform-environments), you
140
131
  need a Google Developers service account.
141
132
 
142
- 1. Visit the [Google Developers Console][dev-console].
133
+ 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
143
134
  2. Create a new project or click on an existing project.
144
- 3. Activate the slide-out navigation tray and select **API Manager**. From
135
+ 3. Activate the menu in the upper left and select **APIs & Services**. From
145
136
  here, you will enable the APIs that your application requires.
146
137
 
147
- ![Enable the APIs that your application requires][enable-apis]
148
-
149
138
  *Note: You may need to enable billing in order to use these services.*
150
139
 
151
140
  4. Select **Credentials** from the side navigation.
152
141
 
153
- You should see a screen like one of the following.
154
-
155
- ![Create a new service account][create-new-service-account]
156
-
157
- ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
158
-
159
- Find the "Add credentials" drop down and select "Service account" to be
160
- guided through downloading a new JSON key file.
142
+ Find the "Create credentials" drop down near the top of the page, and select
143
+ "Service account" to be guided through downloading a new JSON key file.
161
144
 
162
145
  If you want to re-use an existing service account, you can easily generate a
163
- new key file. Just select the account you wish to re-use, and click "Generate
164
- new JSON key":
165
-
166
- ![Re-use an existing service account][reuse-service-account]
146
+ new key file. Just select the account you wish to re-use, click the pencil
147
+ tool on the right side to edit the service account, select the **Keys** tab,
148
+ and then select **Add Key**.
167
149
 
168
150
  The key file you download will be used by this library to authenticate API
169
151
  requests and should be stored in a secure location.
data/README.md CHANGED
@@ -37,7 +37,7 @@ request = ::Google::Cloud::Vision::V1::CreateProductSetRequest.new # (request fi
37
37
  response = client.create_product_set request
38
38
  ```
39
39
 
40
- View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-vision-v1/latest)
40
+ View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-vision-v1/latest)
41
41
  for class and method documentation.
42
42
 
43
43
  See also the [Product Documentation](https://cloud.google.com/vision)
@@ -69,6 +69,11 @@ module GRPC
69
69
  end
70
70
  ```
71
71
 
72
+
73
+ ## Google Cloud Samples
74
+
75
+ To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
76
+
72
77
  ## Supported Ruby Versions
73
78
 
74
79
  This library is supported on Ruby 2.5+.
@@ -3,7 +3,6 @@
3
3
 
4
4
  require 'google/protobuf'
5
5
 
6
- require 'google/api/annotations_pb'
7
6
  Google::Protobuf::DescriptorPool.generated_pool.build do
8
7
  add_file("google/cloud/vision/v1/geometry.proto", :syntax => :proto3) do
9
8
  add_message "google.cloud.vision.v1.Vertex" do
@@ -43,13 +43,12 @@ module Google
43
43
  # See {::Google::Cloud::Vision::V1::ImageAnnotator::Client::Configuration}
44
44
  # for a description of the configuration fields.
45
45
  #
46
- # ## Example
46
+ # @example
47
47
  #
48
- # To modify the configuration for all ImageAnnotator clients:
49
- #
50
- # ::Google::Cloud::Vision::V1::ImageAnnotator::Client.configure do |config|
51
- # config.timeout = 10.0
52
- # end
48
+ # # Modify the configuration for all ImageAnnotator clients
49
+ # ::Google::Cloud::Vision::V1::ImageAnnotator::Client.configure do |config|
50
+ # config.timeout = 10.0
51
+ # end
53
52
  #
54
53
  # @yield [config] Configure the Client client.
55
54
  # @yieldparam config [Client::Configuration]
@@ -116,19 +115,15 @@ module Google
116
115
  ##
117
116
  # Create a new ImageAnnotator client object.
118
117
  #
119
- # ## Examples
120
- #
121
- # To create a new ImageAnnotator client with the default
122
- # configuration:
118
+ # @example
123
119
  #
124
- # client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new
120
+ # # Create a client using the default configuration
121
+ # client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new
125
122
  #
126
- # To create a new ImageAnnotator client with a custom
127
- # configuration:
128
- #
129
- # client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new do |config|
130
- # config.timeout = 10.0
131
- # end
123
+ # # Create a client using a custom configuration
124
+ # client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new do |config|
125
+ # config.timeout = 10.0
126
+ # end
132
127
  #
133
128
  # @yield [config] Configure the ImageAnnotator client.
134
129
  # @yieldparam config [Client::Configuration]
@@ -148,10 +143,9 @@ module Google
148
143
 
149
144
  # Create credentials
150
145
  credentials = @config.credentials
151
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
146
+ # Use self-signed JWT if the endpoint is unchanged from default,
152
147
  # but only if the default endpoint does not have a region prefix.
153
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
154
- @config.endpoint == Client.configure.endpoint &&
148
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
155
149
  !@config.endpoint.split(".").first.include?("-")
156
150
  credentials ||= Credentials.default scope: @config.scope,
157
151
  enable_self_signed_jwt: enable_self_signed_jwt
@@ -163,6 +157,7 @@ module Google
163
157
 
164
158
  @operations_client = Operations.new do |config|
165
159
  config.credentials = credentials
160
+ config.quota_project = @quota_project_id
166
161
  config.endpoint = @config.endpoint
167
162
  end
168
163
 
@@ -226,6 +221,21 @@ module Google
226
221
  #
227
222
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
228
223
  #
224
+ # @example Basic example
225
+ # require "google/cloud/vision/v1"
226
+ #
227
+ # # Create a client object. The client can be reused for multiple calls.
228
+ # client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new
229
+ #
230
+ # # Create a request. To set request fields, pass in keyword arguments.
231
+ # request = Google::Cloud::Vision::V1::BatchAnnotateImagesRequest.new
232
+ #
233
+ # # Call the batch_annotate_images method.
234
+ # result = client.batch_annotate_images request
235
+ #
236
+ # # The returned object is of type Google::Cloud::Vision::V1::BatchAnnotateImagesResponse.
237
+ # p result
238
+ #
229
239
  def batch_annotate_images request, options = nil
230
240
  raise ::ArgumentError, "request must be provided" if request.nil?
231
241
 
@@ -246,7 +256,9 @@ module Google
246
256
  options.apply_defaults timeout: @config.rpcs.batch_annotate_images.timeout,
247
257
  metadata: metadata,
248
258
  retry_policy: @config.rpcs.batch_annotate_images.retry_policy
249
- options.apply_defaults metadata: @config.metadata,
259
+
260
+ options.apply_defaults timeout: @config.timeout,
261
+ metadata: @config.metadata,
250
262
  retry_policy: @config.retry_policy
251
263
 
252
264
  @image_annotator_stub.call_rpc :batch_annotate_images, request, options: options do |response, operation|
@@ -282,8 +294,8 @@ module Google
282
294
  # the default parameter values, pass an empty Hash as a request object (see above).
283
295
  #
284
296
  # @param requests [::Array<::Google::Cloud::Vision::V1::AnnotateFileRequest, ::Hash>]
285
- # Required. The list of file annotation requests. Right now we support only
286
- # one AnnotateFileRequest in BatchAnnotateFilesRequest.
297
+ # Required. The list of file annotation requests. Right now we support only one
298
+ # AnnotateFileRequest in BatchAnnotateFilesRequest.
287
299
  # @param parent [::String]
288
300
  # Optional. Target project and location to make a call.
289
301
  #
@@ -306,6 +318,21 @@ module Google
306
318
  #
307
319
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
308
320
  #
321
+ # @example Basic example
322
+ # require "google/cloud/vision/v1"
323
+ #
324
+ # # Create a client object. The client can be reused for multiple calls.
325
+ # client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new
326
+ #
327
+ # # Create a request. To set request fields, pass in keyword arguments.
328
+ # request = Google::Cloud::Vision::V1::BatchAnnotateFilesRequest.new
329
+ #
330
+ # # Call the batch_annotate_files method.
331
+ # result = client.batch_annotate_files request
332
+ #
333
+ # # The returned object is of type Google::Cloud::Vision::V1::BatchAnnotateFilesResponse.
334
+ # p result
335
+ #
309
336
  def batch_annotate_files request, options = nil
310
337
  raise ::ArgumentError, "request must be provided" if request.nil?
311
338
 
@@ -326,7 +353,9 @@ module Google
326
353
  options.apply_defaults timeout: @config.rpcs.batch_annotate_files.timeout,
327
354
  metadata: metadata,
328
355
  retry_policy: @config.rpcs.batch_annotate_files.retry_policy
329
- options.apply_defaults metadata: @config.metadata,
356
+
357
+ options.apply_defaults timeout: @config.timeout,
358
+ metadata: @config.metadata,
330
359
  retry_policy: @config.retry_policy
331
360
 
332
361
  @image_annotator_stub.call_rpc :batch_annotate_files, request, options: options do |response, operation|
@@ -389,6 +418,28 @@ module Google
389
418
  #
390
419
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
391
420
  #
421
+ # @example Basic example
422
+ # require "google/cloud/vision/v1"
423
+ #
424
+ # # Create a client object. The client can be reused for multiple calls.
425
+ # client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new
426
+ #
427
+ # # Create a request. To set request fields, pass in keyword arguments.
428
+ # request = Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest.new
429
+ #
430
+ # # Call the async_batch_annotate_images method.
431
+ # result = client.async_batch_annotate_images request
432
+ #
433
+ # # The returned object is of type Gapic::Operation. You can use this
434
+ # # object to check the status of an operation, cancel it, or wait
435
+ # # for results. Here is how to block until completion:
436
+ # result.wait_until_done! timeout: 60
437
+ # if result.response?
438
+ # p result.response
439
+ # else
440
+ # puts "Error!"
441
+ # end
442
+ #
392
443
  def async_batch_annotate_images request, options = nil
393
444
  raise ::ArgumentError, "request must be provided" if request.nil?
394
445
 
@@ -409,7 +460,9 @@ module Google
409
460
  options.apply_defaults timeout: @config.rpcs.async_batch_annotate_images.timeout,
410
461
  metadata: metadata,
411
462
  retry_policy: @config.rpcs.async_batch_annotate_images.retry_policy
412
- options.apply_defaults metadata: @config.metadata,
463
+
464
+ options.apply_defaults timeout: @config.timeout,
465
+ metadata: @config.metadata,
413
466
  retry_policy: @config.retry_policy
414
467
 
415
468
  @image_annotator_stub.call_rpc :async_batch_annotate_images, request, options: options do |response, operation|
@@ -468,6 +521,28 @@ module Google
468
521
  #
469
522
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
470
523
  #
524
+ # @example Basic example
525
+ # require "google/cloud/vision/v1"
526
+ #
527
+ # # Create a client object. The client can be reused for multiple calls.
528
+ # client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new
529
+ #
530
+ # # Create a request. To set request fields, pass in keyword arguments.
531
+ # request = Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest.new
532
+ #
533
+ # # Call the async_batch_annotate_files method.
534
+ # result = client.async_batch_annotate_files request
535
+ #
536
+ # # The returned object is of type Gapic::Operation. You can use this
537
+ # # object to check the status of an operation, cancel it, or wait
538
+ # # for results. Here is how to block until completion:
539
+ # result.wait_until_done! timeout: 60
540
+ # if result.response?
541
+ # p result.response
542
+ # else
543
+ # puts "Error!"
544
+ # end
545
+ #
471
546
  def async_batch_annotate_files request, options = nil
472
547
  raise ::ArgumentError, "request must be provided" if request.nil?
473
548
 
@@ -488,7 +563,9 @@ module Google
488
563
  options.apply_defaults timeout: @config.rpcs.async_batch_annotate_files.timeout,
489
564
  metadata: metadata,
490
565
  retry_policy: @config.rpcs.async_batch_annotate_files.retry_policy
491
- options.apply_defaults metadata: @config.metadata,
566
+
567
+ options.apply_defaults timeout: @config.timeout,
568
+ metadata: @config.metadata,
492
569
  retry_policy: @config.retry_policy
493
570
 
494
571
  @image_annotator_stub.call_rpc :async_batch_annotate_files, request, options: options do |response, operation|
@@ -513,22 +590,21 @@ module Google
513
590
  # Configuration can be applied globally to all clients, or to a single client
514
591
  # on construction.
515
592
  #
516
- # # Examples
517
- #
518
- # To modify the global config, setting the timeout for batch_annotate_images
519
- # to 20 seconds, and all remaining timeouts to 10 seconds:
520
- #
521
- # ::Google::Cloud::Vision::V1::ImageAnnotator::Client.configure do |config|
522
- # config.timeout = 10.0
523
- # config.rpcs.batch_annotate_images.timeout = 20.0
524
- # end
525
- #
526
- # To apply the above configuration only to a new client:
527
- #
528
- # client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new do |config|
529
- # config.timeout = 10.0
530
- # config.rpcs.batch_annotate_images.timeout = 20.0
531
- # end
593
+ # @example
594
+ #
595
+ # # Modify the global config, setting the timeout for
596
+ # # batch_annotate_images to 20 seconds,
597
+ # # and all remaining timeouts to 10 seconds.
598
+ # ::Google::Cloud::Vision::V1::ImageAnnotator::Client.configure do |config|
599
+ # config.timeout = 10.0
600
+ # config.rpcs.batch_annotate_images.timeout = 20.0
601
+ # end
602
+ #
603
+ # # Apply the above configuration only to a new client.
604
+ # client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new do |config|
605
+ # config.timeout = 10.0
606
+ # config.rpcs.batch_annotate_images.timeout = 20.0
607
+ # end
532
608
  #
533
609
  # @!attribute [rw] endpoint
534
610
  # The hostname or hostname:port of the service endpoint.
@@ -143,6 +143,27 @@ module Google
143
143
  #
144
144
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
145
145
  #
146
+ # @example Basic example
147
+ # require "google/longrunning"
148
+ #
149
+ # # Create a client object. The client can be reused for multiple calls.
150
+ # client = Google::Longrunning::Operations::Client.new
151
+ #
152
+ # # Create a request. To set request fields, pass in keyword arguments.
153
+ # request = Google::Longrunning::ListOperationsRequest.new
154
+ #
155
+ # # Call the list_operations method.
156
+ # result = client.list_operations request
157
+ #
158
+ # # The returned object is of type Gapic::PagedEnumerable. You can
159
+ # # iterate over all elements by calling #each, and the enumerable
160
+ # # will lazily make API calls to fetch subsequent pages. Other
161
+ # # methods are also available for managing paging directly.
162
+ # result.each do |response|
163
+ # # Each element is of type ::Google::Longrunning::Operation.
164
+ # p response
165
+ # end
166
+ #
146
167
  def list_operations request, options = nil
147
168
  raise ::ArgumentError, "request must be provided" if request.nil?
148
169
 
@@ -160,16 +181,20 @@ module Google
160
181
  gapic_version: ::Google::Cloud::Vision::V1::VERSION
161
182
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
162
183
 
163
- header_params = {
164
- "name" => request.name
165
- }
184
+ header_params = {}
185
+ if request.name
186
+ header_params["name"] = request.name
187
+ end
188
+
166
189
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
167
190
  metadata[:"x-goog-request-params"] ||= request_params_header
168
191
 
169
192
  options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
170
193
  metadata: metadata,
171
194
  retry_policy: @config.rpcs.list_operations.retry_policy
172
- options.apply_defaults metadata: @config.metadata,
195
+
196
+ options.apply_defaults timeout: @config.timeout,
197
+ metadata: @config.metadata,
173
198
  retry_policy: @config.retry_policy
174
199
 
175
200
  @operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
@@ -213,6 +238,28 @@ module Google
213
238
  #
214
239
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
215
240
  #
241
+ # @example Basic example
242
+ # require "google/longrunning"
243
+ #
244
+ # # Create a client object. The client can be reused for multiple calls.
245
+ # client = Google::Longrunning::Operations::Client.new
246
+ #
247
+ # # Create a request. To set request fields, pass in keyword arguments.
248
+ # request = Google::Longrunning::GetOperationRequest.new
249
+ #
250
+ # # Call the get_operation method.
251
+ # result = client.get_operation request
252
+ #
253
+ # # The returned object is of type Gapic::Operation. You can use this
254
+ # # object to check the status of an operation, cancel it, or wait
255
+ # # for results. Here is how to block until completion:
256
+ # result.wait_until_done! timeout: 60
257
+ # if result.response?
258
+ # p result.response
259
+ # else
260
+ # puts "Error!"
261
+ # end
262
+ #
216
263
  def get_operation request, options = nil
217
264
  raise ::ArgumentError, "request must be provided" if request.nil?
218
265
 
@@ -230,16 +277,20 @@ module Google
230
277
  gapic_version: ::Google::Cloud::Vision::V1::VERSION
231
278
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
232
279
 
233
- header_params = {
234
- "name" => request.name
235
- }
280
+ header_params = {}
281
+ if request.name
282
+ header_params["name"] = request.name
283
+ end
284
+
236
285
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
237
286
  metadata[:"x-goog-request-params"] ||= request_params_header
238
287
 
239
288
  options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
240
289
  metadata: metadata,
241
290
  retry_policy: @config.rpcs.get_operation.retry_policy
242
- options.apply_defaults metadata: @config.metadata,
291
+
292
+ options.apply_defaults timeout: @config.timeout,
293
+ metadata: @config.metadata,
243
294
  retry_policy: @config.retry_policy
244
295
 
245
296
  @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
@@ -283,6 +334,21 @@ module Google
283
334
  #
284
335
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
285
336
  #
337
+ # @example Basic example
338
+ # require "google/longrunning"
339
+ #
340
+ # # Create a client object. The client can be reused for multiple calls.
341
+ # client = Google::Longrunning::Operations::Client.new
342
+ #
343
+ # # Create a request. To set request fields, pass in keyword arguments.
344
+ # request = Google::Longrunning::DeleteOperationRequest.new
345
+ #
346
+ # # Call the delete_operation method.
347
+ # result = client.delete_operation request
348
+ #
349
+ # # The returned object is of type Google::Protobuf::Empty.
350
+ # p result
351
+ #
286
352
  def delete_operation request, options = nil
287
353
  raise ::ArgumentError, "request must be provided" if request.nil?
288
354
 
@@ -300,16 +366,20 @@ module Google
300
366
  gapic_version: ::Google::Cloud::Vision::V1::VERSION
301
367
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
302
368
 
303
- header_params = {
304
- "name" => request.name
305
- }
369
+ header_params = {}
370
+ if request.name
371
+ header_params["name"] = request.name
372
+ end
373
+
306
374
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
307
375
  metadata[:"x-goog-request-params"] ||= request_params_header
308
376
 
309
377
  options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
310
378
  metadata: metadata,
311
379
  retry_policy: @config.rpcs.delete_operation.retry_policy
312
- options.apply_defaults metadata: @config.metadata,
380
+
381
+ options.apply_defaults timeout: @config.timeout,
382
+ metadata: @config.metadata,
313
383
  retry_policy: @config.retry_policy
314
384
 
315
385
  @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
@@ -358,6 +428,21 @@ module Google
358
428
  #
359
429
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
360
430
  #
431
+ # @example Basic example
432
+ # require "google/longrunning"
433
+ #
434
+ # # Create a client object. The client can be reused for multiple calls.
435
+ # client = Google::Longrunning::Operations::Client.new
436
+ #
437
+ # # Create a request. To set request fields, pass in keyword arguments.
438
+ # request = Google::Longrunning::CancelOperationRequest.new
439
+ #
440
+ # # Call the cancel_operation method.
441
+ # result = client.cancel_operation request
442
+ #
443
+ # # The returned object is of type Google::Protobuf::Empty.
444
+ # p result
445
+ #
361
446
  def cancel_operation request, options = nil
362
447
  raise ::ArgumentError, "request must be provided" if request.nil?
363
448
 
@@ -375,16 +460,20 @@ module Google
375
460
  gapic_version: ::Google::Cloud::Vision::V1::VERSION
376
461
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
377
462
 
378
- header_params = {
379
- "name" => request.name
380
- }
463
+ header_params = {}
464
+ if request.name
465
+ header_params["name"] = request.name
466
+ end
467
+
381
468
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
382
469
  metadata[:"x-goog-request-params"] ||= request_params_header
383
470
 
384
471
  options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
385
472
  metadata: metadata,
386
473
  retry_policy: @config.rpcs.cancel_operation.retry_policy
387
- options.apply_defaults metadata: @config.metadata,
474
+
475
+ options.apply_defaults timeout: @config.timeout,
476
+ metadata: @config.metadata,
388
477
  retry_policy: @config.retry_policy
389
478
 
390
479
  @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
@@ -436,6 +525,28 @@ module Google
436
525
  #
437
526
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
438
527
  #
528
+ # @example Basic example
529
+ # require "google/longrunning"
530
+ #
531
+ # # Create a client object. The client can be reused for multiple calls.
532
+ # client = Google::Longrunning::Operations::Client.new
533
+ #
534
+ # # Create a request. To set request fields, pass in keyword arguments.
535
+ # request = Google::Longrunning::WaitOperationRequest.new
536
+ #
537
+ # # Call the wait_operation method.
538
+ # result = client.wait_operation request
539
+ #
540
+ # # The returned object is of type Gapic::Operation. You can use this
541
+ # # object to check the status of an operation, cancel it, or wait
542
+ # # for results. Here is how to block until completion:
543
+ # result.wait_until_done! timeout: 60
544
+ # if result.response?
545
+ # p result.response
546
+ # else
547
+ # puts "Error!"
548
+ # end
549
+ #
439
550
  def wait_operation request, options = nil
440
551
  raise ::ArgumentError, "request must be provided" if request.nil?
441
552
 
@@ -456,7 +567,9 @@ module Google
456
567
  options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
457
568
  metadata: metadata,
458
569
  retry_policy: @config.rpcs.wait_operation.retry_policy
459
- options.apply_defaults metadata: @config.metadata,
570
+
571
+ options.apply_defaults timeout: @config.timeout,
572
+ metadata: @config.metadata,
460
573
  retry_policy: @config.retry_policy
461
574
 
462
575
  @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
@@ -481,22 +594,21 @@ module Google
481
594
  # Configuration can be applied globally to all clients, or to a single client
482
595
  # on construction.
483
596
  #
484
- # # Examples
485
- #
486
- # To modify the global config, setting the timeout for list_operations
487
- # to 20 seconds, and all remaining timeouts to 10 seconds:
488
- #
489
- # ::Google::Longrunning::Operations::Client.configure do |config|
490
- # config.timeout = 10.0
491
- # config.rpcs.list_operations.timeout = 20.0
492
- # end
493
- #
494
- # To apply the above configuration only to a new client:
495
- #
496
- # client = ::Google::Longrunning::Operations::Client.new do |config|
497
- # config.timeout = 10.0
498
- # config.rpcs.list_operations.timeout = 20.0
499
- # end
597
+ # @example
598
+ #
599
+ # # Modify the global config, setting the timeout for
600
+ # # list_operations to 20 seconds,
601
+ # # and all remaining timeouts to 10 seconds.
602
+ # ::Google::Longrunning::Operations::Client.configure do |config|
603
+ # config.timeout = 10.0
604
+ # config.rpcs.list_operations.timeout = 20.0
605
+ # end
606
+ #
607
+ # # Apply the above configuration only to a new client.
608
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
609
+ # config.timeout = 10.0
610
+ # config.rpcs.list_operations.timeout = 20.0
611
+ # end
500
612
  #
501
613
  # @!attribute [rw] endpoint
502
614
  # The hostname or hostname:port of the service endpoint.