google-cloud-vision-v1p3beta1 0.13.1 → 0.15.0

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: 5892e6507ec72bb5b36273fa75789b6bc71a8cade521845e4b90d1f6d4aaa538
4
- data.tar.gz: c69038c8f20ff02f872d43a2d6d7c53a2aba8e60997e486b6f01720e34c583a4
3
+ metadata.gz: 319146f1d0b94c6d3cdc71db986792fc548213969e6a0def922ac2f447c0cc9b
4
+ data.tar.gz: 44db7390f15cd6f63f3aae793dd3e6a2f658524abab2814e3c3eb2783e66eb64
5
5
  SHA512:
6
- metadata.gz: e2e896e9f749433092ef756e23898ebeed152482928190426f8309e367a38093d96a05de6855629a7653dcca520d2bc22b7ee1300509c43dd13b2582abb6d04a
7
- data.tar.gz: 3eb25fe70f45f3e6ad84ddeb3c62e68df6665f9bf26f80a3aaee4f91dbdc0263eadb475b878c46bca804faba6c109fd314e71781658ffb49f1c0b81652a95415
6
+ metadata.gz: 63db3f21b748c1d9f3b5ccd69aa8504b26547d67bfa3b12f9edc84b07f27fb9e31764c18ad2b52ba5166f31ba03d0d65a0d7c09be5c58573878a2c28c72a7430
7
+ data.tar.gz: f13ff651ac34ed250ba3324b7cd931250918bdda373d4e2151dfbd88cf609c967c6df5d47d51f68fe685e66ce16ca5c37e6b7c76c7e55f2ab89e6f00b97a5273
data/README.md CHANGED
@@ -43,40 +43,50 @@ for class and method documentation.
43
43
  See also the [Product Documentation](https://cloud.google.com/vision)
44
44
  for general usage information.
45
45
 
46
- ## Enabling Logging
47
-
48
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
- or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
51
- 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)
52
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
53
-
54
- Configuring a Ruby stdlib logger:
46
+ ## Debug Logging
47
+
48
+ This library comes with opt-in Debug Logging that can help you troubleshoot
49
+ your application's integration with the API. When logging is activated, key
50
+ events such as requests and responses, along with data payloads and metadata
51
+ such as headers and client configuration, are logged to the standard error
52
+ stream.
53
+
54
+ **WARNING:** Client Library Debug Logging includes your data payloads in
55
+ plaintext, which could include sensitive data such as PII for yourself or your
56
+ customers, private keys, or other security data that could be compromising if
57
+ leaked. Always practice good data hygiene with your application logs, and follow
58
+ the principle of least access. Google also recommends that Client Library Debug
59
+ Logging be enabled only temporarily during active debugging, and not used
60
+ permanently in production.
61
+
62
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
63
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
64
+ list of client library gem names. This will select the default logging behavior,
65
+ which writes logs to the standard error stream. On a local workstation, this may
66
+ result in logs appearing on the console. When running on a Google Cloud hosting
67
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
68
+ results in logs appearing alongside your application logs in the
69
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
70
+
71
+ You can customize logging by modifying the `logger` configuration when
72
+ constructing a client object. For example:
55
73
 
56
74
  ```ruby
75
+ require "google/cloud/vision/v1p3beta1"
57
76
  require "logger"
58
77
 
59
- module MyLogger
60
- LOGGER = Logger.new $stderr, level: Logger::WARN
61
- def logger
62
- LOGGER
63
- end
64
- end
65
-
66
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
67
- module GRPC
68
- extend MyLogger
78
+ client = ::Google::Cloud::Vision::V1p3beta1::ProductSearch::Client.new do |config|
79
+ config.logger = Logger.new "my-app.log"
69
80
  end
70
81
  ```
71
82
 
72
-
73
83
  ## Google Cloud Samples
74
84
 
75
85
  To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
76
86
 
77
87
  ## Supported Ruby Versions
78
88
 
79
- This library is supported on Ruby 2.7+.
89
+ This library is supported on Ruby 3.0+.
80
90
 
81
91
  Google provides official support for Ruby versions that are actively supported
82
92
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -176,8 +176,19 @@ module Google
176
176
  universe_domain: @config.universe_domain,
177
177
  channel_args: @config.channel_args,
178
178
  interceptors: @config.interceptors,
179
- channel_pool_config: @config.channel_pool
179
+ channel_pool_config: @config.channel_pool,
180
+ logger: @config.logger
180
181
  )
