google-cloud-cloud_controls_partner-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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6093cac5e80fcffcf7434070611ac204c2ac8c2f04c7df38291ee393b7808b9e
4
- data.tar.gz: caeab8b092028d4928798e2ec7e634d6690c665796e9d47295b601c76fffb050
3
+ metadata.gz: 45883390e3818578e9725b1dd570746043db89f2ae25b0b748849e80c25efdcd
4
+ data.tar.gz: 299600c1104ed382732c0fa771351280c2dfae5eeecdc787a6cff60bf69548ac
5
5
  SHA512:
6
- metadata.gz: 822eaf1acdd97905056de2bc5f11e7b330fdbd9f224d7eeb688efef33fbc1e4db47578ddc982137bc7ae840e98c89e364cf276d6c9c84f4aebc4016dd9a63fd3
7
- data.tar.gz: 6d9df44e314ff969165ae0ebad74d733a6eb69b2befe0e7ae1e2685ab74e28b9df78296326a4bdd0ff0d9a4add6370340a398008f2beb93e008064825ed44685
6
+ metadata.gz: 07ec2ce17fe3b238833186a2e2fb87a2aaf25ce5864b397a299383c1d401607030db66218928e2fd14294aa217c271716af711f9ad997d61657d776336da8ac7
7
+ data.tar.gz: 8bf9fc4d2b4b4d584c0d217dfb47005651130a1c4793694adf22cf38ed3fa7dbbcff3b67109b8688b6db0cb50bb25ef84a8d3b5491cc21b3159626c2c03ac01a
data/README.md CHANGED
@@ -43,40 +43,50 @@ for class and method documentation.
43
43
  See also the [Product Documentation](https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest)
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/cloud_controls_partner/v1"
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::CloudControlsPartner::V1::CloudControlsPartnerCore::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
@@ -192,8 +192,28 @@ module Google
192
192
  universe_domain: @config.universe_domain,
193
193
  channel_args: @config.channel_args,
194
194
  interceptors: @config.interceptors,
195
- channel_pool_config: @config.channel_pool
195
+ channel_pool_config: @config.channel_pool,
196
+ logger: @config.logger
196
197
  )
198
+
199
+ @cloud_controls_partner_core_stub.stub_logger&.info do |entry|
200
+ entry.set_system_name
201
+ entry.set_service
202
+ entry.message = "Created client for #{entry.service}"
203
+ entry.set_credentials_fields credentials
204
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
205
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
206
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
207
+ end
208
+ end
209
+
210
+ ##
211
+ # The logger used for request/response debug logging.
212
+ #
213
+ # @return [Logger]
214
+ #
215
+ def logger
216
+ @cloud_controls_partner_core_stub.logger
197
217
  end
198
218
 
199
219
  # Service calls
@@ -279,7 +299,6 @@ module Google
279
299
 
280
300
  @cloud_controls_partner_core_stub.call_rpc :get_workload, request, options: options do |response, operation|
281
301
  yield response, operation if block_given?
282
- return response
283
302
  end
284
303
  rescue ::GRPC::BadStatus => e
285
304
  raise ::Google::Cloud::Error.from_error(e)
@@ -382,7 +401,7 @@ module Google
382
401
  @cloud_controls_partner_core_stub.call_rpc :list_workloads, request, options: options do |response, operation|
383
402
  response = ::Gapic::PagedEnumerable.new @cloud_controls_partner_core_stub, :list_workloads, request, response, operation, options
384
403
  yield response, operation if block_given?
385
- return response
404
+ throw :response, response
386
405
  end
387
406
  rescue ::GRPC::BadStatus => e
388
407
  raise ::Google::Cloud::Error.from_error(e)
@@ -469,7 +488,6 @@ module Google
469
488
 
470
489
  @cloud_controls_partner_core_stub.call_rpc :get_customer, request, options: options do |response, operation|
471
490
  yield response, operation if block_given?
472
- return response
473
491
  end
474
492
  rescue ::GRPC::BadStatus => e
