google-cloud-network_connectivity-v1alpha1 0.9.0 → 0.10.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: 56d03e6443a27bef6c224e9a59cc27fa21f7e4df693a07a4f77ed6824492d190
4
- data.tar.gz: 455060420cb0211e4517c561ff2e2ff8efe84cc0c853a9ed685c6fc575747c44
3
+ metadata.gz: 5af647b78e2d53b04af7f987f06d4686afdb6cae9dc0c2ded7635f62366b9506
4
+ data.tar.gz: 527ef32ced046af7f1c42362cf3565b01fb50058a7b0da273fc7c76b42a738b1
5
5
  SHA512:
6
- metadata.gz: e40271a992db9c8e493ecb826de37632dece706e799893f3ba1e408851e62c5e0f064c097c94d30d7a82635e3a11ee6b550ab2b910bccfa7f7d92b962135b7e2
7
- data.tar.gz: 4ae930e22cf4588e9f1a8becc902d6f8651228255734bafa9d4be28faea4de4cc179544cc01aa64f1b12eec26dfcedc1341a12e4e92352b372562038ad6f64bc
6
+ metadata.gz: ff6a474fa29cb8744cb05bdcd989417ce1d8c28e8ebb6b318bf8480bad28989e0bd543d96f67da2bb12d2729f305c5e1dc3151abf02b170170c59f0d93c88ef3
7
+ data.tar.gz: cd20f98cde9e7b0d95699c45a1db757ee6399f83e182bf1da32560295161d20af168db478d70aa6d4bb060440ca76dce6da7de439f2bdf9d4b094b88a88a3ba7
data/README.md CHANGED
@@ -43,33 +43,43 @@ for class and method documentation.
43
43
  See also the [Product Documentation](https://cloud.google.com/network-connectivity/docs)
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/network_connectivity/v1alpha1"
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::NetworkConnectivity::V1alpha1::HubService::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).
@@ -33,6 +33,9 @@ module Google
33
33
  # model.
34
34
  #
35
35
  class Client
36
+ # @private
37
+ API_VERSION = ""
38
+
36
39
  # @private
37
40
  DEFAULT_ENDPOINT_TEMPLATE = "networkconnectivity.$UNIVERSE_DOMAIN$"
38
41
 
@@ -181,8 +184,19 @@ module Google
181
184
  universe_domain: @config.universe_domain,
182
185
  channel_args: @config.channel_args,
183
186
  interceptors: @config.interceptors,
184
- channel_pool_config: @config.channel_pool
187
+ channel_pool_config: @config.channel_pool,
188
+ logger: @config.logger
185
189
  )
190
+
191
+ @hub_service_stub.stub_logger&.info do |entry|
192
+ entry.set_system_name
193
+ entry.set_service
194
+ entry.message = "Created client for #{entry.service}"
195
+ entry.set_credentials_fields credentials
196
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
197
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
198
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
199
+ end
186
200
  end
187
201
 
188
202
  ##
@@ -192,6 +206,15 @@ module Google
192
206
  #
193
207
  attr_reader :operations_client
194
208
 
209
+ ##
210
+ # The logger used for request/response debug logging.
211
+ #
212
+ # @return [Logger]
213
+ #
214
+ def logger
215
+ @hub_service_stub.logger
216
+ end
217
+
195
218
  # Service calls
196
219
 
197
220
  ##
@@ -261,10 +284,11 @@ module Google
261
284
  # Customize the options with defaults
262
285
  metadata = @config.rpcs.list_hubs.metadata.to_h
263
286
 
264
- # Set x-goog-api-client and x-goog-user-project headers
287
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
265
288
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
266
289
  lib_name: @config.lib_name, lib_version: @config.lib_version,
267
290
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
291
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
268
292
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
269
293
 
270
294
  header_params = {}
@@ -286,7 +310,7 @@ module Google
286
310
  @hub_service_stub.call_rpc :list_hubs, request, options: options do |response, operation|
287
311
  response = ::Gapic::PagedEnumerable.new @hub_service_stub, :list_hubs, request, response, operation, options
288
312
  yield response, operation if block_given?
289
- return response
313
+ throw :response, response
290
314
  end
291
315
  rescue ::GRPC::BadStatus => e
