google-cloud-os_config-v1 1.0.1 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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
+ @os_config_zonal_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
+ @os_config_zonal_service_stub.logger
197
+ end
198
+
179
199
  # Service calls
180
200
 
181
201
  ##
@@ -279,7 +299,7 @@ module Google
279
299
  @os_config_zonal_service_stub.create_os_policy_assignment request, options do |result, operation|
280
300
  result = ::Gapic::Operation.new result, @operations_client, options: options
281
301
  yield result, operation if block_given?
282
- return result
302
+ throw :response, result
283
303
  end
284
304
  rescue ::Gapic::Rest::Error => e
285
305
  raise ::Google::Cloud::Error.from_error(e)
@@ -377,7 +397,7 @@ module Google
377
397
  @os_config_zonal_service_stub.update_os_policy_assignment request, options do |result, operation|
378
398
  result = ::Gapic::Operation.new result, @operations_client, options: options
379
399
  yield result, operation if block_given?
380
- return result
400
+ throw :response, result
381
401
  end
382
402
  rescue ::Gapic::Rest::Error => e
383
403
  raise ::Google::Cloud::Error.from_error(e)
@@ -463,7 +483,6 @@ module Google
463
483
 
464
484
  @os_config_zonal_service_stub.get_os_policy_assignment request, options do |result, operation|
465
485
  yield result, operation if block_given?
466
- return result
467
486
  end
468
487
  rescue ::Gapic::Rest::Error => e
469
488
  raise ::Google::Cloud::Error.from_error(e)
@@ -555,7 +574,7 @@ module Google
555
574
  @os_config_zonal_service_stub.list_os_policy_assignments request, options do |result, operation|
556
575
  result = ::Gapic::Rest::PagedEnumerable.new @os_config_zonal_service_stub, :list_os_policy_assignments, "os_policy_assignments", request, result, options
557
576
  yield result, operation if block_given?
558
- return result
577
+ throw :response, result
559
578
  end
560
579
  rescue ::Gapic::Rest::Error => e
561
580
  raise ::Google::Cloud::Error.from_error(e)
@@ -645,7 +664,7 @@ module Google
645
664
  @os_config_zonal_service_stub.list_os_policy_assignment_revisions request, options do |result, operation|
646
665
  result = ::Gapic::Rest::PagedEnumerable.new @os_config_zonal_service_stub, :list_os_policy_assignment_revisions, "os_policy_assignments", request, result, options
647
666
  yield result, operation if block_given?
648
- return result
667
+ throw :response, result
649
668
  end
650
669
  rescue ::Gapic::Rest::Error => e
651
670
  raise ::Google::Cloud::Error.from_error(e)
@@ -743,7 +762,7 @@ module Google
743
762
  @os_config_zonal_service_stub.delete_os_policy_assignment request, options do |result, operation|
744
763
  result = ::Gapic::Operation.new result, @operations_client, options: options
745
764
  yield result, operation if block_given?
746
- return result
765
+ throw :response, result
747
766
  end
748
767
  rescue ::Gapic::Rest::Error => e
749
768
  raise ::Google::Cloud::Error.from_error(e)
@@ -831,7 +850,6 @@ module Google
831
850
 
832
851
  @os_config_zonal_service_stub.get_os_policy_assignment_report request, options do |result, operation|
833
852
  yield result, operation if block_given?
834
- return result
835
853
  end
836
854
  rescue ::Gapic::Rest::Error => e
837
855
  raise ::Google::Cloud::Error.from_error(e)
@@ -945,7 +963,7 @@ module Google
945
963
  @os_config_zonal_service_stub.list_os_policy_assignment_reports request, options do |result, operation|
946
964
  result = ::Gapic::Rest::PagedEnumerable.new @os_config_zonal_service_stub, :list_os_policy_assignment_reports, "os_policy_assignment_reports", request, result, options
947
965
  yield result, operation if block_given?
948
- return result
966
+ throw :response, result
949
967
  end
950
968
  rescue ::Gapic::Rest::Error => e
951
969
  raise ::Google::Cloud::Error.from_error(e)
@@ -1035,7 +1053,6 @@ module Google
1035
1053
 
1036
1054
  @os_config_zonal_service_stub.get_inventory request, options do |result, operation|
1037
1055
  yield result, operation if block_given?
1038
- return result
1039
1056
  end
1040
1057
  rescue ::Gapic::Rest::Error => e
1041
1058
  raise ::Google::Cloud::Error.from_error(e)
@@ -1135,7 +1152,7 @@ module Google
1135
1152
  @os_config_zonal_service_stub.list_inventories request, options do |result, operation|
1136
1153
  result = ::Gapic::Rest::PagedEnumerable.new @os_config_zonal_service_stub, :list_inventories, "inventories", request, result, options
1137
1154
  yield result, operation if block_given?
1138
- return result
1155
+ throw :response, result
1139
1156
  end
1140
1157
  rescue ::Gapic::Rest::Error => e
1141
1158
  raise ::Google::Cloud::Error.from_error(e)
@@ -1222,7 +1239,6 @@ module Google
1222
1239
 
1223
1240
  @os_config_zonal_service_stub.get_vulnerability_report request, options do |result, operation|
1224
1241
  yield result, operation if block_given?
1225
- return result
1226
1242
  end
1227
1243
  rescue ::Gapic::Rest::Error => e
1228
1244
  raise ::Google::Cloud::Error.from_error(e)
@@ -1319,7 +1335,7 @@ module Google
1319
1335
  @os_config_zonal_service_stub.list_vulnerability_reports request, options do |result, operation|
1320
1336
  result = ::Gapic::Rest::PagedEnumerable.new @os_config_zonal_service_stub, :list_vulnerability_reports, "vulnerability_reports", request, result, options
1321
1337
  yield result, operation if block_given?
1322
- return result
1338
+ throw :response, result
1323
1339
  end
1324
1340
  rescue ::Gapic::Rest::Error => e
1325
1341
  raise ::Google::Cloud::Error.from_error(e)
@@ -1367,6 +1383,13 @@ module Google
1367
1383
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
1368
1384
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
1369
1385
  # * (`nil`) indicating no credentials
1386
+ #
1387
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
1388
+ # external source for authentication to Google Cloud, you must validate it before
1389
+ # providing it to a Google API client library. Providing an unvalidated credential
1390
+ # configuration to Google APIs can compromise the security of your systems and data.
1391
+ # For more information, refer to [Validate credential configurations from external
1392
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
1370
1393
  # @return [::Object]
1371
1394
  # @!attribute [rw] scope
1372
1395
  # The OAuth scopes
@@ -1399,6 +1422,11 @@ module Google
1399
1422
  # default endpoint URL. The default value of nil uses the environment
1400
1423
  # universe (usually the default "googleapis.com" universe).
1401
1424
  # @return [::String,nil]
1425
+ # @!attribute [rw] logger
1426
+ # A custom logger to use for request/response debug logging, or the value
1427
+ # `:default` (the default) to construct a default logger, or `nil` to
1428
+ # explicitly disable logging.
1429
+ # @return [::Logger,:default,nil]
1402
1430
  #
1403
1431
  class Configuration
1404
1432
  extend ::Gapic::Config
@@ -1420,6 +1448,7 @@ module Google
1420
1448
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1421
1449
  config_attr :quota_project, nil, ::String, nil
1422
1450
  config_attr :universe_domain, nil, ::String, nil
1451
+ config_attr :logger, :default, ::Logger, nil, :default
1423
1452
 
1424
1453
  # @private
1425
1454
  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
  ##