475
493
  raise ::Google::Cloud::Error.from_error(e)
@@ -571,7 +589,7 @@ module Google
571
589
  @cloud_controls_partner_core_stub.call_rpc :list_customers, request, options: options do |response, operation|
572
590
  response = ::Gapic::PagedEnumerable.new @cloud_controls_partner_core_stub, :list_customers, request, response, operation, options
573
591
  yield response, operation if block_given?
574
- return response
592
+ throw :response, response
575
593
  end
576
594
  rescue ::GRPC::BadStatus => e
577
595
  raise ::Google::Cloud::Error.from_error(e)
@@ -658,7 +676,6 @@ module Google
658
676
 
659
677
  @cloud_controls_partner_core_stub.call_rpc :get_ekm_connections, request, options: options do |response, operation|
660
678
  yield response, operation if block_given?
661
- return response
662
679
  end
663
680
  rescue ::GRPC::BadStatus => e
664
681
  raise ::Google::Cloud::Error.from_error(e)
@@ -745,7 +762,6 @@ module Google
745
762
 
746
763
  @cloud_controls_partner_core_stub.call_rpc :get_partner_permissions, request, options: options do |response, operation|
747
764
  yield response, operation if block_given?
748
- return response
749
765
  end
750
766
  rescue ::GRPC::BadStatus => e
751
767
  raise ::Google::Cloud::Error.from_error(e)
@@ -853,7 +869,7 @@ module Google
853
869
  @cloud_controls_partner_core_stub.call_rpc :list_access_approval_requests, request, options: options do |response, operation|
854
870
  response = ::Gapic::PagedEnumerable.new @cloud_controls_partner_core_stub, :list_access_approval_requests, request, response, operation, options
855
871
  yield response, operation if block_given?
856
- return response
872
+ throw :response, response
857
873
  end
858
874
  rescue ::GRPC::BadStatus => e
859
875
  raise ::Google::Cloud::Error.from_error(e)
@@ -940,7 +956,6 @@ module Google
940
956
 
941
957
  @cloud_controls_partner_core_stub.call_rpc :get_partner, request, options: options do |response, operation|
942
958
  yield response, operation if block_given?
943
- return response
944
959
  end
945
960
  rescue ::GRPC::BadStatus => e
946
961
  raise ::Google::Cloud::Error.from_error(e)
@@ -990,6 +1005,13 @@ module Google
990
1005
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
991
1006
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
992
1007
  # * (`nil`) indicating no credentials
1008
+ #
1009
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
1010
+ # external source for authentication to Google Cloud, you must validate it before
1011
+ # providing it to a Google API client library. Providing an unvalidated credential
1012
+ # configuration to Google APIs can compromise the security of your systems and data.
1013
+ # For more information, refer to [Validate credential configurations from external
1014
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
993
1015
  # @return [::Object]
994
1016
  # @!attribute [rw] scope
995
1017
  # The OAuth scopes
@@ -1029,6 +1051,11 @@ module Google
1029
1051
  # default endpoint URL. The default value of nil uses the environment
1030
1052
  # universe (usually the default "googleapis.com" universe).
1031
1053
  # @return [::String,nil]
1054
+ # @!attribute [rw] logger
1055
+ # A custom logger to use for request/response debug logging, or the value
1056
+ # `:default` (the default) to construct a default logger, or `nil` to
1057
+ # explicitly disable logging.
1058
+ # @return [::Logger,:default,nil]
1032
1059
  #
1033
1060
  class Configuration
1034
1061
  extend ::Gapic::Config
@@ -1053,6 +1080,7 @@ module Google
1053
1080
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1054
1081
  config_attr :quota_project, nil, ::String, nil
1055
1082
  config_attr :universe_domain, nil, ::String, nil
1083
+ config_attr :logger, :default, ::Logger, nil, :default
1056
1084
 
1057
1085
  # @private
1058
1086
  def initialize parent_config = nil
@@ -185,8 +185,28 @@ module Google
185
185
  endpoint: @config.endpoint,