292
316
  raise ::Google::Cloud::Error.from_error(e)
@@ -347,10 +371,11 @@ module Google
347
371
  # Customize the options with defaults
348
372
  metadata = @config.rpcs.get_hub.metadata.to_h
349
373
 
350
- # Set x-goog-api-client and x-goog-user-project headers
374
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
351
375
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
352
376
  lib_name: @config.lib_name, lib_version: @config.lib_version,
353
377
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
378
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
354
379
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
355
380
 
356
381
  header_params = {}
@@ -371,7 +396,6 @@ module Google
371
396
 
372
397
  @hub_service_stub.call_rpc :get_hub, request, options: options do |response, operation|
373
398
  yield response, operation if block_given?
374
- return response
375
399
  end
376
400
  rescue ::GRPC::BadStatus => e
377
401
  raise ::Google::Cloud::Error.from_error(e)
@@ -457,10 +481,11 @@ module Google
457
481
  # Customize the options with defaults
458
482
  metadata = @config.rpcs.create_hub.metadata.to_h
459
483
 
460
- # Set x-goog-api-client and x-goog-user-project headers
484
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
461
485
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
462
486
  lib_name: @config.lib_name, lib_version: @config.lib_version,
463
487
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
488
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
464
489
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
465
490
 
466
491
  header_params = {}
@@ -482,7 +507,7 @@ module Google
482
507
  @hub_service_stub.call_rpc :create_hub, request, options: options do |response, operation|
483
508
  response = ::Gapic::Operation.new response, @operations_client, options: options
484
509
  yield response, operation if block_given?
485
- return response
510
+ throw :response, response
486
511
  end
487
512
  rescue ::GRPC::BadStatus => e
488
513
  raise ::Google::Cloud::Error.from_error(e)
@@ -570,10 +595,11 @@ module Google
570
595
  # Customize the options with defaults
571
596
  metadata = @config.rpcs.update_hub.metadata.to_h
572
597
 
573
- # Set x-goog-api-client and x-goog-user-project headers
598
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
574
599
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
575
600
  lib_name: @config.lib_name, lib_version: @config.lib_version,
576
601
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
602
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
577
603
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
578
604
 
579
605
  header_params = {}
@@ -595,7 +621,7 @@ module Google
595
621
  @hub_service_stub.call_rpc :update_hub, request, options: options do |response, operation|
596
622
  response = ::Gapic::Operation.new response, @operations_client, options: options
597
623
  yield response, operation if block_given?
598
- return response
624
+ throw :response, response
599
625
  end
600
626
  rescue ::GRPC::BadStatus => e
601
627
  raise ::Google::Cloud::Error.from_error(e)
@@ -677,10 +703,11 @@ module Google
677
703
  # Customize the options with defaults
678
704
  metadata = @config.rpcs.delete_hub.metadata.to_h
679
705
 
680
- # Set x-goog-api-client and x-goog-user-project headers
706
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
681
707
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
682
708
  lib_name: @config.lib_name, lib_version: @config.lib_version,
683
709
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
710
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
684
711
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
685
712
 
686
713
  header_params = {}
@@ -702,7 +729,7 @@ module Google
702
729
  @hub_service_stub.call_rpc :delete_hub, request, options: options do |response, operation|
703
730
  response = ::Gapic::Operation.new response, @operations_client, options: options
704
731
  yield response, operation if block_given?
705
- return response
732
+ throw :response, response
706
733
  end
707
734
  rescue ::GRPC::BadStatus => e
708
735
  raise ::Google::Cloud::Error.from_error(e)
@@ -775,10 +802,11 @@ module Google
775
802
  # Customize the options with defaults
776
803
  metadata = @config.rpcs.list_spokes.metadata.to_h
777
804
 
778
- # Set x-goog-api-client and x-goog-user-project headers
805
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
779
806
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
780
807
  lib_name: @config.lib_name, lib_version: @config.lib_version,
781
808
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
809
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
782
810
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
783
811
 
784
812
  header_params = {}
@@ -800,7 +828,7 @@ module Google
800
828
  @hub_service_stub.call_rpc :list_spokes, request, options: options do |response, operation|