182
+
183
+ @image_annotator_stub.stub_logger&.info do |entry|
184
+ entry.set_system_name
185
+ entry.set_service
186
+ entry.message = "Created client for #{entry.service}"
187
+ entry.set_credentials_fields credentials
188
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
189
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
190
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
191
+ end
181
192
  end
182
193
 
183
194
  ##
@@ -187,6 +198,15 @@ module Google
187
198
  #
188
199
  attr_reader :operations_client
189
200
 
201
+ ##
202
+ # The logger used for request/response debug logging.
203
+ #
204
+ # @return [Logger]
205
+ #
206
+ def logger
207
+ @image_annotator_stub.logger
208
+ end
209
+
190
210
  # Service calls
191
211
 
192
212
  ##
@@ -261,7 +281,6 @@ module Google
261
281
 
262
282
  @image_annotator_stub.call_rpc :batch_annotate_images, request, options: options do |response, operation|
263
283
  yield response, operation if block_given?
264
- return response
265
284
  end
266
285
  rescue ::GRPC::BadStatus => e
267
286
  raise ::Google::Cloud::Error.from_error(e)
@@ -352,7 +371,7 @@ module Google
352
371
  @image_annotator_stub.call_rpc :async_batch_annotate_files, request, options: options do |response, operation|
353
372
  response = ::Gapic::Operation.new response, @operations_client, options: options
354
373
  yield response, operation if block_given?
355
- return response
374
+ throw :response, response
356
375
  end
357
376
  rescue ::GRPC::BadStatus => e
358
377
  raise ::Google::Cloud::Error.from_error(e)
@@ -402,6 +421,13 @@ module Google
402
421
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
403
422
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
404
423
  # * (`nil`) indicating no credentials
424
+ #
425
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
426
+ # external source for authentication to Google Cloud, you must validate it before
427
+ # providing it to a Google API client library. Providing an unvalidated credential
428
+ # configuration to Google APIs can compromise the security of your systems and data.
429
+ # For more information, refer to [Validate credential configurations from external
430
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
405
431
  # @return [::Object]
406
432
  # @!attribute [rw] scope
407
433
  # The OAuth scopes
@@ -441,6 +467,11 @@ module Google
441
467
  # default endpoint URL. The default value of nil uses the environment
442
468
  # universe (usually the default "googleapis.com" universe).
443
469
  # @return [::String,nil]
470
+ # @!attribute [rw] logger
471
+ # A custom logger to use for request/response debug logging, or the value
472
+ # `:default` (the default) to construct a default logger, or `nil` to
473
+ # explicitly disable logging.
474
+ # @return [::Logger,:default,nil]
444
475
  #
445
476
  class Configuration
446
477
  extend ::Gapic::Config
@@ -465,6 +496,7 @@ module Google
465
496
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
466
497
  config_attr :quota_project, nil, ::String, nil
467
498
  config_attr :universe_domain, nil, ::String, nil
499
+ config_attr :logger, :default, ::Logger, nil, :default
468
500
 
469
501
  # @private
470
502
  def initialize parent_config = nil
@@ -81,7 +81,6 @@ module Google
81
81
  destination: nil,
82
82
  image_context: nil,
83
83
  &block
84
-
85
84
  feature = { type: :CROP_HINTS, max_results: max_results }
86
85
  images << image if image
87
86
  formatted_images = images.map do |img|
@@ -179,7 +178,6 @@ module Google
179
178
  destination: nil,
180
179
  image_context: nil,
181
180
  &block
182
-
183
181
  feature = { type: :DOCUMENT_TEXT_DETECTION, max_results: max_results }
184
182
  images << image if image
185
183
  formatted_images = images.map do |img|
@@ -277,7 +275,6 @@ module Google
277
275
  destination: nil,
278
276
  image_context: nil,
279
277
  &block
280
-
281
278
  feature = { type: :FACE_DETECTION, max_results: max_results }
282
279
  images << image if image
283
280
  formatted_images = images.map do |img|
@@ -375,7 +372,6 @@ module Google
375
372
  destination: nil,
376
373
  image_context: nil,
377
374
  &block
378
-
379
375
  feature = { type: :IMAGE_PROPERTIES, max_results: max_results }
380
376
  images << image if image
381
377
  formatted_images = images.map do |img|
@@ -473,7 +469,6 @@ module Google
473
469
  destination: nil,
474
470
  image_context: nil,