186
186
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
187
187
  universe_domain: @config.universe_domain,
188
- credentials: credentials
188
+ credentials: credentials,
189
+ logger: @config.logger
189
190
  )
191
+
192
+ @cloud_controls_partner_core_stub.logger(stub: true)&.info do |entry|
193
+ entry.set_system_name
194
+ entry.set_service
195
+ entry.message = "Created client for #{entry.service}"
196
+ entry.set_credentials_fields credentials
197
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
198
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
199
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
200
+ end
201
+ end
202
+
203
+ ##
204
+ # The logger used for request/response debug logging.
205
+ #
206
+ # @return [Logger]
207
+ #
208
+ def logger
209
+ @cloud_controls_partner_core_stub.logger
190
210
  end
191
211
 
192
212
  # Service calls
@@ -265,7 +285,6 @@ module Google
265
285
 
266
286
  @cloud_controls_partner_core_stub.get_workload request, options do |result, operation|
267
287
  yield result, operation if block_given?
268
- return result
269
288
  end
270
289
  rescue ::Gapic::Rest::Error => e
271
290
  raise ::Google::Cloud::Error.from_error(e)
@@ -360,7 +379,6 @@ module Google
360
379
 
361
380
  @cloud_controls_partner_core_stub.list_workloads request, options do |result, operation|
362
381
  yield result, operation if block_given?
363
- return result
364
382
  end
365
383
  rescue ::Gapic::Rest::Error => e
366
384
  raise ::Google::Cloud::Error.from_error(e)
@@ -440,7 +458,6 @@ module Google
440
458
 
441
459
  @cloud_controls_partner_core_stub.get_customer request, options do |result, operation|
442
460
  yield result, operation if block_given?
443
- return result
444
461
  end
445
462
  rescue ::Gapic::Rest::Error => e
446
463
  raise ::Google::Cloud::Error.from_error(e)
@@ -534,7 +551,6 @@ module Google
534
551
 
535
552
  @cloud_controls_partner_core_stub.list_customers request, options do |result, operation|
536
553
  yield result, operation if block_given?
537
- return result
538
554
  end
539
555
  rescue ::Gapic::Rest::Error => e
540
556
  raise ::Google::Cloud::Error.from_error(e)
@@ -614,7 +630,6 @@ module Google
614
630
 
615
631
  @cloud_controls_partner_core_stub.get_ekm_connections request, options do |result, operation|
616
632
  yield result, operation if block_given?
617
- return result
618
633
  end
619
634
  rescue ::Gapic::Rest::Error => e
620
635
  raise ::Google::Cloud::Error.from_error(e)
@@ -694,7 +709,6 @@ module Google
694
709
 
695
710
  @cloud_controls_partner_core_stub.get_partner_permissions request, options do |result, operation|
696
711
  yield result, operation if block_given?
697
- return result
698
712
  end
699
713
  rescue ::Gapic::Rest::Error => e
700
714
  raise ::Google::Cloud::Error.from_error(e)
@@ -792,7 +806,6 @@ module Google
792
806
 
793
807
  @cloud_controls_partner_core_stub.list_access_approval_requests request, options do |result, operation|
794
808
  yield result, operation if block_given?
795
- return result
796
809
  end
797
810
  rescue ::Gapic::Rest::Error => e
798
811
  raise ::Google::Cloud::Error.from_error(e)
@@ -872,7 +885,6 @@ module Google
872
885
 
873
886
  @cloud_controls_partner_core_stub.get_partner request, options do |result, operation|
874
887
  yield result, operation if block_given?
875
- return result
876
888
  end
877
889
  rescue ::Gapic::Rest::Error => e
878
890
  raise ::Google::Cloud::Error.from_error(e)
@@ -920,6 +932,13 @@ module Google
920
932
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
921
933
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
922
934
  # * (`nil`) indicating no credentials
