google-cloud-gsuite_add_ons-v1 1.0.0 → 1.1.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: 6e5c980dd60db8fa51ce8f202a761187a3b6777a559d2fc81eb2a2c03768b84c
4
- data.tar.gz: d88cdade2e13ced68e420b0a89010e9bb3fa8e01b721284011f75d1128ae7cc6
3
+ metadata.gz: 39ff64a30d67ded100624b0efc44438990e6749857f5d8e390ef0781a88c65dd
4
+ data.tar.gz: 532ae653372e0a73971eab397a42d2a4f7b47d7793efaff5db241d424db61117
5
5
  SHA512:
6
- metadata.gz: 9a17dda5ae5e45c1b7a16011ad96232e2b1c349111859628a7edc14da3f15e52b4109dffac169038522961b3f5ed5b71eff96ed24b74f1631d2990af8bb197cc
7
- data.tar.gz: c625950320cc2b8c7537086b53e1b38053eb44c25f592494dd054a39fe9b19fa52eeb3a2a07c0b78be50ed7aadcc21ab6c1deadcee2445e2e53837cba6a72c7d
6
+ metadata.gz: 074c4eb89d8bf0854bf72dbcda0d7496763798af41c16b13bf81e2f8b5c4dc00d14dcae9354f67ed709144341c6ce2cc82c9351ef7f46dad5d615d8e49f59c29
7
+ data.tar.gz: 40f0fd268d8df700a729517e81fdfda96a8a010445cf3d4373e2c51a1da3ee64a8913a0636e003dcd09aed1fd8b97a21421f7bdc1a2ed053f9c5accc2ac183ff
data/README.md CHANGED
@@ -43,33 +43,43 @@ for class and method documentation.
43
43
  See also the [Product Documentation](https://developers.google.com/workspace/add-ons/)
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/gsuite_add_ons/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::GSuiteAddOns::V1::GSuiteAddOns::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).
@@ -195,8 +195,28 @@ module Google
195
195
  universe_domain: @config.universe_domain,
196
196
  channel_args: @config.channel_args,
197
197
  interceptors: @config.interceptors,
198
- channel_pool_config: @config.channel_pool
198
+ channel_pool_config: @config.channel_pool,
199
+ logger: @config.logger
199
200
  )
201
+
202
+ @g_suite_add_ons_stub.stub_logger&.info do |entry|
203
+ entry.set_system_name
204
+ entry.set_service
205
+ entry.message = "Created client for #{entry.service}"
206
+ entry.set_credentials_fields credentials
207
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
208
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
209
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
210
+ end
211
+ end
212
+
213
+ ##
214
+ # The logger used for request/response debug logging.
215
+ #
216
+ # @return [Logger]
217
+ #
218
+ def logger
219
+ @g_suite_add_ons_stub.logger
200
220
  end
201
221
 
202
222
  # Service calls
@@ -284,7 +304,6 @@ module Google
284
304
 
285
305
  @g_suite_add_ons_stub.call_rpc :get_authorization, request, options: options do |response, operation|
286
306
  yield response, operation if block_given?
287
- return response
288
307
  end
289
308
  rescue ::GRPC::BadStatus => e
290
309
  raise ::Google::Cloud::Error.from_error(e)
@@ -377,7 +396,6 @@ module Google
377
396
 
378
397
  @g_suite_add_ons_stub.call_rpc :create_deployment, request, options: options do |response, operation|
379
398
  yield response, operation if block_given?
380
- return response
381
399
  end
382
400
  rescue ::GRPC::BadStatus => e
383
401
  raise ::Google::Cloud::Error.from_error(e)
@@ -463,7 +481,6 @@ module Google
463
481
 
464
482
  @g_suite_add_ons_stub.call_rpc :replace_deployment, request, options: options do |response, operation|
465
483
  yield response, operation if block_given?
466
- return response
467
484
  end
468
485
  rescue ::GRPC::BadStatus => e
469
486
  raise ::Google::Cloud::Error.from_error(e)
@@ -551,7 +568,6 @@ module Google
551
568
 
552
569
  @g_suite_add_ons_stub.call_rpc :get_deployment, request, options: options do |response, operation|
553
570
  yield response, operation if block_given?
554
- return response
555
571
  end
556
572
  rescue ::GRPC::BadStatus => e
557
573
  raise ::Google::Cloud::Error.from_error(e)
@@ -655,7 +671,7 @@ module Google
655
671
  @g_suite_add_ons_stub.call_rpc :list_deployments, request, options: options do |response, operation|
656
672
  response = ::Gapic::PagedEnumerable.new @g_suite_add_ons_stub, :list_deployments, request, response, operation, options