475
471
  &block
476
-
477
472
  feature = { type: :LABEL_DETECTION, max_results: max_results }
478
473
  images << image if image
479
474
  formatted_images = images.map do |img|
@@ -571,7 +566,6 @@ module Google
571
566
  destination: nil,
572
567
  image_context: nil,
573
568
  &block
574
-
575
569
  feature = { type: :LANDMARK_DETECTION, max_results: max_results }
576
570
  images << image if image
577
571
  formatted_images = images.map do |img|
@@ -669,7 +663,6 @@ module Google
669
663
  destination: nil,
670
664
  image_context: nil,
671
665
  &block
672
-
673
666
  feature = { type: :LOGO_DETECTION, max_results: max_results }
674
667
  images << image if image
675
668
  formatted_images = images.map do |img|
@@ -767,7 +760,6 @@ module Google
767
760
  destination: nil,
768
761
  image_context: nil,
769
762
  &block
770
-
771
763
  feature = { type: :OBJECT_LOCALIZATION, max_results: max_results }
772
764
  images << image if image
773
765
  formatted_images = images.map do |img|
@@ -865,7 +857,6 @@ module Google
865
857
  destination: nil,
866
858
  image_context: nil,
867
859
  &block
868
-
869
860
  feature = { type: :PRODUCT_SEARCH, max_results: max_results }
870
861
  images << image if image
871
862
  formatted_images = images.map do |img|
@@ -963,7 +954,6 @@ module Google
963
954
  destination: nil,
964
955
  image_context: nil,
965
956
  &block
966
-
967
957
  feature = { type: :SAFE_SEARCH_DETECTION, max_results: max_results }
968
958
  images << image if image
969
959
  formatted_images = images.map do |img|
@@ -1061,7 +1051,6 @@ module Google
1061
1051
  destination: nil,
1062
1052
  image_context: nil,
1063
1053
  &block
1064
-
1065
1054
  feature = { type: :TEXT_DETECTION, max_results: max_results }
1066
1055
  images << image if image
1067
1056
  formatted_images = images.map do |img|
@@ -1159,7 +1148,6 @@ module Google
1159
1148
  destination: nil,
1160
1149
  image_context: nil,
1161
1150
  &block
1162
-
1163
1151
  feature = { type: :WEB_DETECTION, max_results: max_results }
1164
1152
  images << image if image
1165
1153
  formatted_images = images.map do |img|
@@ -124,14 +124,6 @@ module Google
124
124
  # Lists operations that match the specified filter in the request. If the
125
125
  # server doesn't support this method, it returns `UNIMPLEMENTED`.
126
126
  #
127
- # NOTE: the `name` binding allows API services to override the binding
128
- # to use different resource name schemes, such as `users/*/operations`. To
129
- # override the binding, API services can add a binding such as
130
- # `"/v1/{name=users/*}/operations"` to their service configuration.
131
- # For backwards compatibility, the default name includes the operations
132
- # collection id, however overriding users must ensure the name binding
133
- # is the parent resource, without the operations collection id.
134
- #
135
127
  # @overload list_operations(request, options = nil)
136
128
  # Pass arguments to `list_operations` via a request object, either of type
137
129
  # {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
@@ -221,7 +213,7 @@ module Google
221
213
  wrap_lro_operation = ->(op_response) { ::Gapic::Operation.new op_response, @operations_client }
222
214
  response = ::Gapic::PagedEnumerable.new @operations_stub, :list_operations, request, response, operation, options, format_resource: wrap_lro_operation
223
215
  yield response, operation if block_given?
224
- return response
216
+ throw :response, response
225
217
  end
226
218
  rescue ::GRPC::BadStatus => e
227
219
  raise ::Google::Cloud::Error.from_error(e)
@@ -317,7 +309,7 @@ module Google
317
309
  @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
318
310
  response = ::Gapic::Operation.new response, @operations_client, options: options
319
311
  yield response, operation if block_given?
320
- return response
312
+ throw :response, response
321
313
  end
322
314
  rescue ::GRPC::BadStatus => e
323
315
  raise ::Google::Cloud::Error.from_error(e)
@@ -406,7 +398,6 @@ module Google
406
398
 
407
399
  @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
408
400
  yield response, operation if block_given?
409
- return response
410
401
  end
411
402
  rescue ::GRPC::BadStatus => e
412
403
  raise ::Google::Cloud::Error.from_error(e)