935
+ #
936
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
937
+ # external source for authentication to Google Cloud, you must validate it before
938
+ # providing it to a Google API client library. Providing an unvalidated credential
939
+ # configuration to Google APIs can compromise the security of your systems and data.
940
+ # For more information, refer to [Validate credential configurations from external
941
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
923
942
  # @return [::Object]
924
943
  # @!attribute [rw] scope
925
944
  # The OAuth scopes
@@ -952,6 +971,11 @@ module Google
952
971
  # default endpoint URL. The default value of nil uses the environment
953
972
  # universe (usually the default "googleapis.com" universe).
954
973
  # @return [::String,nil]
974
+ # @!attribute [rw] logger
975
+ # A custom logger to use for request/response debug logging, or the value
976
+ # `:default` (the default) to construct a default logger, or `nil` to
977
+ # explicitly disable logging.
978
+ # @return [::Logger,:default,nil]
955
979
  #
956
980
  class Configuration
957
981
  extend ::Gapic::Config
@@ -973,6 +997,7 @@ module Google
973
997
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
974
998
  config_attr :quota_project, nil, ::String, nil
975
999
  config_attr :universe_domain, nil, ::String, nil
1000
+ config_attr :logger, :default, ::Logger, nil, :default
976
1001
 
977
1002
  # @private
978
1003
  def initialize parent_config = nil
@@ -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 get_workload 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: "get_workload",
93
106
  options: options
94
107
  )
95
108
  operation = ::Gapic::Rest::TransportOperation.new response
96
109
  result = ::Google::Cloud::CloudControlsPartner::V1::Workload.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
  ##
@@ -125,16 +139,18 @@ module Google
125
139
 
126
140
  response = @client_stub.make_http_request(
127
141
  verb,
128
- uri: uri,
129
- body: body || "",
130
- params: query_string_params,
142
+ uri: uri,
143
+ body: body || "",
144
+ params: query_string_params,
145
+ method_name: "list_workloads",
131
146
  options: options
132
147
  )
133
148
  operation = ::Gapic::Rest::TransportOperation.new response
134
149
  result = ::Google::Cloud::CloudControlsPartner::V1::ListWorkloadsResponse.decode_json response.body, ignore_unknown_fields: true
135
-
136
- yield result, operation if block_given?
137
- result
150
+ catch :response do
151
+ yield result, operation if block_given?
152
+ result
153
+ end
138
154
  end
139
155
 
140
156
  ##
@@ -163,16 +179,18 @@ module Google
163
179
 
164
180
  response = @client_stub.make_http_request(
165
181
  verb,
166
- uri: uri,
167
- body: body || "",
168
- params: query_string_params,
182
+ uri: uri,
183
+ body: body || "",
184
+ params: query_string_params,
185
+ method_name: "get_customer",
169
186
  options: options
170
187
  )
171
188
  operation = ::Gapic::Rest::TransportOperation.new response
172
189
  result = ::Google::Cloud::CloudControlsPartner::V1::Customer.decode_json response.body, ignore_unknown_fields: true
173
-
174
- yield result, operation if block_given?
175
- result
190
+ catch :response do
191
+ yield result, operation if block_given?
192
+ result
193
+ end
176
194
  end
177
195
 
178
196
  ##
@@ -201,16 +219,18 @@ module Google
201
219
 
202
220
  response = @client_stub.make_http_request(
203
221
  verb,
204
- uri: uri,
205
- body: body || "",
206
- params: query_string_params,
222
+ uri: uri,
223
+ body: body || "",
224
+ params: query_string_params,
225
+ method_name: "list_customers",
207
226
  options: options
208
227
  )
209
228
  operation = ::Gapic::Rest::TransportOperation.new response
210
229
  result = ::Google::Cloud::CloudControlsPartner::V1::ListCustomersResponse.decode_json response.body, ignore_unknown_fields: true
211
-
212
- yield result, operation if block_given?
213
- result
230
+ catch :response do
231
+ yield result, operation if block_given?
232
+ result
233
+ end
214
234
  end
215
235
 
216
236
  ##
@@ -239,16 +259,18 @@ module Google
239
259
 