657
673
  yield response, operation if block_given?
658
- return response
674
+ throw :response, response
659
675
  end
660
676
  rescue ::GRPC::BadStatus => e
661
677
  raise ::Google::Cloud::Error.from_error(e)
@@ -746,7 +762,6 @@ module Google
746
762
 
747
763
  @g_suite_add_ons_stub.call_rpc :delete_deployment, request, options: options do |response, operation|
748
764
  yield response, operation if block_given?
749
- return response
750
765
  end
751
766
  rescue ::GRPC::BadStatus => e
752
767
  raise ::Google::Cloud::Error.from_error(e)
@@ -836,7 +851,6 @@ module Google
836
851
 
837
852
  @g_suite_add_ons_stub.call_rpc :install_deployment, request, options: options do |response, operation|
838
853
  yield response, operation if block_given?
839
- return response
840
854
  end
841
855
  rescue ::GRPC::BadStatus => e
842
856
  raise ::Google::Cloud::Error.from_error(e)
@@ -926,7 +940,6 @@ module Google
926
940
 
927
941
  @g_suite_add_ons_stub.call_rpc :uninstall_deployment, request, options: options do |response, operation|
928
942
  yield response, operation if block_given?
929
- return response
930
943
  end
931
944
  rescue ::GRPC::BadStatus => e
932
945
  raise ::Google::Cloud::Error.from_error(e)
@@ -1014,7 +1027,6 @@ module Google
1014
1027
 
1015
1028
  @g_suite_add_ons_stub.call_rpc :get_install_status, request, options: options do |response, operation|
1016
1029
  yield response, operation if block_given?
1017
- return response
1018
1030
  end
1019
1031
  rescue ::GRPC::BadStatus => e
1020
1032
  raise ::Google::Cloud::Error.from_error(e)
@@ -1103,6 +1115,11 @@ module Google
1103
1115
  # default endpoint URL. The default value of nil uses the environment
1104
1116
  # universe (usually the default "googleapis.com" universe).
1105
1117
  # @return [::String,nil]
1118
+ # @!attribute [rw] logger
1119
+ # A custom logger to use for request/response debug logging, or the value
1120
+ # `:default` (the default) to construct a default logger, or `nil` to
1121
+ # explicitly disable logging.
1122
+ # @return [::Logger,:default,nil]
1106
1123
  #
1107
1124
  class Configuration
1108
1125
  extend ::Gapic::Config
@@ -1127,6 +1144,7 @@ module Google
1127
1144
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1128
1145
  config_attr :quota_project, nil, ::String, nil
1129
1146
  config_attr :universe_domain, nil, ::String, nil
1147
+ config_attr :logger, :default, ::Logger, nil, :default
1130
1148
 
1131
1149
  # @private
1132
1150
  def initialize parent_config = nil
@@ -188,8 +188,28 @@ module Google
188
188
  endpoint: @config.endpoint,
189
189
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
190
190
  universe_domain: @config.universe_domain,
191
- credentials: credentials
191
+ credentials: credentials,
192
+ logger: @config.logger
192
193
  )
194
+
195
+ @g_suite_add_ons_stub.logger(stub: true)&.info do |entry|
196
+ entry.set_system_name
197
+ entry.set_service
198
+ entry.message = "Created client for #{entry.service}"
199
+ entry.set_credentials_fields credentials
200
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
201
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
202
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
203
+ end
204
+ end
205
+
206
+ ##
207
+ # The logger used for request/response debug logging.
208
+ #
209
+ # @return [Logger]
210
+ #
211
+ def logger
212
+ @g_suite_add_ons_stub.logger
193
213
  end
194
214
 
195
215
  # Service calls
@@ -270,7 +290,6 @@ module Google
270
290
 
271
291
  @g_suite_add_ons_stub.get_authorization request, options do |result, operation|
272
292
  yield result, operation if block_given?
273
- return result
274
293
  end
275
294
  rescue ::Gapic::Rest::Error => e
276
295
  raise ::Google::Cloud::Error.from_error(e)
@@ -356,7 +375,6 @@ module Google
356
375
 
357
376
  @g_suite_add_ons_stub.create_deployment request, options do |result, operation|
358
377
  yield result, operation if block_given?
359
- return result
360
378
  end
361
379
  rescue ::Gapic::Rest::Error => e
362
380
  raise ::Google::Cloud::Error.from_error(e)
@@ -435,7 +453,6 @@ module Google
435
453
 
436
454
  @g_suite_add_ons_stub.replace_deployment request, options do |result, operation|
437
455
  yield result, operation if block_given?
438
- return result
439
456
  end
440
457
  rescue ::Gapic::Rest::Error => e
