google-cloud-recommendation_engine-v1beta1 0.9.2 → 0.11.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 (25) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -21
  3. data/lib/google/cloud/recommendation_engine/v1beta1/catalog_service/client.rb +36 -7
  4. data/lib/google/cloud/recommendation_engine/v1beta1/catalog_service/operations.rb +19 -15
  5. data/lib/google/cloud/recommendation_engine/v1beta1/catalog_service/rest/client.rb +36 -7
  6. data/lib/google/cloud/recommendation_engine/v1beta1/catalog_service/rest/operations.rb +50 -38
  7. data/lib/google/cloud/recommendation_engine/v1beta1/catalog_service/rest/service_stub.rb +62 -38
  8. data/lib/google/cloud/recommendation_engine/v1beta1/prediction_api_key_registry/client.rb +35 -4
  9. data/lib/google/cloud/recommendation_engine/v1beta1/prediction_api_key_registry/rest/client.rb +35 -4
  10. data/lib/google/cloud/recommendation_engine/v1beta1/prediction_api_key_registry/rest/service_stub.rb +38 -20
  11. data/lib/google/cloud/recommendation_engine/v1beta1/prediction_service/client.rb +35 -2
  12. data/lib/google/cloud/recommendation_engine/v1beta1/prediction_service/rest/client.rb +35 -2
  13. data/lib/google/cloud/recommendation_engine/v1beta1/prediction_service/rest/service_stub.rb +22 -8
  14. data/lib/google/cloud/recommendation_engine/v1beta1/user_event_service/client.rb +37 -6
  15. data/lib/google/cloud/recommendation_engine/v1beta1/user_event_service/operations.rb +19 -15
  16. data/lib/google/cloud/recommendation_engine/v1beta1/user_event_service/rest/client.rb +37 -6
  17. data/lib/google/cloud/recommendation_engine/v1beta1/user_event_service/rest/operations.rb +50 -38
  18. data/lib/google/cloud/recommendation_engine/v1beta1/user_event_service/rest/service_stub.rb +54 -32
  19. data/lib/google/cloud/recommendation_engine/v1beta1/version.rb +1 -1
  20. data/proto_docs/google/api/client.rb +39 -0
  21. data/proto_docs/google/cloud/recommendationengine/v1beta1/catalog.rb +4 -0
  22. data/proto_docs/google/cloud/recommendationengine/v1beta1/import.rb +6 -0
  23. data/proto_docs/google/longrunning/operations.rb +23 -14
  24. data/proto_docs/google/protobuf/struct.rb +12 -0
  25. metadata +6 -9
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 23275fcdd1c73fe2838c68ec92e75877d810c6803888bafb78a6798465377b70
4
- data.tar.gz: 4e64e8533548c6c62ff762f0dead9280db80ef09d8f2797bca2c293498d50463
3
+ metadata.gz: b151eacf1fe38c25c7820c4dc62e4c61f46134245202373f0fb6d9042ddaeb14
4
+ data.tar.gz: e8ec2dd43a5fff039e61e0dae1fc180c5d67ce80ccd16aadb26dbb195f5c326f
5
5
  SHA512:
6
- metadata.gz: 3c19fa61003070b8b9c60faebf401c2439b9fb1f34ac51432e95b49bb8fe5f26d412a5a490957196aaf87d521acc06029c5a9c974ecd22bd8cc4ba67b4d305cc
7
- data.tar.gz: efab2f01e9cb6f11bedb7241e62412fc84374fa122a63e2511199bc201a2ebe609575fb41f930e1be02e125285b0ecc6a54c38dbab21fdd1513d9449622cb805
6
+ metadata.gz: 3b8debf83cd1cb8cdfce101f0ab8b67d93d1b7fa77fd01a614bceab484f9f1d679ff7e98eb0b65e3d511c25c11280215e058ad981f8dbc7a27429fd0b3913b1a
7
+ data.tar.gz: 4137376a50d8c0b46af2db4febff7a6943d84af761c2a27b7afd4838f57b61e784f7f46ce4e85724bb50020a0d96c081bbe6422321bd94fa0db5b2b5e79cf029
data/README.md CHANGED
@@ -43,40 +43,50 @@ for class and method documentation.
43
43
  See also the [Product Documentation](https://cloud.google.com/recommendations)
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/recommendation_engine/v1beta1"
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::RecommendationEngine::V1beta1::CatalogService::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
@@ -194,8 +194,19 @@ module Google
194
194
  universe_domain: @config.universe_domain,
195
195
  channel_args: @config.channel_args,
196
196
  interceptors: @config.interceptors,
197
- channel_pool_config: @config.channel_pool
197
+ channel_pool_config: @config.channel_pool,
198
+ logger: @config.logger
198
199
  )