801
829
  response = ::Gapic::PagedEnumerable.new @hub_service_stub, :list_spokes, request, response, operation, options
802
830
  yield response, operation if block_given?
803
- return response
831
+ throw :response, response
804
832
  end
805
833
  rescue ::GRPC::BadStatus => e
806
834
  raise ::Google::Cloud::Error.from_error(e)
@@ -861,10 +889,11 @@ module Google
861
889
  # Customize the options with defaults
862
890
  metadata = @config.rpcs.get_spoke.metadata.to_h
863
891
 
864
- # Set x-goog-api-client and x-goog-user-project headers
892
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
865
893
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
866
894
  lib_name: @config.lib_name, lib_version: @config.lib_version,
867
895
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
896
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
868
897
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
869
898
 
870
899
  header_params = {}
@@ -885,7 +914,6 @@ module Google
885
914
 
886
915
  @hub_service_stub.call_rpc :get_spoke, request, options: options do |response, operation|
887
916
  yield response, operation if block_given?
888
- return response
889
917
  end
890
918
  rescue ::GRPC::BadStatus => e
891
919
  raise ::Google::Cloud::Error.from_error(e)
@@ -971,10 +999,11 @@ module Google
971
999
  # Customize the options with defaults
972
1000
  metadata = @config.rpcs.create_spoke.metadata.to_h
973
1001
 
974
- # Set x-goog-api-client and x-goog-user-project headers
1002
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
975
1003
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
976
1004
  lib_name: @config.lib_name, lib_version: @config.lib_version,
977
1005
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
1006
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
978
1007
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
979
1008
 
980
1009
  header_params = {}
@@ -996,7 +1025,7 @@ module Google
996
1025
  @hub_service_stub.call_rpc :create_spoke, request, options: options do |response, operation|
997
1026
  response = ::Gapic::Operation.new response, @operations_client, options: options
998
1027
  yield response, operation if block_given?
999
- return response
1028
+ throw :response, response
1000
1029
  end
1001
1030
  rescue ::GRPC::BadStatus => e
1002
1031
  raise ::Google::Cloud::Error.from_error(e)
@@ -1084,10 +1113,11 @@ module Google
1084
1113
  # Customize the options with defaults
1085
1114
  metadata = @config.rpcs.update_spoke.metadata.to_h
1086
1115
 
1087
- # Set x-goog-api-client and x-goog-user-project headers
1116
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1088
1117
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1089
1118
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1090
1119
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
1120
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1091
1121
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1092
1122
 
1093
1123
  header_params = {}
@@ -1109,7 +1139,7 @@ module Google
1109
1139
  @hub_service_stub.call_rpc :update_spoke, request, options: options do |response, operation|
1110
1140
  response = ::Gapic::Operation.new response, @operations_client, options: options
1111
1141
  yield response, operation if block_given?
1112
- return response
1142
+ throw :response, response
1113
1143
  end
1114
1144
  rescue ::GRPC::BadStatus => e
1115
1145
  raise ::Google::Cloud::Error.from_error(e)
@@ -1191,10 +1221,11 @@ module Google
1191
1221
  # Customize the options with defaults
1192
1222
  metadata = @config.rpcs.delete_spoke.metadata.to_h
1193
1223
 
1194
- # Set x-goog-api-client and x-goog-user-project headers
1224
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1195
1225
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1196
1226
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1197
1227
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
1228
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1198
1229
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1199
1230
 
1200
1231
  header_params = {}
@@ -1216,7 +1247,7 @@ module Google
1216
1247
  @hub_service_stub.call_rpc :delete_spoke, request, options: options do |response, operation|
1217
1248
  response = ::Gapic::Operation.new response, @operations_client, options: options
1218
1249
  yield response, operation if block_given?
1219
- return response
1250
+ throw :response, response
1220
1251
  end
1221
1252
  rescue ::GRPC::BadStatus => e
1222
1253
  raise ::Google::Cloud::Error.from_error(e)
@@ -1305,6 +1336,11 @@ module Google
1305
1336
  # default endpoint URL. The default value of nil uses the environment
1306
1337
  # universe (usually the default "googleapis.com" universe).
1307
1338
  # @return [::String,nil]