@@ -421,8 +412,9 @@ module Google
421
412
  # other methods to check whether the cancellation succeeded or whether the
422
413
  # operation completed despite cancellation. On successful cancellation,
423
414
  # the operation is not deleted; instead, it becomes an operation with
424
- # an {::Google::Longrunning::Operation#error Operation.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
425
- # corresponding to `Code.CANCELLED`.
415
+ # an {::Google::Longrunning::Operation#error Operation.error} value with a
416
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
417
+ # `Code.CANCELLED`.
426
418
  #
427
419
  # @overload cancel_operation(request, options = nil)
428
420
  # Pass arguments to `cancel_operation` via a request object, either of type
@@ -501,7 +493,6 @@ module Google
501
493
 
502
494
  @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
503
495
  yield response, operation if block_given?
504
- return response
505
496
  end
506
497
  rescue ::GRPC::BadStatus => e
507
498
  raise ::Google::Cloud::Error.from_error(e)
@@ -599,7 +590,7 @@ module Google
599
590
  @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
600
591
  response = ::Gapic::Operation.new response, @operations_client, options: options
601
592
  yield response, operation if block_given?
602
- return response
593
+ throw :response, response
603
594
  end
604
595
  rescue ::GRPC::BadStatus => e
605
596
  raise ::Google::Cloud::Error.from_error(e)
@@ -649,6 +640,13 @@ module Google
649
640
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
650
641
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
651
642
  # * (`nil`) indicating no credentials
643
+ #
644
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
645
+ # external source for authentication to Google Cloud, you must validate it before
646
+ # providing it to a Google API client library. Providing an unvalidated credential
647
+ # configuration to Google APIs can compromise the security of your systems and data.
648
+ # For more information, refer to [Validate credential configurations from external
649
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
652
650
  # @return [::Object]
653
651
  # @!attribute [rw] scope
654
652
  # The OAuth scopes
@@ -688,6 +686,11 @@ module Google
688
686
  # default endpoint URL. The default value of nil uses the environment
689
687
  # universe (usually the default "googleapis.com" universe).
690
688
  # @return [::String,nil]
689
+ # @!attribute [rw] logger
690
+ # A custom logger to use for request/response debug logging, or the value
691
+ # `:default` (the default) to construct a default logger, or `nil` to
692
+ # explicitly disable logging.
693
+ # @return [::Logger,:default,nil]
691
694
  #
692
695
  class Configuration
693
696
  extend ::Gapic::Config
@@ -712,6 +715,7 @@ module Google
712
715
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
713
716
  config_attr :quota_project, nil, ::String, nil
714
717
  config_attr :universe_domain, nil, ::String, nil
718
+ config_attr :logger, :default, ::Logger, nil, :default
715
719
 
716
720
  # @private
717
721
  def initialize parent_config = nil
@@ -169,8 +169,19 @@ module Google
169
169
  endpoint: @config.endpoint,
170
170
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
171
171
  universe_domain: @config.universe_domain,
172
- credentials: credentials
172
+ credentials: credentials,
173
+ logger: @config.logger
173
174
  )
175
+
176
+ @image_annotator_stub.logger(stub: true)&.info do |entry|
177
+ entry.set_system_name
178
+ entry.set_service
179
+ entry.message = "Created client for #{entry.service}"
180
+ entry.set_credentials_fields credentials
181
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
182
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
183
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
184
+ end
174
185
  end
175
186
 
176
187
  ##
@@ -180,6 +191,15 @@ module Google
180
191
  #
181
192
  attr_reader :operations_client
182
193
 
194
+ ##
195
+ # The logger used for request/response debug logging.
196
+ #
197
+ # @return [Logger]
198
+ #
199
+ def logger
200
+ @image_annotator_stub.logger
201
+ end
202
+
183
203
  # Service calls
184
204
 
185
205
  ##
@@ -255,7 +275,6 @@ module Google
255
275
 
256
276
  @image_annotator_stub.batch_annotate_images request, options do |result, operation|
257
277
  yield result, operation if block_given?
258
- return result
259
278
  end
260
279
  rescue ::Gapic::Rest::Error => e
261
280
  raise ::Google::Cloud::Error.from_error(e)
@@ -347,7 +366,7 @@ module Google
347
366
  @image_annotator_stub.async_batch_annotate_files request, options do |result, operation|
348
367
  result = ::Gapic::Operation.new result, @operations_client, options: options
349
368
  yield result, operation if block_given?
