google-apps-events-subscriptions-v1 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (12) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +30 -20
  3. data/lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb +47 -13
  4. data/lib/google/apps/events/subscriptions/v1/subscriptions_service/operations.rb +25 -20
  5. data/lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/client.rb +47 -13
  6. data/lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/operations.rb +54 -42
  7. data/lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/service_stub.rb +62 -38
  8. data/lib/google/apps/events/subscriptions/v1/version.rb +1 -1
  9. data/proto_docs/google/api/client.rb +70 -10
  10. data/proto_docs/google/api/resource.rb +7 -2
  11. data/proto_docs/google/longrunning/operations.rb +19 -14
  12. metadata +5 -5
data/lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/operations.rb CHANGED
@@ -27,6 +27,9 @@ module Google
27
27
  module Rest
28
28
  # Service that implements Longrunning Operations API.
29
29
  class Operations
30
+ # @private
31
+ API_VERSION = ""
32
+
30
33
  # @private
31
34
  DEFAULT_ENDPOINT_TEMPLATE = "workspaceevents.$UNIVERSE_DOMAIN$"
32
35
 
@@ -113,14 +116,6 @@ module Google
113
116
  # Lists operations that match the specified filter in the request. If the
114
117
  # server doesn't support this method, it returns `UNIMPLEMENTED`.
115
118
  #
116
- # NOTE: the `name` binding allows API services to override the binding
117
- # to use different resource name schemes, such as `users/*/operations`. To
118
- # override the binding, API services can add a binding such as
119
- # `"/v1/{name=users/*}/operations"` to their service configuration.
120
- # For backwards compatibility, the default name includes the operations
121
- # collection id, however overriding users must ensure the name binding
122
- # is the parent resource, without the operations collection id.
123
- #
124
119
  # @overload list_operations(request, options = nil)
125
120
  # Pass arguments to `list_operations` via a request object, either of type
126
121
  # {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
@@ -182,12 +177,13 @@ module Google
182
177
  # Customize the options with defaults
183
178
  call_metadata = @config.rpcs.list_operations.metadata.to_h
184
179
 
185
- # Set x-goog-api-client and x-goog-user-project headers
180
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
186
181
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
187
182
  lib_name: @config.lib_name, lib_version: @config.lib_version,
188
183
  gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION,
189
184
  transports_version_send: [:rest]
190
185
 
186
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
191
187
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
192
188
 
193
189
  options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
@@ -201,7 +197,7 @@ module Google
201
197
  @operations_stub.list_operations request, options do |result, operation|
202
198
  result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", request, result, options
203
199
  yield result, operation if block_given?
204
- return result
200
+ throw :response, result
205
201
  end
206
202
  rescue ::Gapic::Rest::Error => e
207
203
  raise ::Google::Cloud::Error.from_error(e)
@@ -270,12 +266,13 @@ module Google
270
266
  # Customize the options with defaults
271
267
  call_metadata = @config.rpcs.get_operation.metadata.to_h
272
268
 
273
- # Set x-goog-api-client and x-goog-user-project headers
269
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
274
270
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
275
271
  lib_name: @config.lib_name, lib_version: @config.lib_version,
276
272
  gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION,
277
273
  transports_version_send: [:rest]
278
274
 
275
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
279
276
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
280
277
 
281
278
  options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
@@ -289,7 +286,7 @@ module Google
289
286
  @operations_stub.get_operation request, options do |result, operation|
290
287
  result = ::Gapic::Operation.new result, @operations_client, options: options
291
288
  yield result, operation if block_given?
292
- return result
289
+ throw :response, result
293
290
  end
294
291
  rescue ::Gapic::Rest::Error => e
295
292
  raise ::Google::Cloud::Error.from_error(e)
@@ -352,12 +349,13 @@ module Google
352
349
  # Customize the options with defaults
353
350
  call_metadata = @config.rpcs.delete_operation.metadata.to_h
354
351
 