1339
+ # @!attribute [rw] logger
1340
+ # A custom logger to use for request/response debug logging, or the value
1341
+ # `:default` (the default) to construct a default logger, or `nil` to
1342
+ # explicitly disable logging.
1343
+ # @return [::Logger,:default,nil]
1308
1344
  #
1309
1345
  class Configuration
1310
1346
  extend ::Gapic::Config
@@ -1329,6 +1365,7 @@ module Google
1329
1365
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1330
1366
  config_attr :quota_project, nil, ::String, nil
1331
1367
  config_attr :universe_domain, nil, ::String, nil
1368
+ config_attr :logger, :default, ::Logger, nil, :default
1332
1369
 
1333
1370
  # @private
1334
1371
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module HubService
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ API_VERSION = ""
31
+
29
32
  # @private
30
33
  DEFAULT_ENDPOINT_TEMPLATE = "networkconnectivity.$UNIVERSE_DOMAIN$"
31
34
 
@@ -121,14 +124,6 @@ module Google
121
124
  # Lists operations that match the specified filter in the request. If the
122
125
  # server doesn't support this method, it returns `UNIMPLEMENTED`.
123
126
  #
124
- # NOTE: the `name` binding allows API services to override the binding
125
- # to use different resource name schemes, such as `users/*/operations`. To
126
- # override the binding, API services can add a binding such as
127
- # `"/v1/{name=users/*}/operations"` to their service configuration.
128
- # For backwards compatibility, the default name includes the operations
129
- # collection id, however overriding users must ensure the name binding
130
- # is the parent resource, without the operations collection id.
131
- #
132
127
  # @overload list_operations(request, options = nil)
133
128
  # Pass arguments to `list_operations` via a request object, either of type
134
129
  # {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
@@ -191,10 +186,11 @@ module Google
191
186
  # Customize the options with defaults
192
187
  metadata = @config.rpcs.list_operations.metadata.to_h
193
188
 
194
- # Set x-goog-api-client and x-goog-user-project headers
189
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
195
190
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
196
191
  lib_name: @config.lib_name, lib_version: @config.lib_version,
197
192
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
193
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
198
194
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
199
195
 
200
196
  header_params = {}
@@ -217,7 +213,7 @@ module Google
217
213
  wrap_lro_operation = ->(op_response) { ::Gapic::Operation.new op_response, @operations_client }
218
214
  response = ::Gapic::PagedEnumerable.new @operations_stub, :list_operations, request, response, operation, options, format_resource: wrap_lro_operation
219
215
  yield response, operation if block_given?
220
- return response
216
+ throw :response, response
221
217
  end
222
218
  rescue ::GRPC::BadStatus => e
223
219
  raise ::Google::Cloud::Error.from_error(e)
@@ -287,10 +283,11 @@ module Google
287
283
  # Customize the options with defaults
288
284
  metadata = @config.rpcs.get_operation.metadata.to_h
289
285
 
290
- # Set x-goog-api-client and x-goog-user-project headers
286
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
291
287
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
292
288
  lib_name: @config.lib_name, lib_version: @config.lib_version,
293
289
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
290
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
294
291
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
295
292
 
296
293
  header_params = {}
@@ -312,7 +309,7 @@ module Google
312
309
  @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
313
310
  response = ::Gapic::Operation.new response, @operations_client, options: options
314
311
  yield response, operation if block_given?
315
- return response
312
+ throw :response, response
316
313
  end
317
314
  rescue ::GRPC::BadStatus => e
318
315
  raise ::Google::Cloud::Error.from_error(e)
@@ -376,10 +373,11 @@ module Google
376
373
  # Customize the options with defaults
377
374
  metadata = @config.rpcs.delete_operation.metadata.to_h
378
375
 
379
- # Set x-goog-api-client and x-goog-user-project headers
376
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
380
377
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
381
378
  lib_name: @config.lib_name, lib_version: @config.lib_version,
382
379
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
380
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
383
381
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
384
382
 
385
383
  header_params = {}
@@ -400,7 +398,6 @@ module Google
400
398
 
401
399
  @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
402
400
  yield response, operation if block_given?
403
- return response
404
401
  end
405
402
  rescue ::GRPC::BadStatus => e
406
403
  raise ::Google::Cloud::Error.from_error(e)