350
- return result
369
+ throw :response, result
351
370
  end
352
371
  rescue ::Gapic::Rest::Error => e
353
372
  raise ::Google::Cloud::Error.from_error(e)
@@ -395,6 +414,13 @@ module Google
395
414
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
396
415
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
397
416
  # * (`nil`) indicating no credentials
417
+ #
418
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
419
+ # external source for authentication to Google Cloud, you must validate it before
420
+ # providing it to a Google API client library. Providing an unvalidated credential
421
+ # configuration to Google APIs can compromise the security of your systems and data.
422
+ # For more information, refer to [Validate credential configurations from external
423
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
398
424
  # @return [::Object]
399
425
  # @!attribute [rw] scope
400
426
  # The OAuth scopes
@@ -427,6 +453,11 @@ module Google
427
453
  # default endpoint URL. The default value of nil uses the environment
428
454
  # universe (usually the default "googleapis.com" universe).
429
455
  # @return [::String,nil]
456
+ # @!attribute [rw] logger
457
+ # A custom logger to use for request/response debug logging, or the value
458
+ # `:default` (the default) to construct a default logger, or `nil` to
459
+ # explicitly disable logging.
460
+ # @return [::Logger,:default,nil]
430
461
  #
431
462
  class Configuration
432
463
  extend ::Gapic::Config
@@ -448,6 +479,7 @@ module Google
448
479
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
449
480
  config_attr :quota_project, nil, ::String, nil
450
481
  config_attr :universe_domain, nil, ::String, nil
482
+ config_attr :logger, :default, ::Logger, nil, :default
451
483
 
452
484
  # @private
453
485
  def initialize parent_config = nil
@@ -115,14 +115,6 @@ module Google
115
115
  # Lists operations that match the specified filter in the request. If the
116
116
  # server doesn't support this method, it returns `UNIMPLEMENTED`.
117
117
  #
118
- # NOTE: the `name` binding allows API services to override the binding
119
- # to use different resource name schemes, such as `users/*/operations`. To
120
- # override the binding, API services can add a binding such as
121
- # `"/v1/{name=users/*}/operations"` to their service configuration.
122
- # For backwards compatibility, the default name includes the operations
123
- # collection id, however overriding users must ensure the name binding
124
- # is the parent resource, without the operations collection id.
125
- #
126
118
  # @overload list_operations(request, options = nil)
127
119
  # Pass arguments to `list_operations` via a request object, either of type
128
120
  # {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
@@ -204,7 +196,7 @@ module Google
204
196
  @operations_stub.list_operations request, options do |result, operation|
205
197
  result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", request, result, options
206
198
  yield result, operation if block_given?
207
- return result
199
+ throw :response, result
208
200
  end
209
201
  rescue ::Gapic::Rest::Error => e
210
202
  raise ::Google::Cloud::Error.from_error(e)
@@ -293,7 +285,7 @@ module Google
293
285
  @operations_stub.get_operation request, options do |result, operation|
294
286
  result = ::Gapic::Operation.new result, @operations_client, options: options
295
287
  yield result, operation if block_given?
296
- return result
288
+ throw :response, result
297
289
  end
298
290
  rescue ::Gapic::Rest::Error => e
299
291
  raise ::Google::Cloud::Error.from_error(e)
@@ -375,7 +367,6 @@ module Google
375
367
 
376
368
  @operations_stub.delete_operation request, options do |result, operation|
377
369
  yield result, operation if block_given?
378
- return result
379
370
  end
380
371
  rescue ::Gapic::Rest::Error => e
381
372
  raise ::Google::Cloud::Error.from_error(e)
@@ -390,8 +381,9 @@ module Google
390
381
  # other methods to check whether the cancellation succeeded or whether the
391
382
  # operation completed despite cancellation. On successful cancellation,
392
383
  # the operation is not deleted; instead, it becomes an operation with
393
- # an {::Google::Longrunning::Operation#error Operation.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
394
- # corresponding to `Code.CANCELLED`.
384
+ # an {::Google::Longrunning::Operation#error Operation.error} value with a
385
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
386
+ # `Code.CANCELLED`.
395
387
  #
396
388
  # @overload cancel_operation(request, options = nil)
397
389
  # Pass arguments to `cancel_operation` via a request object, either of type
@@ -463,7 +455,6 @@ module Google
463
455
 
464
456
  @operations_stub.cancel_operation request, options do |result, operation|
