google-cloud-retail-v2 1.1.0 → 1.3.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.
Files changed (55) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -21
  3. data/lib/google/cloud/retail/v2/analytics_service/client.rb +36 -2
  4. data/lib/google/cloud/retail/v2/analytics_service/operations.rb +19 -15
  5. data/lib/google/cloud/retail/v2/analytics_service/rest/client.rb +36 -2
  6. data/lib/google/cloud/retail/v2/analytics_service/rest/operations.rb +50 -38
  7. data/lib/google/cloud/retail/v2/analytics_service/rest/service_stub.rb +22 -8
  8. data/lib/google/cloud/retail/v2/catalog_service/client.rb +36 -12
  9. data/lib/google/cloud/retail/v2/catalog_service/rest/client.rb +36 -12
  10. data/lib/google/cloud/retail/v2/catalog_service/rest/service_stub.rb +102 -68
  11. data/lib/google/cloud/retail/v2/completion_service/client.rb +36 -3
  12. data/lib/google/cloud/retail/v2/completion_service/operations.rb +19 -15
  13. data/lib/google/cloud/retail/v2/completion_service/rest/client.rb +36 -3
  14. data/lib/google/cloud/retail/v2/completion_service/rest/operations.rb +50 -38
  15. data/lib/google/cloud/retail/v2/completion_service/rest/service_stub.rb +30 -14
  16. data/lib/google/cloud/retail/v2/control_service/client.rb +36 -6
  17. data/lib/google/cloud/retail/v2/control_service/rest/client.rb +36 -6
  18. data/lib/google/cloud/retail/v2/control_service/rest/service_stub.rb +54 -32
  19. data/lib/google/cloud/retail/v2/generative_question_service/client.rb +35 -6
  20. data/lib/google/cloud/retail/v2/generative_question_service/rest/client.rb +35 -6
  21. data/lib/google/cloud/retail/v2/generative_question_service/rest/service_stub.rb +54 -32
  22. data/lib/google/cloud/retail/v2/model_service/client.rb +38 -9
  23. data/lib/google/cloud/retail/v2/model_service/operations.rb +19 -15
  24. data/lib/google/cloud/retail/v2/model_service/rest/client.rb +38 -9
  25. data/lib/google/cloud/retail/v2/model_service/rest/operations.rb +50 -38
  26. data/lib/google/cloud/retail/v2/model_service/rest/service_stub.rb +78 -50
  27. data/lib/google/cloud/retail/v2/prediction_service/client.rb +35 -2
  28. data/lib/google/cloud/retail/v2/prediction_service/rest/client.rb +35 -2
  29. data/lib/google/cloud/retail/v2/prediction_service/rest/service_stub.rb +22 -8
  30. data/lib/google/cloud/retail/v2/product_service/client.rb +43 -13
  31. data/lib/google/cloud/retail/v2/product_service/operations.rb +19 -15
  32. data/lib/google/cloud/retail/v2/product_service/rest/client.rb +43 -13
  33. data/lib/google/cloud/retail/v2/product_service/rest/operations.rb +50 -38
  34. data/lib/google/cloud/retail/v2/product_service/rest/service_stub.rb +110 -74
  35. data/lib/google/cloud/retail/v2/search_service/client.rb +36 -2
  36. data/lib/google/cloud/retail/v2/search_service/rest/client.rb +35 -2
  37. data/lib/google/cloud/retail/v2/search_service/rest/service_stub.rb +22 -8
  38. data/lib/google/cloud/retail/v2/serving_config_service/client.rb +36 -8
  39. data/lib/google/cloud/retail/v2/serving_config_service/rest/client.rb +36 -8
  40. data/lib/google/cloud/retail/v2/serving_config_service/rest/service_stub.rb +70 -44
  41. data/lib/google/cloud/retail/v2/user_event_service/client.rb +38 -6
  42. data/lib/google/cloud/retail/v2/user_event_service/operations.rb +19 -15
  43. data/lib/google/cloud/retail/v2/user_event_service/rest/client.rb +38 -6
  44. data/lib/google/cloud/retail/v2/user_event_service/rest/operations.rb +50 -38
  45. data/lib/google/cloud/retail/v2/user_event_service/rest/service_stub.rb +54 -32
  46. data/lib/google/cloud/retail/v2/version.rb +1 -1
  47. data/proto_docs/google/api/client.rb +39 -0
  48. data/proto_docs/google/cloud/retail/v2/common.rb +28 -0
  49. data/proto_docs/google/cloud/retail/v2/export_config.rb +4 -0
  50. data/proto_docs/google/cloud/retail/v2/import_config.rb +12 -0
  51. data/proto_docs/google/cloud/retail/v2/product.rb +4 -0
  52. data/proto_docs/google/cloud/retail/v2/search_service.rb +12 -0
  53. data/proto_docs/google/longrunning/operations.rb +23 -14
  54. data/proto_docs/google/protobuf/struct.rb +12 -0
  55. metadata +6 -9
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4aa02e8e0ee56a15c8b30bd31e571e2bcf3c6af44c42e3ab9d6e4abd3fc0de15
4
- data.tar.gz: 4992bbdd87ad86fc8dda3fc19baf21fb4a8442a1226c6f960dd946c435645f2d
3
+ metadata.gz: 5bf43a847de98511b90ecef0e6a17235e1ab724336c33c1bd8908c9ca55da0d7
4
+ data.tar.gz: 168ffdcdd25beb34e83a7bf08ffd9891918f34a7a4b28ac0ef87a16f2755ea20
5
5
  SHA512:
6
- metadata.gz: 9d5f510fd2fa52c8e4fb84b5e8b04a65cf627a213ed4b4da9d199888ab74344f0fb680f10c4d92d5aabc7b821b4f85d4db556a3c4a0c67eb1e02ac34278fa814
7
- data.tar.gz: 0c161397e0c69cd41c795542e7e46cfbbd99d7c0741c5df5e9a5a761c54df050d9fcca58aff5490af3be6021fa38bb7d294eb9f97b0e2fcc48a7ee8178612402
6
+ metadata.gz: 323f4a988965a732953134447b6c109288691beb9376642c9b76ade7d27d78c8e73ad79b6a43656d55ad60327e7bce507422767d59cf35926f1ee4a5e4bdc722
7
+ data.tar.gz: 6fc493d26ec664e4864d3489417065cdf04781e36d027883da9444f239566e3d3c21eb045894a2271b0cc7d1902bb9128c89aef65b8acbcae04ae7eb5ae13dea
data/README.md CHANGED
@@ -43,40 +43,50 @@ for class and method documentation.
43
43
  See also the [Product Documentation](https://cloud.google.com/retail/docs/apis)
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/retail/v2"
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::Retail::V2::AnalyticsService::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
@@ -169,14 +169,26 @@ module Google
169
169
  universe_domain: @config.universe_domain,
170
170
  channel_args: @config.channel_args,
171
171
  interceptors: @config.interceptors,
172
- channel_pool_config: @config.channel_pool
172
+ channel_pool_config: @config.channel_pool,
173
+ logger: @config.logger
173
174
  )
174
175
 
176
+ @analytics_service_stub.stub_logger&.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
185
+
175
186
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
176
187
  config.credentials = credentials
177
188
  config.quota_project = @quota_project_id
178
189
  config.endpoint = @analytics_service_stub.endpoint
179
190
  config.universe_domain = @analytics_service_stub.universe_domain
191
+ config.logger = @analytics_service_stub.logger if config.respond_to? :logger=
180
192
  end
181
193
  end
182
194
 
@@ -194,6 +206,15 @@ module Google
194
206
  #
195
207
  attr_reader :location_client
196
208
 
209
+ ##
210
+ # The logger used for request/response debug logging.
211
+ #
212
+ # @return [Logger]
213
+ #
214
+ def logger
215
+ @analytics_service_stub.logger
216
+ end
217
+
197
218
  # Service calls
198
219
 
199
220
  ##
@@ -308,7 +329,7 @@ module Google
308
329
  @analytics_service_stub.call_rpc :export_analytics_metrics, request, options: options do |response, operation|
309
330
  response = ::Gapic::Operation.new response, @operations_client, options: options
310
331
  yield response, operation if block_given?
311
- return response
332
+ throw :response, response
312
333
  end
313
334
  rescue ::GRPC::BadStatus => e
314
335
  raise ::Google::Cloud::Error.from_error(e)
@@ -358,6 +379,13 @@ module Google
358
379
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
359
380
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
360
381
  # * (`nil`) indicating no credentials
382
+ #
383
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
384
+ # external source for authentication to Google Cloud, you must validate it before
385
+ # providing it to a Google API client library. Providing an unvalidated credential
386
+ # configuration to Google APIs can compromise the security of your systems and data.
387
+ # For more information, refer to [Validate credential configurations from external
388
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
361
389
  # @return [::Object]
362
390
  # @!attribute [rw] scope
363
391
  # The OAuth scopes
@@ -397,6 +425,11 @@ module Google
397
425
  # default endpoint URL. The default value of nil uses the environment
398
426
  # universe (usually the default "googleapis.com" universe).
399
427
  # @return [::String,nil]
428
+ # @!attribute [rw] logger
429
+ # A custom logger to use for request/response debug logging, or the value
430
+ # `:default` (the default) to construct a default logger, or `nil` to
431
+ # explicitly disable logging.
432
+ # @return [::Logger,:default,nil]
400
433
  #
401
434
  class Configuration
402
435
  extend ::Gapic::Config
@@ -421,6 +454,7 @@ module Google
421
454
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
422
455
  config_attr :quota_project, nil, ::String, nil
423
456
  config_attr :universe_domain, nil, ::String, nil
457
+ config_attr :logger, :default, ::Logger, nil, :default
424
458
 
425
459
  # @private
426
460
  def initialize parent_config = nil