@@ -415,8 +412,9 @@ module Google
415
412
  # other methods to check whether the cancellation succeeded or whether the
416
413
  # operation completed despite cancellation. On successful cancellation,
417
414
  # the operation is not deleted; instead, it becomes an operation with
418
- # an {::Google::Longrunning::Operation#error Operation.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
419
- # 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`.
420
418
  #
421
419
  # @overload cancel_operation(request, options = nil)
422
420
  # Pass arguments to `cancel_operation` via a request object, either of type
@@ -470,10 +468,11 @@ module Google
470
468
  # Customize the options with defaults
471
469
  metadata = @config.rpcs.cancel_operation.metadata.to_h
472
470
 
473
- # Set x-goog-api-client and x-goog-user-project headers
471
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
474
472
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
475
473
  lib_name: @config.lib_name, lib_version: @config.lib_version,
476
474
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
475
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
477
476
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
478
477
 
479
478
  header_params = {}
@@ -494,7 +493,6 @@ module Google
494
493
 
495
494
  @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
496
495
  yield response, operation if block_given?
497
- return response
498
496
  end
499
497
  rescue ::GRPC::BadStatus => e
500
498
  raise ::Google::Cloud::Error.from_error(e)
@@ -574,10 +572,11 @@ module Google
574
572
  # Customize the options with defaults
575
573
  metadata = @config.rpcs.wait_operation.metadata.to_h
576
574
 
577
- # Set x-goog-api-client and x-goog-user-project headers
575
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
578
576
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
579
577
  lib_name: @config.lib_name, lib_version: @config.lib_version,
580
578
  gapic_version: ::Google::Cloud::NetworkConnectivity::V1alpha1::VERSION
579
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
581
580
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
582
581
 
583
582
  options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
@@ -591,7 +590,7 @@ module Google
591
590
  @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
592
591
  response = ::Gapic::Operation.new response, @operations_client, options: options
593
592
  yield response, operation if block_given?
594
- return response
593
+ throw :response, response
595
594
  end
596
595
  rescue ::GRPC::BadStatus => e
597
596
  raise ::Google::Cloud::Error.from_error(e)
@@ -680,6 +679,11 @@ module Google
680
679
  # default endpoint URL. The default value of nil uses the environment
681
680
  # universe (usually the default "googleapis.com" universe).
682
681
  # @return [::String,nil]
682
+ # @!attribute [rw] logger
683
+ # A custom logger to use for request/response debug logging, or the value
684
+ # `:default` (the default) to construct a default logger, or `nil` to
685
+ # explicitly disable logging.
686
+ # @return [::Logger,:default,nil]
683
687
  #
684
688
  class Configuration
685
689
  extend ::Gapic::Config
@@ -704,6 +708,7 @@ module Google
704
708
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
705
709
  config_attr :quota_project, nil, ::String, nil
706
710
  config_attr :universe_domain, nil, ::String, nil
711
+ config_attr :logger, :default, ::Logger, nil, :default
707
712
 
708
713
  # @private
709
714
  def initialize parent_config = nil
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module NetworkConnectivity
23
23
  module V1alpha1
24
- VERSION = "0.9.0"
24
+ VERSION = "0.10.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
@@ -118,6 +121,10 @@ module Google
118
121
  # @return [::String]
119
122
  # Optional link to proto reference documentation. Example:
120
123
  # https://cloud.google.com/pubsub/lite/docs/reference/rpc
124
+ # @!attribute [rw] rest_reference_documentation_uri
125
+ # @return [::String]
126
+ # Optional link to REST reference documentation. Example:
127
+ # https://cloud.google.com/pubsub/lite/docs/reference/rest
121
128
  class Publishing
122
129
  include ::Google::Protobuf::MessageExts
123
130
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -192,9 +199,32 @@ module Google
192
199
  # @!attribute [rw] common
193
200
  # @return [::Google::Api::CommonLanguageSettings]
194
201
  # Some settings.
202
+ # @!attribute [rw] experimental_features
203
+ # @return [::Google::Api::PythonSettings::ExperimentalFeatures]
204
+ # Experimental features to be included during client library generation.
195
205
  class PythonSettings