240
260
  response = @client_stub.make_http_request(
241
261
  verb,
242
- uri: uri,
243
- body: body || "",
244
- params: query_string_params,
262
+ uri: uri,
263
+ body: body || "",
264
+ params: query_string_params,
265
+ method_name: "get_ekm_connections",
245
266
  options: options
246
267
  )
247
268
  operation = ::Gapic::Rest::TransportOperation.new response
248
269
  result = ::Google::Cloud::CloudControlsPartner::V1::EkmConnections.decode_json response.body, ignore_unknown_fields: true
249
-
250
- yield result, operation if block_given?
251
- result
270
+ catch :response do
271
+ yield result, operation if block_given?
272
+ result
273
+ end
252
274
  end
253
275
 
254
276
  ##
@@ -277,16 +299,18 @@ module Google
277
299
 
278
300
  response = @client_stub.make_http_request(
279
301
  verb,
280
- uri: uri,
281
- body: body || "",
282
- params: query_string_params,
302
+ uri: uri,
303
+ body: body || "",
304
+ params: query_string_params,
305
+ method_name: "get_partner_permissions",
283
306
  options: options
284
307
  )
285
308
  operation = ::Gapic::Rest::TransportOperation.new response
286
309
  result = ::Google::Cloud::CloudControlsPartner::V1::PartnerPermissions.decode_json response.body, ignore_unknown_fields: true
287
-
288
- yield result, operation if block_given?
289
- result
310
+ catch :response do
311
+ yield result, operation if block_given?
312
+ result
313
+ end
290
314
  end
291
315
 
292
316
  ##
@@ -315,16 +339,18 @@ module Google
315
339
 
316
340
  response = @client_stub.make_http_request(
317
341
  verb,
318
- uri: uri,
319
- body: body || "",
320
- params: query_string_params,
342
+ uri: uri,
343
+ body: body || "",
344
+ params: query_string_params,
345
+ method_name: "list_access_approval_requests",
321
346
  options: options
322
347
  )
323
348
  operation = ::Gapic::Rest::TransportOperation.new response
324
349
  result = ::Google::Cloud::CloudControlsPartner::V1::ListAccessApprovalRequestsResponse.decode_json response.body, ignore_unknown_fields: true
325
-
326
- yield result, operation if block_given?
327
- result
350
+ catch :response do
351
+ yield result, operation if block_given?
352
+ result
353
+ end
328
354
  end
329
355
 
330
356
  ##
@@ -353,16 +379,18 @@ module Google
353
379
 
354
380
  response = @client_stub.make_http_request(
355
381
  verb,
356
- uri: uri,
357
- body: body || "",
358
- params: query_string_params,
382
+ uri: uri,
383
+ body: body || "",
384
+ params: query_string_params,
385
+ method_name: "get_partner",
359
386
  options: options
360
387
  )
361
388
  operation = ::Gapic::Rest::TransportOperation.new response
362
389
  result = ::Google::Cloud::CloudControlsPartner::V1::Partner.decode_json response.body, ignore_unknown_fields: true
363
-
364
- yield result, operation if block_given?
365
- result
390
+ catch :response do
391
+ yield result, operation if block_given?
392
+ result
393
+ end
366
394
  end
367
395
 
368
396
  ##
@@ -167,8 +167,28 @@ module Google
167
167
  universe_domain: @config.universe_domain,
168
168
  channel_args: @config.channel_args,
169
169
  interceptors: @config.interceptors,
170
- channel_pool_config: @config.channel_pool
170
+ channel_pool_config: @config.channel_pool,
171
+ logger: @config.logger
171
172
  )
173
+
174
+ @cloud_controls_partner_monitoring_stub.stub_logger&.info do |entry|
175
+ entry.set_system_name
176
+ entry.set_service
177
+ entry.message = "Created client for #{entry.service}"
178
+ entry.set_credentials_fields credentials
179
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
180
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
181
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
182
+ end
183
+ end
184
+
185
+ ##
186
+ # The logger used for request/response debug logging.
187
+ #
188
+ # @return [Logger]
189
+ #
190
+ def logger
191
+ @cloud_controls_partner_monitoring_stub.logger
172
192
  end