465
457
  yield result, operation if block_given?
466
- return result
467
458
  end
468
459
  rescue ::Gapic::Rest::Error => e
469
460
  raise ::Google::Cloud::Error.from_error(e)
@@ -511,6 +502,13 @@ module Google
511
502
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
512
503
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
513
504
  # * (`nil`) indicating no credentials
505
+ #
506
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
507
+ # external source for authentication to Google Cloud, you must validate it before
508
+ # providing it to a Google API client library. Providing an unvalidated credential
509
+ # configuration to Google APIs can compromise the security of your systems and data.
510
+ # For more information, refer to [Validate credential configurations from external
511
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
514
512
  # @return [::Object]
515
513
  # @!attribute [rw] scope
516
514
  # The OAuth scopes
@@ -543,6 +541,11 @@ module Google
543
541
  # default endpoint URL. The default value of nil uses the environment
544
542
  # universe (usually the default "googleapis.com" universe).
545
543
  # @return [::String,nil]
544
+ # @!attribute [rw] logger
545
+ # A custom logger to use for request/response debug logging, or the value
546
+ # `:default` (the default) to construct a default logger, or `nil` to
547
+ # explicitly disable logging.
548
+ # @return [::Logger,:default,nil]
546
549
  #
547
550
  class Configuration
548
551
  extend ::Gapic::Config
@@ -564,6 +567,7 @@ module Google
564
567
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
565
568
  config_attr :quota_project, nil, ::String, nil
566
569
  config_attr :universe_domain, nil, ::String, nil
570
+ config_attr :logger, :default, ::Logger, nil, :default
567
571
 
568
572
  # @private
569
573
  def initialize parent_config = nil
@@ -683,16 +687,18 @@ module Google
683
687
 
684
688
  response = @client_stub.make_http_request(
685
689
  verb,
686
- uri: uri,
687
- body: body || "",
688
- params: query_string_params,
690
+ uri: uri,
691
+ body: body || "",
692
+ params: query_string_params,
693
+ method_name: "list_operations",
689
694
  options: options
690
695
  )
691
696
  operation = ::Gapic::Rest::TransportOperation.new response
692
697
  result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
693
-
694
- yield result, operation if block_given?
695
- result
698
+ catch :response do
699
+ yield result, operation if block_given?
700
+ result
701
+ end
696
702
  end
697
703
 
698
704
  ##
@@ -721,16 +727,18 @@ module Google
721
727
 
722
728
  response = @client_stub.make_http_request(
723
729
  verb,
724
- uri: uri,
725
- body: body || "",
726
- params: query_string_params,
730
+ uri: uri,
731
+ body: body || "",
732
+ params: query_string_params,
733
+ method_name: "get_operation",
727
734
  options: options
728
735
  )
729
736
  operation = ::Gapic::Rest::TransportOperation.new response
730
737
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
731
-
732
- yield result, operation if block_given?
733
- result
738
+ catch :response do
739
+ yield result, operation if block_given?
740
+ result
741
+ end
734
742
  end
735
743
 
736
744
  ##
@@ -759,16 +767,18 @@ module Google
759
767
 
760
768
  response = @client_stub.make_http_request(
761
769
  verb,
762
- uri: uri,
763
- body: body || "",
764
- params: query_string_params,
770
+ uri: uri,
771
+ body: body || "",
772
+ params: query_string_params,
773
+ method_name: "delete_operation",
765
774
  options: options
766
775
  )
767
776
  operation = ::Gapic::Rest::TransportOperation.new response
768
777
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
769
-
770
- yield result, operation if block_given?
771
- result
778
+ catch :response do
779
+ yield result, operation if block_given?
780
+ result
781
+ end
772
782
  end
773
783
 
774
784
  ##
@@ -797,16 +807,18 @@ module Google
797
807
 
798
808
  response = @client_stub.make_http_request(
799
809
  verb,
800
- uri: uri,
801
- body: body || "",
802
- params: query_string_params,
810
+ uri: uri,
811
+ body: body || "",
812
+ params: query_string_params,
813
+ method_name: "cancel_operation",
803
814
  options: options
804
815
  )
805
816
  operation = ::Gapic::Rest::TransportOperation.new response
806
817
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
807
-
808
- yield result, operation if block_given?
809
- result
818
+ catch :response do
819
+ yield result, operation if block_given?
820
+ result
821
+ end
810
822
  end
811
823
 
812
824
  ##