200
+
201
+ @catalog_service_stub.stub_logger&.info do |entry|
202
+ entry.set_system_name
203
+ entry.set_service
204
+ entry.message = "Created client for #{entry.service}"
205
+ entry.set_credentials_fields credentials
206
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
207
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
208
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
209
+ end
199
210
  end
200
211
 
201
212
  ##
@@ -205,6 +216,15 @@ module Google
205
216
  #
206
217
  attr_reader :operations_client
207
218
 
219
+ ##
220
+ # The logger used for request/response debug logging.
221
+ #
222
+ # @return [Logger]
223
+ #
224
+ def logger
225
+ @catalog_service_stub.logger
226
+ end
227
+
208
228
  # Service calls
209
229
 
210
230
  ##
@@ -290,7 +310,6 @@ module Google
290
310
 
291
311
  @catalog_service_stub.call_rpc :create_catalog_item, request, options: options do |response, operation|
292
312
  yield response, operation if block_given?
293
- return response
294
313
  end
295
314
  rescue ::GRPC::BadStatus => e
296
315
  raise ::Google::Cloud::Error.from_error(e)
@@ -377,7 +396,6 @@ module Google
377
396
 
378
397
  @catalog_service_stub.call_rpc :get_catalog_item, request, options: options do |response, operation|
379
398
  yield response, operation if block_given?
380
- return response
381
399
  end
382
400
  rescue ::GRPC::BadStatus => e
383
401
  raise ::Google::Cloud::Error.from_error(e)
@@ -476,7 +494,7 @@ module Google
476
494
  @catalog_service_stub.call_rpc :list_catalog_items, request, options: options do |response, operation|
477
495
  response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_catalog_items, request, response, operation, options
478
496
  yield response, operation if block_given?
479
- return response
497
+ throw :response, response
480
498
  end
481
499
  rescue ::GRPC::BadStatus => e
482
500
  raise ::Google::Cloud::Error.from_error(e)
@@ -570,7 +588,6 @@ module Google
570
588
 
571
589
  @catalog_service_stub.call_rpc :update_catalog_item, request, options: options do |response, operation|
572
590
  yield response, operation if block_given?
573
- return response
574
591
  end
575
592
  rescue ::GRPC::BadStatus => e
576
593
  raise ::Google::Cloud::Error.from_error(e)
@@ -657,7 +674,6 @@ module Google
657
674
 
658
675
  @catalog_service_stub.call_rpc :delete_catalog_item, request, options: options do |response, operation|
659
676
  yield response, operation if block_given?
660
- return response
661
677
  end
662
678
  rescue ::GRPC::BadStatus => e
663
679
  raise ::Google::Cloud::Error.from_error(e)
@@ -765,7 +781,7 @@ module Google
765
781
  @catalog_service_stub.call_rpc :import_catalog_items, request, options: options do |response, operation|
766
782
  response = ::Gapic::Operation.new response, @operations_client, options: options
767
783
  yield response, operation if block_given?
768
- return response
784
+ throw :response, response
769
785
  end
770
786
  rescue ::GRPC::BadStatus => e
771
787
  raise ::Google::Cloud::Error.from_error(e)
@@ -815,6 +831,13 @@ module Google
815
831
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
816
832
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
817
833
  # * (`nil`) indicating no credentials
834
+ #
835
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
836
+ # external source for authentication to Google Cloud, you must validate it before
837
+ # providing it to a Google API client library. Providing an unvalidated credential
838
+ # configuration to Google APIs can compromise the security of your systems and data.
839
+ # For more information, refer to [Validate credential configurations from external
840
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
818
841
  # @return [::Object]
819
842
  # @!attribute [rw] scope
820
843
  # The OAuth scopes
@@ -854,6 +877,11 @@ module Google
854
877
  # default endpoint URL. The default value of nil uses the environment
855
878
  # universe (usually the default "googleapis.com" universe).
856
879
  # @return [::String,nil]
880
+ # @!attribute [rw] logger
881
+ # A custom logger to use for request/response debug logging, or the value
882
+ # `:default` (the default) to construct a default logger, or `nil` to
883
+ # explicitly disable logging.
884
+ # @return [::Logger,:default,nil]
857
885
  #
858
886
  class Configuration
859
887
  extend ::Gapic::Config
@@ -878,6 +906,7 @@ module Google
878
906
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
879
907
  config_attr :quota_project, nil, ::String, nil
880
908
  config_attr :universe_domain, nil, ::String, nil
909
+ config_attr :logger, :default, ::Logger, nil, :default
881
910
 
882
911
  # @private
883
912
  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
@@ -187,8 +187,19 @@ module Google
187
187
  endpoint: @config.endpoint,