173
193
 
174
194
  # Service calls
@@ -280,7 +300,7 @@ module Google
280
300
  @cloud_controls_partner_monitoring_stub.call_rpc :list_violations, request, options: options do |response, operation|
281
301
  response = ::Gapic::PagedEnumerable.new @cloud_controls_partner_monitoring_stub, :list_violations, request, response, operation, options
282
302
  yield response, operation if block_given?
283
- return response
303
+ throw :response, response
284
304
  end
285
305
  rescue ::GRPC::BadStatus => e
286
306
  raise ::Google::Cloud::Error.from_error(e)
@@ -367,7 +387,6 @@ module Google
367
387
 
368
388
  @cloud_controls_partner_monitoring_stub.call_rpc :get_violation, request, options: options do |response, operation|
369
389
  yield response, operation if block_given?
370
- return response
371
390
  end
372
391
  rescue ::GRPC::BadStatus => e
373
392
  raise ::Google::Cloud::Error.from_error(e)
@@ -417,6 +436,13 @@ module Google
417
436
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
418
437
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
419
438
  # * (`nil`) indicating no credentials
439
+ #
440
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
441
+ # external source for authentication to Google Cloud, you must validate it before
442
+ # providing it to a Google API client library. Providing an unvalidated credential
443
+ # configuration to Google APIs can compromise the security of your systems and data.
444
+ # For more information, refer to [Validate credential configurations from external
445
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
420
446
  # @return [::Object]
421
447
  # @!attribute [rw] scope
422
448
  # The OAuth scopes
@@ -456,6 +482,11 @@ module Google
456
482
  # default endpoint URL. The default value of nil uses the environment
457
483
  # universe (usually the default "googleapis.com" universe).
458
484
  # @return [::String,nil]
485
+ # @!attribute [rw] logger
486
+ # A custom logger to use for request/response debug logging, or the value
487
+ # `:default` (the default) to construct a default logger, or `nil` to
488
+ # explicitly disable logging.
489
+ # @return [::Logger,:default,nil]
459
490
  #
460
491
  class Configuration
461
492
  extend ::Gapic::Config
@@ -480,6 +511,7 @@ module Google
480
511
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
481
512
  config_attr :quota_project, nil, ::String, nil
482
513
  config_attr :universe_domain, nil, ::String, nil
514
+ config_attr :logger, :default, ::Logger, nil, :default
483
515
 
484
516
  # @private
485
517
  def initialize parent_config = nil
@@ -160,8 +160,28 @@ module Google
160
160
  endpoint: @config.endpoint,
161
161
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
162
162
  universe_domain: @config.universe_domain,
163
- credentials: credentials
163
+ credentials: credentials,
164
+ logger: @config.logger
164
165
  )
166
+
167
+ @cloud_controls_partner_monitoring_stub.logger(stub: true)&.info do |entry|
168
+ entry.set_system_name
169
+ entry.set_service
170
+ entry.message = "Created client for #{entry.service}"
171
+ entry.set_credentials_fields credentials
172
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
173
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
174
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
175
+ end
176
+ end
177
+
178
+ ##
179
+ # The logger used for request/response debug logging.
180
+ #
181
+ # @return [Logger]
182
+ #
183
+ def logger
184
+ @cloud_controls_partner_monitoring_stub.logger
165
185
  end
166
186
 
167
187
  # Service calls
@@ -265,7 +285,6 @@ module Google
265
285
 
266
286
  @cloud_controls_partner_monitoring_stub.list_violations request, options do |result, operation|
267
287
  yield result, operation if block_given?
268
- return result
269
288
  end
270
289
  rescue ::Gapic::Rest::Error => e
271
290
  raise ::Google::Cloud::Error.from_error(e)
@@ -345,7 +364,6 @@ module Google
345
364
 