355
- # Set x-goog-api-client and x-goog-user-project headers
352
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
356
353
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
357
354
  lib_name: @config.lib_name, lib_version: @config.lib_version,
358
355
  gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION,
359
356
  transports_version_send: [:rest]
360
357
 
358
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
361
359
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
362
360
 
363
361
  options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
@@ -370,7 +368,6 @@ module Google
370
368
 
371
369
  @operations_stub.delete_operation request, options do |result, operation|
372
370
  yield result, operation if block_given?
373
- return result
374
371
  end
375
372
  rescue ::Gapic::Rest::Error => e
376
373
  raise ::Google::Cloud::Error.from_error(e)
@@ -385,8 +382,9 @@ module Google
385
382
  # other methods to check whether the cancellation succeeded or whether the
386
383
  # operation completed despite cancellation. On successful cancellation,
387
384
  # the operation is not deleted; instead, it becomes an operation with
388
- # an {::Google::Longrunning::Operation#error Operation.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
389
- # corresponding to `Code.CANCELLED`.
385
+ # an {::Google::Longrunning::Operation#error Operation.error} value with a
386
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
387
+ # `Code.CANCELLED`.
390
388
  #
391
389
  # @overload cancel_operation(request, options = nil)
392
390
  # Pass arguments to `cancel_operation` via a request object, either of type
@@ -439,12 +437,13 @@ module Google
439
437
  # Customize the options with defaults
440
438
  call_metadata = @config.rpcs.cancel_operation.metadata.to_h
441
439
 
442
- # Set x-goog-api-client and x-goog-user-project headers
440
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
443
441
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
444
442
  lib_name: @config.lib_name, lib_version: @config.lib_version,
445
443
  gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION,
446
444
  transports_version_send: [:rest]
447
445
 
446
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
448
447
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
449
448
 
450
449
  options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
@@ -457,7 +456,6 @@ module Google
457
456
 
458
457
  @operations_stub.cancel_operation request, options do |result, operation|
459
458
  yield result, operation if block_given?
460
- return result
461
459
  end
462
460
  rescue ::Gapic::Rest::Error => e
463
461
  raise ::Google::Cloud::Error.from_error(e)
@@ -537,6 +535,11 @@ module Google
537
535
  # default endpoint URL. The default value of nil uses the environment
538
536
  # universe (usually the default "googleapis.com" universe).
539
537
  # @return [::String,nil]
538
+ # @!attribute [rw] logger
539
+ # A custom logger to use for request/response debug logging, or the value
540
+ # `:default` (the default) to construct a default logger, or `nil` to
541
+ # explicitly disable logging.
542
+ # @return [::Logger,:default,nil]
540
543
  #
541
544
  class Configuration
542
545
  extend ::Gapic::Config
@@ -558,6 +561,7 @@ module Google
558
561
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
559
562
  config_attr :quota_project, nil, ::String, nil
560
563
  config_attr :universe_domain, nil, ::String, nil
564
+ config_attr :logger, :default, ::Logger, nil, :default
561
565
 
562
566
  # @private
563
567
  def initialize parent_config = nil
@@ -677,16 +681,18 @@ module Google
677
681
 
678
682
  response = @client_stub.make_http_request(
679
683
  verb,
680
- uri: uri,
681
- body: body || "",
682
- params: query_string_params,
684
+ uri: uri,
685
+ body: body || "",
686
+ params: query_string_params,
687
+ method_name: "list_operations",
683
688
  options: options
684
689
  )
685
690
  operation = ::Gapic::Rest::TransportOperation.new response
686
691
  result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
687
-
688
- yield result, operation if block_given?
689
- result
692
+ catch :response do
693
+ yield result, operation if block_given?
694
+ result
695
+ end
690
696
  end
691
697
 
692
698
  ##
@@ -715,16 +721,18 @@ module Google
715
721
 
716
722
  response = @client_stub.make_http_request(
717
723
  verb,
718
- uri: uri,
719
- body: body || "",
720
- params: query_string_params,
724
+ uri: uri,
725
+ body: body || "",
726
+ params: query_string_params,
727
+ method_name: "get_operation",
721
728
  options: options
722
729
  )