188
188
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
189
189
  universe_domain: @config.universe_domain,
190
- credentials: credentials
190
+ credentials: credentials,
191
+ logger: @config.logger
191
192
  )
193
+
194
+ @catalog_service_stub.logger(stub: true)&.info do |entry|
195
+ entry.set_system_name
196
+ entry.set_service
197
+ entry.message = "Created client for #{entry.service}"
198
+ entry.set_credentials_fields credentials
199
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
200
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
201
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
202
+ end
192
203
  end
193
204
 
194
205
  ##
@@ -198,6 +209,15 @@ module Google
198
209
  #
199
210
  attr_reader :operations_client
200
211
 
212
+ ##
213
+ # The logger used for request/response debug logging.
214
+ #
215
+ # @return [Logger]
216
+ #
217
+ def logger
218
+ @catalog_service_stub.logger
219
+ end
220
+
201
221
  # Service calls
202
222
 
203
223
  ##
@@ -276,7 +296,6 @@ module Google
276
296
 
277
297
  @catalog_service_stub.create_catalog_item request, options do |result, operation|
278
298
  yield result, operation if block_given?
279
- return result
280
299
  end
281
300
  rescue ::Gapic::Rest::Error => e
282
301
  raise ::Google::Cloud::Error.from_error(e)
@@ -356,7 +375,6 @@ module Google
356
375
 
357
376
  @catalog_service_stub.get_catalog_item request, options do |result, operation|
358
377
  yield result, operation if block_given?
359
- return result
360
378
  end
361
379
  rescue ::Gapic::Rest::Error => e
362
380
  raise ::Google::Cloud::Error.from_error(e)
@@ -448,7 +466,7 @@ module Google
448
466
  @catalog_service_stub.list_catalog_items request, options do |result, operation|
449
467
  result = ::Gapic::Rest::PagedEnumerable.new @catalog_service_stub, :list_catalog_items, "catalog_items", request, result, options
450
468
  yield result, operation if block_given?
451
- return result
469
+ throw :response, result
452
470
  end
453
471
  rescue ::Gapic::Rest::Error => e
454
472
  raise ::Google::Cloud::Error.from_error(e)
@@ -535,7 +553,6 @@ module Google
535
553
 
536
554
  @catalog_service_stub.update_catalog_item request, options do |result, operation|
537
555
  yield result, operation if block_given?
538
- return result
539
556
  end
540
557
  rescue ::Gapic::Rest::Error => e
541
558
  raise ::Google::Cloud::Error.from_error(e)
@@ -615,7 +632,6 @@ module Google
615
632
 
616
633
  @catalog_service_stub.delete_catalog_item request, options do |result, operation|
617
634
  yield result, operation if block_given?
618
- return result
619
635
  end
620
636
  rescue ::Gapic::Rest::Error => e
621
637
  raise ::Google::Cloud::Error.from_error(e)
@@ -716,7 +732,7 @@ module Google
716
732
  @catalog_service_stub.import_catalog_items request, options do |result, operation|
717
733
  result = ::Gapic::Operation.new result, @operations_client, options: options
718
734
  yield result, operation if block_given?
719
- return result
735
+ throw :response, result
720
736
  end
721
737
  rescue ::Gapic::Rest::Error => e
722
738
  raise ::Google::Cloud::Error.from_error(e)
@@ -764,6 +780,13 @@ module Google
764
780
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
765
781
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
766
782
  # * (`nil`) indicating no credentials
783
+ #
784
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
785
+ # external source for authentication to Google Cloud, you must validate it before
786
+ # providing it to a Google API client library. Providing an unvalidated credential
787
+ # configuration to Google APIs can compromise the security of your systems and data.
788
+ # For more information, refer to [Validate credential configurations from external
789
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
767
790
  # @return [::Object]
768
791
  # @!attribute [rw] scope
769
792
  # The OAuth scopes
@@ -796,6 +819,11 @@ module Google
796
819
  # default endpoint URL. The default value of nil uses the environment
797
820
  # universe (usually the default "googleapis.com" universe).
798
821
  # @return [::String,nil]
822
+ # @!attribute [rw] logger
823
+ # A custom logger to use for request/response debug logging, or the value
824
+ # `:default` (the default) to construct a default logger, or `nil` to
825
+ # explicitly disable logging.
826
+ # @return [::Logger,:default,nil]
799
827
  #
800
828
  class Configuration
801
829
  extend ::Gapic::Config
@@ -817,6 +845,7 @@ module Google
817
845
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
818
846
  config_attr :quota_project, nil, ::String, nil
819
847
  config_attr :universe_domain, nil, ::String, nil
848
+ config_attr :logger, :default, ::Logger, nil, :default
820
849
 
821
850
  # @private
822
851
  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
  ##