346
365
  @cloud_controls_partner_monitoring_stub.get_violation request, options do |result, operation|
347
366
  yield result, operation if block_given?
348
- return result
349
367
  end
350
368
  rescue ::Gapic::Rest::Error => e
351
369
  raise ::Google::Cloud::Error.from_error(e)
@@ -393,6 +411,13 @@ module Google
393
411
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
394
412
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
395
413
  # * (`nil`) indicating no credentials
414
+ #
415
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
416
+ # external source for authentication to Google Cloud, you must validate it before
417
+ # providing it to a Google API client library. Providing an unvalidated credential
418
+ # configuration to Google APIs can compromise the security of your systems and data.
419
+ # For more information, refer to [Validate credential configurations from external
420
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
396
421
  # @return [::Object]
397
422
  # @!attribute [rw] scope
398
423
  # The OAuth scopes
@@ -425,6 +450,11 @@ module Google
425
450
  # default endpoint URL. The default value of nil uses the environment
426
451
  # universe (usually the default "googleapis.com" universe).
427
452
  # @return [::String,nil]
453
+ # @!attribute [rw] logger
454
+ # A custom logger to use for request/response debug logging, or the value
455
+ # `:default` (the default) to construct a default logger, or `nil` to
456
+ # explicitly disable logging.
457
+ # @return [::Logger,:default,nil]
428
458
  #
429
459
  class Configuration
430
460
  extend ::Gapic::Config
@@ -446,6 +476,7 @@ module Google
446
476
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
447
477
  config_attr :quota_project, nil, ::String, nil
448
478
  config_attr :universe_domain, nil, ::String, nil
479
+ config_attr :logger, :default, ::Logger, nil, :default
449
480
 
450
481
  # @private
451
482
  def initialize parent_config = nil
@@ -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 list_violations 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: "list_violations",
93
106
  options: options
94
107
  )
95
108
  operation = ::Gapic::Rest::TransportOperation.new response
96
109
  result = ::Google::Cloud::CloudControlsPartner::V1::ListViolationsResponse.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
  ##
@@ -125,16 +139,18 @@ module Google
125
139
 
126
140
  response = @client_stub.make_http_request(
127
141
  verb,
128
- uri: uri,
129
- body: body || "",
130
- params: query_string_params,
142
+ uri: uri,
143
+ body: body || "",
144
+ params: query_string_params,
145
+ method_name: "get_violation",
131
146
  options: options
132
147
  )
133
148
  operation = ::Gapic::Rest::TransportOperation.new response
134
149
  result = ::Google::Cloud::CloudControlsPartner::V1::Violation.decode_json response.body, ignore_unknown_fields: true
135
-
136
- yield result, operation if block_given?
137
- result
150
+ catch :response do
151
+ yield result, operation if block_given?
152
+ result
153
+ end
138
154
  end
139
155
 
140
156
  ##
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module CloudControlsPartner
23
23
  module V1
24
- VERSION = "1.1.0"
24
+ VERSION = "1.3.0"
25
25
  end
26
26
  end
27
27
  end
@@ -28,6 +28,9 @@ module Google
28
28
  # @!attribute [rw] destinations
29
29
  # @return [::Array<::Google::Api::ClientLibraryDestination>]
30
30
  # The destination where API teams want this client library to be published.
31
+ # @!attribute [rw] selective_gapic_generation
32
+ # @return [::Google::Api::SelectiveGapicGeneration]
33
+ # Configuration for which RPCs should be generated in the GAPIC client.
31
34
  class CommonLanguageSettings
32
35
  include ::Google::Protobuf::MessageExts
33
36
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -212,6 +215,12 @@ module Google
212
215
  # enabled. By default, asynchronous REST clients will not be generated.
213
216
  # This feature will be enabled by default 1 month after launching the
214
217
  # feature in preview packages.