723
730
  operation = ::Gapic::Rest::TransportOperation.new response
724
731
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
725
-
726
- yield result, operation if block_given?
727
- result
732
+ catch :response do
733
+ yield result, operation if block_given?
734
+ result
735
+ end
728
736
  end
729
737
 
730
738
  ##
@@ -753,16 +761,18 @@ module Google
753
761
 
754
762
  response = @client_stub.make_http_request(
755
763
  verb,
756
- uri: uri,
757
- body: body || "",
758
- params: query_string_params,
764
+ uri: uri,
765
+ body: body || "",
766
+ params: query_string_params,
767
+ method_name: "delete_operation",
759
768
  options: options
760
769
  )
761
770
  operation = ::Gapic::Rest::TransportOperation.new response
762
771
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
763
-
764
- yield result, operation if block_given?
765
- result
772
+ catch :response do
773
+ yield result, operation if block_given?
774
+ result
775
+ end
766
776
  end
767
777
 
768
778
  ##
@@ -791,16 +801,18 @@ module Google
791
801
 
792
802
  response = @client_stub.make_http_request(
793
803
  verb,
794
- uri: uri,
795
- body: body || "",
796
- params: query_string_params,
804
+ uri: uri,
805
+ body: body || "",
806
+ params: query_string_params,
807
+ method_name: "cancel_operation",
797
808
  options: options
798
809
  )
799
810
  operation = ::Gapic::Rest::TransportOperation.new response
800
811
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
801
-
802
- yield result, operation if block_given?
803
- result
812
+ catch :response do
813
+ yield result, operation if block_given?
814
+ result
815
+ end
804
816
  end
805
817
 
806
818
  ##
data/lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/service_stub.rb CHANGED
@@ -31,7 +31,8 @@ module Google
31
31
  # including transcoding, making the REST call, and deserialing the response.
32
32
  #
33
33
  class ServiceStub
34
- def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
+ # @private
35
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
35
36
  # These require statements are intentionally placed here to initialize
36
37
  # the REST modules only when it's required.
37
38
  require "gapic/rest"
@@ -41,7 +42,9 @@ module Google
41
42
  universe_domain: universe_domain,
42
43
  credentials: credentials,
43
44
  numeric_enums: true,
44
- raise_faraday_errors: false
45
+ service_name: self.class,
46
+ raise_faraday_errors: false,
47
+ logger: logger
45
48
  end
46
49
 
47
50
  ##
@@ -62,6 +65,15 @@ module Google
62
65
  @client_stub.endpoint
63
66
  end
64
67
 
68
+ ##
69
+ # The logger used for request/response debug logging.
70
+ #
71
+ # @return [Logger]
72
+ #
73
+ def logger stub: false
74
+ stub ? @client_stub.stub_logger : @client_stub.logger
75
+ end
76
+
65
77
  ##
66
78
  # Baseline implementation for the create_subscription REST call
67
79
  #
@@ -88,16 +100,18 @@ module Google
88
100
 
89
101
  response = @client_stub.make_http_request(
90
102
  verb,
91
- uri: uri,
92
- body: body || "",
93
- params: query_string_params,
103
+ uri: uri,
104
+ body: body || "",
105
+ params: query_string_params,
106
+ method_name: "create_subscription",
94
107
  options: options
95
108
  )
96
109
  operation = ::Gapic::Rest::TransportOperation.new response
97
110
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
98
-
99
- yield result, operation if block_given?
100
- result
111
+ catch :response do
112
+ yield result, operation if block_given?
113
+ result
114
+ end
101
115
  end
102
116
 
103
117
  ##
@@ -126,16 +140,18 @@ module Google
126
140
 
