google-cloud-channel-v1 1.1.0 → 1.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +31 -21
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/client.rb +37 -4
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/operations.rb +19 -15
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/client.rb +37 -4
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/operations.rb +50 -38
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/service_stub.rb +38 -20
- data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb +82 -50
- data/lib/google/cloud/channel/v1/cloud_channel_service/operations.rb +19 -15
- data/lib/google/cloud/channel/v1/cloud_channel_service/rest/client.rb +83 -50
- data/lib/google/cloud/channel/v1/cloud_channel_service/rest/operations.rb +50 -38
- data/lib/google/cloud/channel/v1/cloud_channel_service/rest/service_stub.rb +406 -296
- data/lib/google/cloud/channel/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +39 -0
- data/proto_docs/google/cloud/channel/v1/common.rb +10 -0
- data/proto_docs/google/cloud/channel/v1/entitlement_changes.rb +8 -0
- data/proto_docs/google/cloud/channel/v1/reports_service.rb +12 -0
- data/proto_docs/google/cloud/channel/v1/repricing.rb +4 -0
- data/proto_docs/google/cloud/channel/v1/service.rb +22 -0
- data/proto_docs/google/cloud/channel/v1/subscriber_event.rb +4 -0
- data/proto_docs/google/longrunning/operations.rb +23 -14
- data/proto_docs/google/type/datetime.rb +4 -0
- metadata +6 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: be881e265be7deeef8b87f40070f04a5d89f38eb8fa8e21ce04ba8f220f7fb27
|
4
|
+
data.tar.gz: 7ec7d81fa739fb2e61cdfb56edebb3eb9ecb9bb7ea8cd66a7e5ef782295ca575
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 25d2116f001f8f08d8f820068e9f257627025235d5ab283453da4d119854c5db47fea40f6c042c0f18608476e30d589a679b91fe989e5623723dc789037b220d
|
7
|
+
data.tar.gz: 71777d803aa6acc3090923e7cce25e3790aaaefd7ce6a7e3bd6be359efed704602e304f8cdae966be6531b67f1806c163b9e03f5ed136012a69812411fc251b0
|
data/README.md
CHANGED
@@ -43,40 +43,50 @@ for class and method documentation.
|
|
43
43
|
See also the [Product Documentation](https://cloud.google.com/channel)
|
44
44
|
for general usage information.
|
45
45
|
|
46
|
-
##
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
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/channel/v1"
|
57
76
|
require "logger"
|
58
77
|
|
59
|
-
|
60
|
-
|
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::Channel::V1::CloudChannelReportsService::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
|
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
|
@@ -173,8 +173,19 @@ module Google
|
|
173
173
|
universe_domain: @config.universe_domain,
|
174
174
|
channel_args: @config.channel_args,
|
175
175
|
interceptors: @config.interceptors,
|
176
|
-
channel_pool_config: @config.channel_pool
|
176
|
+
channel_pool_config: @config.channel_pool,
|
177
|
+
logger: @config.logger
|
177
178
|
)
|
179
|
+
|
180
|
+
@cloud_channel_reports_service_stub.stub_logger&.info do |entry|
|
181
|
+
entry.set_system_name
|
182
|
+
entry.set_service
|
183
|
+
entry.message = "Created client for #{entry.service}"
|
184
|
+
entry.set_credentials_fields credentials
|
185
|
+
entry.set "customEndpoint", @config.endpoint if @config.endpoint
|
186
|
+
entry.set "defaultTimeout", @config.timeout if @config.timeout
|
187
|
+
entry.set "quotaProject", @quota_project_id if @quota_project_id
|
188
|
+
end
|
178
189
|
end
|
179
190
|
|
180
191
|
##
|
@@ -184,6 +195,15 @@ module Google
|
|
184
195
|
#
|
185
196
|
attr_reader :operations_client
|
186
197
|
|
198
|
+
##
|
199
|
+
# The logger used for request/response debug logging.
|
200
|
+
#
|
201
|
+
# @return [Logger]
|
202
|
+
#
|
203
|
+
def logger
|
204
|
+
@cloud_channel_reports_service_stub.logger
|
205
|
+
end
|
206
|
+
|
187
207
|
# Service calls
|
188
208
|
|
189
209
|
##
|
@@ -326,7 +346,7 @@ module Google
|
|
326
346
|
@cloud_channel_reports_service_stub.call_rpc :run_report_job, request, options: options do |response, operation|
|
327
347
|
response = ::Gapic::Operation.new response, @operations_client, options: options
|
328
348
|
yield response, operation if block_given?
|
329
|
-
|
349
|
+
throw :response, response
|
330
350
|
end
|
331
351
|
rescue ::GRPC::BadStatus => e
|
332
352
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -444,7 +464,7 @@ module Google
|
|
444
464
|
@cloud_channel_reports_service_stub.call_rpc :fetch_report_results, request, options: options do |response, operation|
|
445
465
|
response = ::Gapic::PagedEnumerable.new @cloud_channel_reports_service_stub, :fetch_report_results, request, response, operation, options
|
446
466
|
yield response, operation if block_given?
|
447
|
-
|
467
|
+
throw :response, response
|
448
468
|
end
|
449
469
|
rescue ::GRPC::BadStatus => e
|
450
470
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -559,7 +579,7 @@ module Google
|
|
559
579
|
@cloud_channel_reports_service_stub.call_rpc :list_reports, request, options: options do |response, operation|
|
560
580
|
response = ::Gapic::PagedEnumerable.new @cloud_channel_reports_service_stub, :list_reports, request, response, operation, options
|
561
581
|
yield response, operation if block_given?
|
562
|
-
|
582
|
+
throw :response, response
|
563
583
|
end
|
564
584
|
rescue ::GRPC::BadStatus => e
|
565
585
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -609,6 +629,13 @@ module Google
|
|
609
629
|
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
610
630
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
611
631
|
# * (`nil`) indicating no credentials
|
632
|
+
#
|
633
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
634
|
+
# external source for authentication to Google Cloud, you must validate it before
|
635
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
636
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
637
|
+
# For more information, refer to [Validate credential configurations from external
|
638
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
612
639
|
# @return [::Object]
|
613
640
|
# @!attribute [rw] scope
|
614
641
|
# The OAuth scopes
|
@@ -648,6 +675,11 @@ module Google
|
|
648
675
|
# default endpoint URL. The default value of nil uses the environment
|
649
676
|
# universe (usually the default "googleapis.com" universe).
|
650
677
|
# @return [::String,nil]
|
678
|
+
# @!attribute [rw] logger
|
679
|
+
# A custom logger to use for request/response debug logging, or the value
|
680
|
+
# `:default` (the default) to construct a default logger, or `nil` to
|
681
|
+
# explicitly disable logging.
|
682
|
+
# @return [::Logger,:default,nil]
|
651
683
|
#
|
652
684
|
class Configuration
|
653
685
|
extend ::Gapic::Config
|
@@ -672,6 +704,7 @@ module Google
|
|
672
704
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
673
705
|
config_attr :quota_project, nil, ::String, nil
|
674
706
|
config_attr :universe_domain, nil, ::String, nil
|
707
|
+
config_attr :logger, :default, ::Logger, nil, :default
|
675
708
|
|
676
709
|
# @private
|
677
710
|
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
|
-
|
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
|
-
|
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
|
425
|
-
# corresponding to
|
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
|
-
|
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
|
@@ -165,8 +165,19 @@ module Google
|
|
165
165
|
endpoint: @config.endpoint,
|
166
166
|
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
167
167
|
universe_domain: @config.universe_domain,
|
168
|
-
credentials: credentials
|
168
|
+
credentials: credentials,
|
169
|
+
logger: @config.logger
|
169
170
|
)
|
171
|
+
|
172
|
+
@cloud_channel_reports_service_stub.logger(stub: true)&.info do |entry|
|
173
|
+
entry.set_system_name
|
174
|
+
entry.set_service
|
175
|
+
entry.message = "Created client for #{entry.service}"
|
176
|
+
entry.set_credentials_fields credentials
|
177
|
+
entry.set "customEndpoint", @config.endpoint if @config.endpoint
|
178
|
+
entry.set "defaultTimeout", @config.timeout if @config.timeout
|
179
|
+
entry.set "quotaProject", @quota_project_id if @quota_project_id
|
180
|
+
end
|
170
181
|
end
|
171
182
|
|
172
183
|
##
|
@@ -176,6 +187,15 @@ module Google
|
|
176
187
|
#
|
177
188
|
attr_reader :operations_client
|
178
189
|
|
190
|
+
##
|
191
|
+
# The logger used for request/response debug logging.
|
192
|
+
#
|
193
|
+
# @return [Logger]
|
194
|
+
#
|
195
|
+
def logger
|
196
|
+
@cloud_channel_reports_service_stub.logger
|
197
|
+
end
|
198
|
+
|
179
199
|
# Service calls
|
180
200
|
|
181
201
|
##
|
@@ -309,7 +329,7 @@ module Google
|
|
309
329
|
@cloud_channel_reports_service_stub.run_report_job request, options do |result, operation|
|
310
330
|
result = ::Gapic::Operation.new result, @operations_client, options: options
|
311
331
|
yield result, operation if block_given?
|
312
|
-
|
332
|
+
throw :response, result
|
313
333
|
end
|
314
334
|
rescue ::Gapic::Rest::Error => e
|
315
335
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -418,7 +438,7 @@ module Google
|
|
418
438
|
@cloud_channel_reports_service_stub.fetch_report_results request, options do |result, operation|
|
419
439
|
result = ::Gapic::Rest::PagedEnumerable.new @cloud_channel_reports_service_stub, :fetch_report_results, "rows", request, result, options
|
420
440
|
yield result, operation if block_given?
|
421
|
-
|
441
|
+
throw :response, result
|
422
442
|
end
|
423
443
|
rescue ::Gapic::Rest::Error => e
|
424
444
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -524,7 +544,7 @@ module Google
|
|
524
544
|
@cloud_channel_reports_service_stub.list_reports request, options do |result, operation|
|
525
545
|
result = ::Gapic::Rest::PagedEnumerable.new @cloud_channel_reports_service_stub, :list_reports, "reports", request, result, options
|
526
546
|
yield result, operation if block_given?
|
527
|
-
|
547
|
+
throw :response, result
|
528
548
|
end
|
529
549
|
rescue ::Gapic::Rest::Error => e
|
530
550
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -572,6 +592,13 @@ module Google
|
|
572
592
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
573
593
|
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
574
594
|
# * (`nil`) indicating no credentials
|
595
|
+
#
|
596
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
597
|
+
# external source for authentication to Google Cloud, you must validate it before
|
598
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
599
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
600
|
+
# For more information, refer to [Validate credential configurations from external
|
601
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
575
602
|
# @return [::Object]
|
576
603
|
# @!attribute [rw] scope
|
577
604
|
# The OAuth scopes
|
@@ -604,6 +631,11 @@ module Google
|
|
604
631
|
# default endpoint URL. The default value of nil uses the environment
|
605
632
|
# universe (usually the default "googleapis.com" universe).
|
606
633
|
# @return [::String,nil]
|
634
|
+
# @!attribute [rw] logger
|
635
|
+
# A custom logger to use for request/response debug logging, or the value
|
636
|
+
# `:default` (the default) to construct a default logger, or `nil` to
|
637
|
+
# explicitly disable logging.
|
638
|
+
# @return [::Logger,:default,nil]
|
607
639
|
#
|
608
640
|
class Configuration
|
609
641
|
extend ::Gapic::Config
|
@@ -625,6 +657,7 @@ module Google
|
|
625
657
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
626
658
|
config_attr :quota_project, nil, ::String, nil
|
627
659
|
config_attr :universe_domain, nil, ::String, nil
|
660
|
+
config_attr :logger, :default, ::Logger, nil, :default
|
628
661
|
|
629
662
|
# @private
|
630
663
|
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
|
-
|
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
|
-
|
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
|
394
|
-
# corresponding to
|
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:
|
687
|
-
body:
|
688
|
-
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
|
-
|
695
|
-
|
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:
|
725
|
-
body:
|
726
|
-
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
|
-
|
733
|
-
|
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:
|
763
|
-
body:
|
764
|
-
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
|
-
|
771
|
-
|
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:
|
801
|
-
body:
|
802
|
-
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
|
-
|
809
|
-
|
818
|
+
catch :response do
|
819
|
+
yield result, operation if block_given?
|
820
|
+
result
|
821
|
+
end
|
810
822
|
end
|
811
823
|
|
812
824
|
##
|