218
+ # @!attribute [rw] protobuf_pythonic_types_enabled
219
+ # @return [::Boolean]
220
+ # Enables generation of protobuf code using new types that are more
221
+ # Pythonic which are included in `protobuf>=5.29.x`. This feature will be
222
+ # enabled by default 1 month after launching the feature in preview
223
+ # packages.
215
224
  class ExperimentalFeatures
216
225
  include ::Google::Protobuf::MessageExts
217
226
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -297,9 +306,28 @@ module Google
297
306
  # @!attribute [rw] common
298
307
  # @return [::Google::Api::CommonLanguageSettings]
299
308
  # Some settings.
309
+ # @!attribute [rw] renamed_services
310
+ # @return [::Google::Protobuf::Map{::String => ::String}]
311
+ # Map of service names to renamed services. Keys are the package relative
312
+ # service names and values are the name to be used for the service client
313
+ # and call options.
314
+ #
315
+ # publishing:
316
+ # go_settings:
317
+ # renamed_services:
318
+ # Publisher: TopicAdmin
300
319
  class GoSettings
301
320
  include ::Google::Protobuf::MessageExts
302
321
  extend ::Google::Protobuf::MessageExts::ClassMethods
322
+
323
+ # @!attribute [rw] key
324
+ # @return [::String]
325
+ # @!attribute [rw] value
326
+ # @return [::String]
327
+ class RenamedServicesEntry
328
+ include ::Google::Protobuf::MessageExts
329
+ extend ::Google::Protobuf::MessageExts::ClassMethods
330
+ end
303
331
  end
304
332
 
305
333
  # Describes the generator configuration for a method.
@@ -375,6 +403,17 @@ module Google
375
403
  end
376
404
  end
377
405
 
406
+ # This message is used to configure the generation of a subset of the RPCs in
407
+ # a service for client libraries.
408
+ # @!attribute [rw] methods
409
+ # @return [::Array<::String>]
410
+ # An allowlist of the fully qualified names of RPCs that should be included
411
+ # on public client surfaces.
412
+ class SelectiveGapicGeneration
413
+ include ::Google::Protobuf::MessageExts
414
+ extend ::Google::Protobuf::MessageExts::ClassMethods
415
+ end
416
+
378
417
  # The organization for which the client libraries are being published.
379
418
  # Affects the url where generated docs are published, etc.
380
419
  module ClientLibraryOrganization
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-cloud_controls_partner-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.0
4
+ version: 1.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-09-30 00:00:00.000000000 Z
10
+ date: 2025-01-29 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: gapic-common
@@ -16,7 +15,7 @@ dependencies:
16
15
  requirements:
17
16
  - - ">="
18
17
  - !ruby/object:Gem::Version
19
- version: 0.21.1
18
+ version: 0.25.0
20
19
  - - "<"
21
20
  - !ruby/object:Gem::Version
22
21
  version: 2.a
@@ -26,7 +25,7 @@ dependencies:
26
25
  requirements:
27
26
  - - ">="
28
27
  - !ruby/object:Gem::Version
29
- version: 0.21.1
28
+ version: 0.25.0
30
29
  - - "<"
31
30
  - !ruby/object:Gem::Version
32
31
  version: 2.a
@@ -109,7 +108,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
109
108
  licenses:
110
109
  - Apache-2.0
111
110
  metadata: {}
112
- post_install_message:
113
111
  rdoc_options: []
114
112
  require_paths:
115
113
  - lib
@@ -117,15 +115,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
117
115
  requirements:
118
116
  - - ">="
119
117
  - !ruby/object:Gem::Version
120
- version: '2.7'
118
+ version: '3.0'
121
119
  required_rubygems_version: !ruby/object:Gem::Requirement
122
120
  requirements:
123
121
  - - ">="
124
122
  - !ruby/object:Gem::Version
125
123
  version: '0'
126
124
  requirements: []
127
- rubygems_version: 3.5.6
128
- signing_key:
125
+ rubygems_version: 3.6.2
129
126
  specification_version: 4
130
127
  summary: Provides insights about your customers and their Assured Workloads based
131
128
  on your Sovereign Controls by Partners offering.