127
141
  response = @client_stub.make_http_request(
128
142
  verb,
129
- uri: uri,
130
- body: body || "",
131
- params: query_string_params,
143
+ uri: uri,
144
+ body: body || "",
145
+ params: query_string_params,
146
+ method_name: "delete_subscription",
132
147
  options: options
133
148
  )
134
149
  operation = ::Gapic::Rest::TransportOperation.new response
135
150
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
136
-
137
- yield result, operation if block_given?
138
- result
151
+ catch :response do
152
+ yield result, operation if block_given?
153
+ result
154
+ end
139
155
  end
140
156
 
141
157
  ##
@@ -164,16 +180,18 @@ module Google
164
180
 
165
181
  response = @client_stub.make_http_request(
166
182
  verb,
167
- uri: uri,
168
- body: body || "",
169
- params: query_string_params,
183
+ uri: uri,
184
+ body: body || "",
185
+ params: query_string_params,
186
+ method_name: "get_subscription",
170
187
  options: options
171
188
  )
172
189
  operation = ::Gapic::Rest::TransportOperation.new response
173
190
  result = ::Google::Apps::Events::Subscriptions::V1::Subscription.decode_json response.body, ignore_unknown_fields: true
174
-
175
- yield result, operation if block_given?
176
- result
191
+ catch :response do
192
+ yield result, operation if block_given?
193
+ result
194
+ end
177
195
  end
178
196
 
179
197
  ##
@@ -202,16 +220,18 @@ module Google
202
220
 
203
221
  response = @client_stub.make_http_request(
204
222
  verb,
205
- uri: uri,
206
- body: body || "",
207
- params: query_string_params,
223
+ uri: uri,
224
+ body: body || "",
225
+ params: query_string_params,
226
+ method_name: "list_subscriptions",
208
227
  options: options
209
228
  )
210
229
  operation = ::Gapic::Rest::TransportOperation.new response
211
230
  result = ::Google::Apps::Events::Subscriptions::V1::ListSubscriptionsResponse.decode_json response.body, ignore_unknown_fields: true
212
-
213
- yield result, operation if block_given?
214
- result
231
+ catch :response do
232
+ yield result, operation if block_given?
233
+ result
234
+ end
215
235
  end
216
236
 
217
237
  ##
@@ -240,16 +260,18 @@ module Google
240
260
 
241
261
  response = @client_stub.make_http_request(
242
262
  verb,
243
- uri: uri,
244
- body: body || "",
245
- params: query_string_params,
263
+ uri: uri,
264
+ body: body || "",
265
+ params: query_string_params,
266
+ method_name: "update_subscription",
246
267
  options: options
247
268
  )
248
269
  operation = ::Gapic::Rest::TransportOperation.new response
249
270
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
250
-
251
- yield result, operation if block_given?
252
- result
271
+ catch :response do
272
+ yield result, operation if block_given?
273
+ result
274
+ end
253
275
  end
254
276
 
255
277
  ##
@@ -278,16 +300,18 @@ module Google
278
300
 
279
301
  response = @client_stub.make_http_request(
280
302
  verb,
281
- uri: uri,
282
- body: body || "",
283
- params: query_string_params,
303
+ uri: uri,
304
+ body: body || "",
305
+ params: query_string_params,
306
+ method_name: "reactivate_subscription",
284
307
  options: options
285
308
  )
286
309
  operation = ::Gapic::Rest::TransportOperation.new response
287
310
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
288
-
289
- yield result, operation if block_given?
290
- result
311
+ catch :response do
312
+ yield result, operation if block_given?
313
+ result
314
+ end
291
315
  end
292
316
 
293
317
  ##
data/lib/google/apps/events/subscriptions/v1/version.rb CHANGED
@@ -22,7 +22,7 @@ module Google
22
22
  module Events
23
23
  module Subscriptions
24
24
  module V1
25
- VERSION = "0.1.0"
25
+ VERSION = "0.2.0"
26
26
  end
27
27
  end
28
28
  end
data/proto_docs/google/api/client.rb CHANGED
@@ -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
data/proto_docs/google/api/resource.rb CHANGED
@@ -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