196
206
  include ::Google::Protobuf::MessageExts
197
207
  extend ::Google::Protobuf::MessageExts::ClassMethods
208
+
209
+ # Experimental features to be included during client library generation.
210
+ # These fields will be deprecated once the feature graduates and is enabled
211
+ # by default.
212
+ # @!attribute [rw] rest_async_io_enabled
213
+ # @return [::Boolean]
214
+ # Enables generation of asynchronous REST clients if `rest` transport is
215
+ # enabled. By default, asynchronous REST clients will not be generated.
216
+ # This feature will be enabled by default 1 month after launching the
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.
224
+ class ExperimentalFeatures
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
198
228
  end
199
229
 
200
230
  # Settings for Node client libraries.
@@ -276,9 +306,28 @@ module Google
276
306
  # @!attribute [rw] common
277
307
  # @return [::Google::Api::CommonLanguageSettings]
278
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
279
319
  class GoSettings
280
320
  include ::Google::Protobuf::MessageExts
281
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
282
331
  end
283
332
 
284
333
  # Describes the generator configuration for a method.
@@ -286,6 +335,13 @@ module Google
286
335
  # @return [::String]
287
336
  # The fully qualified name of the method, for which the options below apply.
288
337
  # This is used to find the method to apply the options.
338
+ #
339
+ # Example:
340
+ #
341
+ # publishing:
342
+ # method_settings:
343
+ # - selector: google.storage.control.v2.StorageControl.CreateFolder
344
+ # # method settings for CreateFolder...
289
345
  # @!attribute [rw] long_running
290
346
  # @return [::Google::Api::MethodSettings::LongRunning]
291
347
  # Describes settings to use for long-running operations when generating
@@ -294,17 +350,14 @@ module Google
294
350
  #
295
351
  # Example of a YAML configuration::
296
352
  #
297
- # publishing:
298
- # method_settings:
353
+ # publishing:
354
+ # method_settings:
299
355
  # - selector: google.cloud.speech.v2.Speech.BatchRecognize
300
356
  # long_running:
301
- # initial_poll_delay:
302
- # seconds: 60 # 1 minute
357
+ # initial_poll_delay: 60s # 1 minute
303
358
  # poll_delay_multiplier: 1.5
304
- # max_poll_delay:
305
- # seconds: 360 # 6 minutes
306
- # total_poll_timeout:
307
- # seconds: 54000 # 90 minutes
359
+ # max_poll_delay: 360s # 6 minutes
360
+ # total_poll_timeout: 54000s # 90 minutes
308
361
  # @!attribute [rw] auto_populated_fields
309
362
  # @return [::Array<::String>]
310
363
  # List of top-level fields of the request message, that should be
@@ -313,8 +366,8 @@ module Google
313
366
  #
314
367
  # Example of a YAML configuration:
315
368
  #
316
- # publishing:
317
- # method_settings:
369
+ # publishing:
370
+ # method_settings:
318
371
  # - selector: google.example.v1.ExampleService.CreateExample
319
372
  # auto_populated_fields:
320
373
  # - request_id
@@ -350,6 +403,17 @@ module Google
350
403
  end
351
404
  end
352
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
+
353
417
  # The organization for which the client libraries are being published.
354
418
  # Affects the url where generated docs are published, etc.
355
419
  module ClientLibraryOrganization
@@ -124,8 +124,13 @@ module Google
124
124
  # @return [::String]
125
125
  # The plural name used in the resource name and permission names, such as
126
126
  # 'projects' for the resource name of 'projects/\\{project}' and the permission
127
- # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
128
- # concept of the `plural` field in k8s CRD spec
127
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
128
+ # to this is for Nested Collections that have stuttering names, as defined
129
+ # in [AIP-122](https://google.aip.dev/122#nested-collections), where the
130
+ # collection ID in the resource name pattern does not necessarily directly
131
+ # match the `plural` value.
132
+ #
133
+ # It is the same concept of the `plural` field in k8s CRD spec
129
134
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
130
135
  #
131
136
  # Note: The plural form is required even for singleton resources. See
@@ -42,7 +42,7 @@ module Google
42
42
  # The error result of the operation in case of failure or cancellation.
43
43
  # @!attribute [rw] response