441
458
  raise ::Google::Cloud::Error.from_error(e)
@@ -516,7 +533,6 @@ module Google
516
533
 
517
534
  @g_suite_add_ons_stub.get_deployment request, options do |result, operation|
518
535
  yield result, operation if block_given?
519
- return result
520
536
  end
521
537
  rescue ::Gapic::Rest::Error => e
522
538
  raise ::Google::Cloud::Error.from_error(e)
@@ -613,7 +629,7 @@ module Google
613
629
  @g_suite_add_ons_stub.list_deployments request, options do |result, operation|
614
630
  result = ::Gapic::Rest::PagedEnumerable.new @g_suite_add_ons_stub, :list_deployments, "deployments", request, result, options
615
631
  yield result, operation if block_given?
616
- return result
632
+ throw :response, result
617
633
  end
618
634
  rescue ::Gapic::Rest::Error => e
619
635
  raise ::Google::Cloud::Error.from_error(e)
@@ -697,7 +713,6 @@ module Google
697
713
 
698
714
  @g_suite_add_ons_stub.delete_deployment request, options do |result, operation|
699
715
  yield result, operation if block_given?
700
- return result
701
716
  end
702
717
  rescue ::Gapic::Rest::Error => e
703
718
  raise ::Google::Cloud::Error.from_error(e)
@@ -780,7 +795,6 @@ module Google
780
795
 
781
796
  @g_suite_add_ons_stub.install_deployment request, options do |result, operation|
782
797
  yield result, operation if block_given?
783
- return result
784
798
  end
785
799
  rescue ::Gapic::Rest::Error => e
786
800
  raise ::Google::Cloud::Error.from_error(e)
@@ -863,7 +877,6 @@ module Google
863
877
 
864
878
  @g_suite_add_ons_stub.uninstall_deployment request, options do |result, operation|
865
879
  yield result, operation if block_given?
866
- return result
867
880
  end
868
881
  rescue ::Gapic::Rest::Error => e
869
882
  raise ::Google::Cloud::Error.from_error(e)
@@ -944,7 +957,6 @@ module Google
944
957
 
945
958
  @g_suite_add_ons_stub.get_install_status request, options do |result, operation|
946
959
  yield result, operation if block_given?
947
- return result
948
960
  end
949
961
  rescue ::Gapic::Rest::Error => e
950
962
  raise ::Google::Cloud::Error.from_error(e)
@@ -1024,6 +1036,11 @@ module Google
1024
1036
  # default endpoint URL. The default value of nil uses the environment
1025
1037
  # universe (usually the default "googleapis.com" universe).
1026
1038
  # @return [::String,nil]
1039
+ # @!attribute [rw] logger
1040
+ # A custom logger to use for request/response debug logging, or the value
1041
+ # `:default` (the default) to construct a default logger, or `nil` to
1042
+ # explicitly disable logging.
1043
+ # @return [::Logger,:default,nil]
1027
1044
  #
1028
1045
  class Configuration
1029
1046
  extend ::Gapic::Config
@@ -1045,6 +1062,7 @@ module Google
1045
1062
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1046
1063
  config_attr :quota_project, nil, ::String, nil
1047
1064
  config_attr :universe_domain, nil, ::String, nil
1065
+ config_attr :logger, :default, ::Logger, nil, :default
1048
1066
 
1049
1067
  # @private
1050
1068
  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_authorization 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_authorization",
93
106
  options: options
94
107
  )
95
108
  operation = ::Gapic::Rest::TransportOperation.new response
96
109
  result = ::Google::Cloud::GSuiteAddOns::V1::Authorization.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: "create_deployment",
131
146
  options: options
132
147
  )
133
148
  operation = ::Gapic::Rest::TransportOperation.new response
134
149
  result = ::Google::Cloud::GSuiteAddOns::V1::Deployment.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: "replace_deployment",
169
186
  options: options
170
187
  )
171
188
  operation = ::Gapic::Rest::TransportOperation.new response
172
189
  result = ::Google::Cloud::GSuiteAddOns::V1::Deployment.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: "get_deployment",
207
226
  options: options
208
227
  )
209
228
  operation = ::Gapic::Rest::TransportOperation.new response
210
229
  result = ::Google::Cloud::GSuiteAddOns::V1::Deployment.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: "list_deployments",
245
266
  options: options
246
267
  )
247
268
  operation = ::Gapic::Rest::TransportOperation.new response
248
269
  result = ::Google::Cloud::GSuiteAddOns::V1::ListDeploymentsResponse.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: "delete_deployment",
283
306
  options: options
284
307
  )
285
308
  operation = ::Gapic::Rest::TransportOperation.new response