@@ -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
@@ -162,14 +162,26 @@ module Google
162
162
  endpoint: @config.endpoint,
163
163
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
164
164
  universe_domain: @config.universe_domain,
165
- credentials: credentials
165
+ credentials: credentials,
166
+ logger: @config.logger
166
167
  )
167
168
 
169
+ @analytics_service_stub.logger(stub: true)&.info do |entry|
170
+ entry.set_system_name
171
+ entry.set_service
172
+ entry.message = "Created client for #{entry.service}"
173
+ entry.set_credentials_fields credentials
174
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
175
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
176
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
177
+ end
178
+
168
179
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
169
180
  config.credentials = credentials
170
181
  config.quota_project = @quota_project_id
171
182
  config.endpoint = @analytics_service_stub.endpoint
172
183
  config.universe_domain = @analytics_service_stub.universe_domain
184
+ config.logger = @analytics_service_stub.logger if config.respond_to? :logger=
173
185
  end
174
186
  end
175
187
 
@@ -187,6 +199,15 @@ module Google
187
199
  #
188
200
  attr_reader :location_client
189
201
 
202
+ ##
203
+ # The logger used for request/response debug logging.
204
+ #
205
+ # @return [Logger]
206
+ #
207
+ def logger
208
+ @analytics_service_stub.logger
209
+ end
210
+
190
211
  # Service calls
191
212
 
192
213
  ##
@@ -294,7 +315,7 @@ module Google
294
315
  @analytics_service_stub.export_analytics_metrics request, options do |result, operation|
295
316
  result = ::Gapic::Operation.new result, @operations_client, options: options
296
317
  yield result, operation if block_given?
297
- return result
318
+ throw :response, result
298
319
  end
299
320
  rescue ::Gapic::Rest::Error => e
300
321
  raise ::Google::Cloud::Error.from_error(e)
@@ -342,6 +363,13 @@ module Google
342
363
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
343
364
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
344
365
  # * (`nil`) indicating no credentials
366
+ #
367
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
368
+ # external source for authentication to Google Cloud, you must validate it before
369
+ # providing it to a Google API client library. Providing an unvalidated credential
370
+ # configuration to Google APIs can compromise the security of your systems and data.
371
+ # For more information, refer to [Validate credential configurations from external
372
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
345
373
  # @return [::Object]
346
374
  # @!attribute [rw] scope
347
375
  # The OAuth scopes
@@ -374,6 +402,11 @@ module Google
374
402
  # default endpoint URL. The default value of nil uses the environment
375
403
  # universe (usually the default "googleapis.com" universe).
376
404
  # @return [::String,nil]
405
+ # @!attribute [rw] logger
406
+ # A custom logger to use for request/response debug logging, or the value
407
+ # `:default` (the default) to construct a default logger, or `nil` to
408
+ # explicitly disable logging.
409
+ # @return [::Logger,:default,nil]
377
410
  #
378
411
  class Configuration
379
412
  extend ::Gapic::Config
@@ -395,6 +428,7 @@ module Google
395
428
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
396
429
  config_attr :quota_project, nil, ::String, nil
397
430
  config_attr :universe_domain, nil, ::String, nil
431
+ config_attr :logger, :default, ::Logger, nil, :default
398
432
 
399
433
  # @private
400
434
  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
  ##
@@ -30,7 +30,8 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
33
+ # @private
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
34
35
  # These require statements are intentionally placed here to initialize
35
36
  # the REST modules only when it's required.
36
37
  require "gapic/rest"
@@ -40,7 +41,9 @@ module Google
40
41
  universe_domain: universe_domain,
41
42
  credentials: credentials,
42
43
  numeric_enums: true,
43
- raise_faraday_errors: false
44
+ service_name: self.class,
45
+ raise_faraday_errors: false,
46
+ logger: logger
44
47
  end
45
48
 
46
49
  ##
@@ -61,6 +64,15 @@ module Google
61
64
  @client_stub.endpoint
62
65
  end
63
66
 
67
+ ##
68
+ # The logger used for request/response debug logging.
69
+ #
70
+ # @return [Logger]
71
+ #
72
+ def logger stub: false
73
+ stub ? @client_stub.stub_logger : @client_stub.logger
74
+ end
75
+
64
76
  ##
65
77
  # Baseline implementation for the export_analytics_metrics REST call
66
78
  #
@@ -87,16 +99,18 @@ module Google
87
99
 
88
100
  response = @client_stub.make_http_request(
89
101
  verb,
90
- uri: uri,
91
- body: body || "",
92
- params: query_string_params,
102
+ uri: uri,
103
+ body: body || "",
104
+ params: query_string_params,
105
+ method_name: "export_analytics_metrics",
93
106
  options: options
94
107
  )
95
108
  operation = ::Gapic::Rest::TransportOperation.new response
96
109
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
97
-
98
- yield result, operation if block_given?
99
- result
110
+ catch :response do
111
+ yield result, operation if block_given?
112
+ result
113
+ end
100
114
  end
101
115
 
102
116
  ##