44
44
  # @return [::Google::Protobuf::Any]
45
- # The normal response of the operation in case of success. If the original
45
+ # The normal, successful response of the operation. If the original
46
46
  # method returns no data on success, such as `Delete`, the response is
47
47
  # `google.protobuf.Empty`. If the original method is standard
48
48
  # `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -55,7 +55,8 @@ module Google
55
55
  extend ::Google::Protobuf::MessageExts::ClassMethods
56
56
  end
57
57
 
58
- # The request message for Operations.GetOperation.
58
+ # The request message for
59
+ # Operations.GetOperation.
59
60
  # @!attribute [rw] name
60
61
  # @return [::String]
61
62
  # The name of the operation resource.
@@ -64,7 +65,8 @@ module Google
64
65
  extend ::Google::Protobuf::MessageExts::ClassMethods
65
66
  end
66
67
 
67
- # The request message for Operations.ListOperations.
68
+ # The request message for
69
+ # Operations.ListOperations.
68
70
  # @!attribute [rw] name
69
71
  # @return [::String]
70
72
  # The name of the operation's parent resource.
@@ -82,7 +84,8 @@ module Google
82
84
  extend ::Google::Protobuf::MessageExts::ClassMethods
83
85
  end
84
86
 
85
- # The response message for Operations.ListOperations.
87
+ # The response message for
88
+ # Operations.ListOperations.
86
89
  # @!attribute [rw] operations
87
90
  # @return [::Array<::Google::Longrunning::Operation>]
88
91
  # A list of operations that matches the specified filter in the request.
@@ -94,7 +97,8 @@ module Google
94
97
  extend ::Google::Protobuf::MessageExts::ClassMethods
95
98
  end
96
99
 
97
- # The request message for Operations.CancelOperation.
100
+ # The request message for
101
+ # Operations.CancelOperation.
98
102
  # @!attribute [rw] name
99
103
  # @return [::String]
100
104
  # The name of the operation resource to be cancelled.
@@ -103,7 +107,8 @@ module Google
103
107
  extend ::Google::Protobuf::MessageExts::ClassMethods
104
108
  end
105
109
 
106
- # The request message for Operations.DeleteOperation.
110
+ # The request message for
111
+ # Operations.DeleteOperation.
107
112
  # @!attribute [rw] name
108
113
  # @return [::String]
109
114
  # The name of the operation resource to be deleted.
@@ -112,7 +117,8 @@ module Google
112
117
  extend ::Google::Protobuf::MessageExts::ClassMethods
113
118
  end
114
119
 
115
- # The request message for Operations.WaitOperation.
120
+ # The request message for
121
+ # Operations.WaitOperation.
116
122
  # @!attribute [rw] name
117
123
  # @return [::String]
118
124
  # The name of the operation resource to wait on.
@@ -130,13 +136,12 @@ module Google
130
136
  #
131
137
  # Example:
132
138
  #
133
- # rpc LongRunningRecognize(LongRunningRecognizeRequest)
134
- # returns (google.longrunning.Operation) {
135
- # option (google.longrunning.operation_info) = {
136
- # response_type: "LongRunningRecognizeResponse"
137
- # metadata_type: "LongRunningRecognizeMetadata"
138
- # };
139
- # }
139
+ # rpc Export(ExportRequest) returns (google.longrunning.Operation) {
140
+ # option (google.longrunning.operation_info) = {
141
+ # response_type: "ExportResponse"
142
+ # metadata_type: "ExportMetadata"
143
+ # };
144
+ # }
140
145
  # @!attribute [rw] response_type
141
146
  # @return [::String]
142
147
  # Required. The message name of the primary return type for this
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-network_connectivity-v1alpha1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.9.0
4
+ version: 0.10.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-02-26 00:00:00.000000000 Z
11
+ date: 2024-12-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.21.1
19
+ version: 0.24.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.21.1
29
+ version: 0.24.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
103
103
  - !ruby/object:Gem::Version
104
104
  version: '0'
105
105
  requirements: []
106
- rubygems_version: 3.5.6
106
+ rubygems_version: 3.5.23
107
107
  signing_key:
108
108
  specification_version: 4
109
109
  summary: The Network Connectivity API will be home to various services which provide