286
309
  result = ::Google::Protobuf::Empty.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: "install_deployment",
321
346
  options: options
322
347
  )
323
348
  operation = ::Gapic::Rest::TransportOperation.new response
324
349
  result = ::Google::Protobuf::Empty.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: "uninstall_deployment",
359
386
  options: options
360
387
  )
361
388
  operation = ::Gapic::Rest::TransportOperation.new response
362
389
  result = ::Google::Protobuf::Empty.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
  ##
@@ -391,16 +419,18 @@ module Google
391
419
 
392
420
  response = @client_stub.make_http_request(
393
421
  verb,
394
- uri: uri,
395
- body: body || "",
396
- params: query_string_params,
422
+ uri: uri,
423
+ body: body || "",
424
+ params: query_string_params,
425
+ method_name: "get_install_status",
397
426
  options: options
398
427
  )
399
428
  operation = ::Gapic::Rest::TransportOperation.new response
400
429
  result = ::Google::Cloud::GSuiteAddOns::V1::InstallStatus.decode_json response.body, ignore_unknown_fields: true
401
-
402
- yield result, operation if block_given?
403
- result
430
+ catch :response do
431
+ yield result, operation if block_given?
432
+ result
433
+ end
404
434
  end
405
435
 
406
436
  ##
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module GSuiteAddOns
23
23
  module V1
24
- VERSION = "1.0.0"
24
+ VERSION = "1.1.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
@@ -196,9 +199,32 @@ module Google
196
199
  # @!attribute [rw] common
197
200
  # @return [::Google::Api::CommonLanguageSettings]
198
201
  # Some settings.
202
+ # @!attribute [rw] experimental_features
203
+ # @return [::Google::Api::PythonSettings::ExperimentalFeatures]
204
+ # Experimental features to be included during client library generation.
199
205
  class PythonSettings
200
206
  include ::Google::Protobuf::MessageExts
201
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
202
228
  end
203
229
 
204
230
  # Settings for Node client libraries.
@@ -280,9 +306,28 @@ module Google
280
306
  # @!attribute [rw] common
281
307
  # @return [::Google::Api::CommonLanguageSettings]
282
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
283
319
  class GoSettings
284
320
  include ::Google::Protobuf::MessageExts
285
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
286
331
  end
287
332
 
288
333
  # Describes the generator configuration for a method.
@@ -290,6 +335,13 @@ module Google
290
335
  # @return [::String]
291
336
  # The fully qualified name of the method, for which the options below apply.
292
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...
293
345
  # @!attribute [rw] long_running
294
346
  # @return [::Google::Api::MethodSettings::LongRunning]
295
347
  # Describes settings to use for long-running operations when generating
@@ -298,17 +350,14 @@ module Google
298
350
  #
299
351
  # Example of a YAML configuration::
300
352
  #
301
- # publishing:
302
- # method_settings:
353
+ # publishing:
354
+ # method_settings:
303
355
  # - selector: google.cloud.speech.v2.Speech.BatchRecognize
304
356
  # long_running:
305
- # initial_poll_delay:
306
- # seconds: 60 # 1 minute
357
+ # initial_poll_delay: 60s # 1 minute
307
358
  # poll_delay_multiplier: 1.5
308
- # max_poll_delay:
309
- # seconds: 360 # 6 minutes
310
- # total_poll_timeout:
311
- # seconds: 54000 # 90 minutes
359
+ # max_poll_delay: 360s # 6 minutes
360
+ # total_poll_timeout: 54000s # 90 minutes
312
361
  # @!attribute [rw] auto_populated_fields
313
362
  # @return [::Array<::String>]
314
363
  # List of top-level fields of the request message, that should be
@@ -317,8 +366,8 @@ module Google
317
366
  #
318
367
  # Example of a YAML configuration:
319
368
  #
320
- # publishing:
321
- # method_settings:
369
+ # publishing:
370
+ # method_settings:
322
371
  # - selector: google.example.v1.ExampleService.CreateExample
323
372
  # auto_populated_fields:
324
373
  # - request_id
@@ -354,6 +403,17 @@ module Google
354
403
  end
355
404
  end
356
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
+
357
417
  # The organization for which the client libraries are being published.
358
418
  # Affects the url where generated docs are published, etc.
359
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
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-gsuite_add_ons-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.1.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-07-10 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
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
128
128
  - !ruby/object:Gem::Version
129
129
  version: '0'
130
130
  requirements: []
131
- rubygems_version: 3.5.6
131
+ rubygems_version: 3.5.23
132
132
  signing_key:
133
133
  specification_version: 4
134
134
  summary: API Client library for the Google Workspace Add-ons V1 API