google-cloud-cloud_quotas-v1 0.a → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (30) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +144 -8
  5. data/lib/google/api/cloudquotas/v1/cloudquotas_pb.rb +58 -0
  6. data/lib/google/api/cloudquotas/v1/cloudquotas_services_pb.rb +62 -0
  7. data/lib/google/api/cloudquotas/v1/resources_pb.rb +58 -0
  8. data/lib/google/cloud/cloud_quotas/v1/cloud_quotas/client.rb +1002 -0
  9. data/lib/google/cloud/cloud_quotas/v1/cloud_quotas/credentials.rb +47 -0
  10. data/lib/google/cloud/cloud_quotas/v1/cloud_quotas/paths.rb +265 -0
  11. data/lib/google/cloud/cloud_quotas/v1/cloud_quotas/rest/client.rb +933 -0
  12. data/lib/google/cloud/cloud_quotas/v1/cloud_quotas/rest/service_stub.rb +504 -0
  13. data/lib/google/cloud/cloud_quotas/v1/cloud_quotas/rest.rb +58 -0
  14. data/lib/google/cloud/cloud_quotas/v1/cloud_quotas.rb +61 -0
  15. data/lib/google/cloud/cloud_quotas/v1/rest.rb +37 -0
  16. data/lib/google/cloud/cloud_quotas/v1/version.rb +7 -2
  17. data/lib/google/cloud/cloud_quotas/v1.rb +45 -0
  18. data/lib/google-cloud-cloud_quotas-v1.rb +21 -0
  19. data/proto_docs/README.md +4 -0
  20. data/proto_docs/google/api/client.rb +395 -0
  21. data/proto_docs/google/api/cloudquotas/v1/cloudquotas.rb +196 -0
  22. data/proto_docs/google/api/cloudquotas/v1/resources.rb +332 -0
  23. data/proto_docs/google/api/field_behavior.rb +85 -0
  24. data/proto_docs/google/api/launch_stage.rb +71 -0
  25. data/proto_docs/google/api/resource.rb +222 -0
  26. data/proto_docs/google/protobuf/duration.rb +98 -0
  27. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  28. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  29. data/proto_docs/google/protobuf/wrappers.rb +121 -0
  30. metadata +184 -10
@@ -1,10 +1,12 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # Copyright 2024 Google LLC
2
4
  #
3
5
  # Licensed under the Apache License, Version 2.0 (the "License");
4
6
  # you may not use this file except in compliance with the License.
5
7
  # You may obtain a copy of the License at
6
8
  #
7
- # http://www.apache.org/licenses/LICENSE-2.0
9
+ # https://www.apache.org/licenses/LICENSE-2.0
8
10
  #
9
11
  # Unless required by applicable law or agreed to in writing, software
10
12
  # distributed under the License is distributed on an "AS IS" BASIS,
@@ -12,11 +14,14 @@
12
14
  # See the License for the specific language governing permissions and
13
15
  # limitations under the License.
14
16
 
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
15
20
  module Google
16
21
  module Cloud
17
22
  module CloudQuotas
18
23
  module V1
19
- VERSION = "0.a"
24
+ VERSION = "0.2.0"
20
25
  end
21
26
  end
22
27
  end
@@ -0,0 +1,45 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/cloud/cloud_quotas/v1/cloud_quotas"
20
+ require "google/cloud/cloud_quotas/v1/version"
21
+
22
+ module Google
23
+ module Cloud
24
+ module CloudQuotas
25
+ ##
26
+ # API client module.
27
+ #
28
+ # @example Load this package, including all its services, and instantiate a gRPC client
29
+ #
30
+ # require "google/cloud/cloud_quotas/v1"
31
+ # client = ::Google::Cloud::CloudQuotas::V1::CloudQuotas::Client.new
32
+ #
33
+ # @example Load this package, including all its services, and instantiate a REST client
34
+ #
35
+ # require "google/cloud/cloud_quotas/v1"
36
+ # client = ::Google::Cloud::CloudQuotas::V1::CloudQuotas::Rest::Client.new
37
+ #
38
+ module V1
39
+ end
40
+ end
41
+ end
42
+ end
43
+
44
+ helper_path = ::File.join __dir__, "v1", "_helpers.rb"
45
+ require "google/cloud/cloud_quotas/v1/_helpers" if ::File.file? helper_path
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ # This gem does not autoload during Bundler.require. To load this gem,
20
+ # issue explicit require statements for the packages desired, e.g.:
21
+ # require "google/cloud/cloud_quotas/v1"
@@ -0,0 +1,4 @@
1
+ # Cloud Quotas V1 Protocol Buffer Documentation
2
+
3
+ These files are for the YARD documentation of the generated protobuf files.
4
+ They are not intended to be required or loaded at runtime.
@@ -0,0 +1,395 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # Required information for every language.
23
+ # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
25
+ # @return [::String]
26
+ # Link to automatically generated reference documentation. Example:
27
+ # https://cloud.google.com/nodejs/docs/reference/asset/latest
28
+ # @!attribute [rw] destinations
29
+ # @return [::Array<::Google::Api::ClientLibraryDestination>]
30
+ # The destination where API teams want this client library to be published.
31
+ class CommonLanguageSettings
32
+ include ::Google::Protobuf::MessageExts
33
+ extend ::Google::Protobuf::MessageExts::ClassMethods
34
+ end
35
+
36
+ # Details about how and where to publish client libraries.
37
+ # @!attribute [rw] version
38
+ # @return [::String]
39
+ # Version of the API to apply these settings to. This is the full protobuf
40
+ # package for the API, ending in the version element.
41
+ # Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
42
+ # @!attribute [rw] launch_stage
43
+ # @return [::Google::Api::LaunchStage]
44
+ # Launch stage of this version of the API.
45
+ # @!attribute [rw] rest_numeric_enums
46
+ # @return [::Boolean]
47
+ # When using transport=rest, the client request will encode enums as
48
+ # numbers rather than strings.
49
+ # @!attribute [rw] java_settings
50
+ # @return [::Google::Api::JavaSettings]
51
+ # Settings for legacy Java features, supported in the Service YAML.
52
+ # @!attribute [rw] cpp_settings
53
+ # @return [::Google::Api::CppSettings]
54
+ # Settings for C++ client libraries.
55
+ # @!attribute [rw] php_settings
56
+ # @return [::Google::Api::PhpSettings]
57
+ # Settings for PHP client libraries.
58
+ # @!attribute [rw] python_settings
59
+ # @return [::Google::Api::PythonSettings]
60
+ # Settings for Python client libraries.
61
+ # @!attribute [rw] node_settings
62
+ # @return [::Google::Api::NodeSettings]
63
+ # Settings for Node client libraries.
64
+ # @!attribute [rw] dotnet_settings
65
+ # @return [::Google::Api::DotnetSettings]
66
+ # Settings for .NET client libraries.
67
+ # @!attribute [rw] ruby_settings
68
+ # @return [::Google::Api::RubySettings]
69
+ # Settings for Ruby client libraries.
70
+ # @!attribute [rw] go_settings
71
+ # @return [::Google::Api::GoSettings]
72
+ # Settings for Go client libraries.
73
+ class ClientLibrarySettings
74
+ include ::Google::Protobuf::MessageExts
75
+ extend ::Google::Protobuf::MessageExts::ClassMethods
76
+ end
77
+
78
+ # This message configures the settings for publishing [Google Cloud Client
79
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
80
+ # generated from the service config.
81
+ # @!attribute [rw] method_settings
82
+ # @return [::Array<::Google::Api::MethodSettings>]
83
+ # A list of API method settings, e.g. the behavior for methods that use the
84
+ # long-running operation pattern.
85
+ # @!attribute [rw] new_issue_uri
86
+ # @return [::String]
87
+ # Link to a *public* URI where users can report issues. Example:
88
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
89
+ # @!attribute [rw] documentation_uri
90
+ # @return [::String]
91
+ # Link to product home page. Example:
92
+ # https://cloud.google.com/asset-inventory/docs/overview
93
+ # @!attribute [rw] api_short_name
94
+ # @return [::String]
95
+ # Used as a tracking tag when collecting data about the APIs developer
96
+ # relations artifacts like docs, packages delivered to package managers,
97
+ # etc. Example: "speech".
98
+ # @!attribute [rw] github_label
99
+ # @return [::String]
100
+ # GitHub label to apply to issues and pull requests opened for this API.
101
+ # @!attribute [rw] codeowner_github_teams
102
+ # @return [::Array<::String>]
103
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
104
+ # containing source code for the client libraries for this API.
105
+ # @!attribute [rw] doc_tag_prefix
106
+ # @return [::String]
107
+ # A prefix used in sample code when demarking regions to be included in
108
+ # documentation.
109
+ # @!attribute [rw] organization
110
+ # @return [::Google::Api::ClientLibraryOrganization]
111
+ # For whom the client library is being published.
112
+ # @!attribute [rw] library_settings
113
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
114
+ # Client library settings. If the same version string appears multiple
115
+ # times in this list, then the last one wins. Settings from earlier
116
+ # settings with the same version string are discarded.
117
+ # @!attribute [rw] proto_reference_documentation_uri
118
+ # @return [::String]
119
+ # Optional link to proto reference documentation. Example:
120
+ # https://cloud.google.com/pubsub/lite/docs/reference/rpc
121
+ class Publishing
122
+ include ::Google::Protobuf::MessageExts
123
+ extend ::Google::Protobuf::MessageExts::ClassMethods
124
+ end
125
+
126
+ # Settings for Java client libraries.
127
+ # @!attribute [rw] library_package
128
+ # @return [::String]
129
+ # The package name to use in Java. Clobbers the java_package option
130
+ # set in the protobuf. This should be used **only** by APIs
131
+ # who have already set the language_settings.java.package_name" field
132
+ # in gapic.yaml. API teams should use the protobuf java_package option
133
+ # where possible.
134
+ #
135
+ # Example of a YAML configuration::
136
+ #
137
+ # publishing:
138
+ # java_settings:
139
+ # library_package: com.google.cloud.pubsub.v1
140
+ # @!attribute [rw] service_class_names
141
+ # @return [::Google::Protobuf::Map{::String => ::String}]
142
+ # Configure the Java class name to use instead of the service's for its
143
+ # corresponding generated GAPIC client. Keys are fully-qualified
144
+ # service names as they appear in the protobuf (including the full
145
+ # the language_settings.java.interface_names" field in gapic.yaml. API
146
+ # teams should otherwise use the service name as it appears in the
147
+ # protobuf.
148
+ #
149
+ # Example of a YAML configuration::
150
+ #
151
+ # publishing:
152
+ # java_settings:
153
+ # service_class_names:
154
+ # - google.pubsub.v1.Publisher: TopicAdmin
155
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
156
+ # @!attribute [rw] common
157
+ # @return [::Google::Api::CommonLanguageSettings]
158
+ # Some settings.
159
+ class JavaSettings
160
+ include ::Google::Protobuf::MessageExts
161
+ extend ::Google::Protobuf::MessageExts::ClassMethods
162
+
163
+ # @!attribute [rw] key
164
+ # @return [::String]
165
+ # @!attribute [rw] value
166
+ # @return [::String]
167
+ class ServiceClassNamesEntry
168
+ include ::Google::Protobuf::MessageExts
169
+ extend ::Google::Protobuf::MessageExts::ClassMethods
170
+ end
171
+ end
172
+
173
+ # Settings for C++ client libraries.
174
+ # @!attribute [rw] common
175
+ # @return [::Google::Api::CommonLanguageSettings]
176
+ # Some settings.
177
+ class CppSettings
178
+ include ::Google::Protobuf::MessageExts
179
+ extend ::Google::Protobuf::MessageExts::ClassMethods
180
+ end
181
+
182
+ # Settings for Php client libraries.
183
+ # @!attribute [rw] common
184
+ # @return [::Google::Api::CommonLanguageSettings]
185
+ # Some settings.
186
+ class PhpSettings
187
+ include ::Google::Protobuf::MessageExts
188
+ extend ::Google::Protobuf::MessageExts::ClassMethods
189
+ end
190
+
191
+ # Settings for Python client libraries.
192
+ # @!attribute [rw] common
193
+ # @return [::Google::Api::CommonLanguageSettings]
194
+ # Some settings.
195
+ class PythonSettings
196
+ include ::Google::Protobuf::MessageExts
197
+ extend ::Google::Protobuf::MessageExts::ClassMethods
198
+ end
199
+
200
+ # Settings for Node client libraries.
201
+ # @!attribute [rw] common
202
+ # @return [::Google::Api::CommonLanguageSettings]
203
+ # Some settings.
204
+ class NodeSettings
205
+ include ::Google::Protobuf::MessageExts
206
+ extend ::Google::Protobuf::MessageExts::ClassMethods
207
+ end
208
+
209
+ # Settings for Dotnet client libraries.
210
+ # @!attribute [rw] common
211
+ # @return [::Google::Api::CommonLanguageSettings]
212
+ # Some settings.
213
+ # @!attribute [rw] renamed_services
214
+ # @return [::Google::Protobuf::Map{::String => ::String}]
215
+ # Map from original service names to renamed versions.
216
+ # This is used when the default generated types
217
+ # would cause a naming conflict. (Neither name is
218
+ # fully-qualified.)
219
+ # Example: Subscriber to SubscriberServiceApi.
220
+ # @!attribute [rw] renamed_resources
221
+ # @return [::Google::Protobuf::Map{::String => ::String}]
222
+ # Map from full resource types to the effective short name
223
+ # for the resource. This is used when otherwise resource
224
+ # named from different services would cause naming collisions.
225
+ # Example entry:
226
+ # "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
227
+ # @!attribute [rw] ignored_resources
228
+ # @return [::Array<::String>]
229
+ # List of full resource types to ignore during generation.
230
+ # This is typically used for API-specific Location resources,
231
+ # which should be handled by the generator as if they were actually
232
+ # the common Location resources.
233
+ # Example entry: "documentai.googleapis.com/Location"
234
+ # @!attribute [rw] forced_namespace_aliases
235
+ # @return [::Array<::String>]
236
+ # Namespaces which must be aliased in snippets due to
237
+ # a known (but non-generator-predictable) naming collision
238
+ # @!attribute [rw] handwritten_signatures
239
+ # @return [::Array<::String>]
240
+ # Method signatures (in the form "service.method(signature)")
241
+ # which are provided separately, so shouldn't be generated.
242
+ # Snippets *calling* these methods are still generated, however.
243
+ class DotnetSettings
244
+ include ::Google::Protobuf::MessageExts
245
+ extend ::Google::Protobuf::MessageExts::ClassMethods
246
+
247
+ # @!attribute [rw] key
248
+ # @return [::String]
249
+ # @!attribute [rw] value
250
+ # @return [::String]
251
+ class RenamedServicesEntry
252
+ include ::Google::Protobuf::MessageExts
253
+ extend ::Google::Protobuf::MessageExts::ClassMethods
254
+ end
255
+
256
+ # @!attribute [rw] key
257
+ # @return [::String]
258
+ # @!attribute [rw] value
259
+ # @return [::String]
260
+ class RenamedResourcesEntry
261
+ include ::Google::Protobuf::MessageExts
262
+ extend ::Google::Protobuf::MessageExts::ClassMethods
263
+ end
264
+ end
265
+
266
+ # Settings for Ruby client libraries.
267
+ # @!attribute [rw] common
268
+ # @return [::Google::Api::CommonLanguageSettings]
269
+ # Some settings.
270
+ class RubySettings
271
+ include ::Google::Protobuf::MessageExts
272
+ extend ::Google::Protobuf::MessageExts::ClassMethods
273
+ end
274
+
275
+ # Settings for Go client libraries.
276
+ # @!attribute [rw] common
277
+ # @return [::Google::Api::CommonLanguageSettings]
278
+ # Some settings.
279
+ class GoSettings
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+
284
+ # Describes the generator configuration for a method.
285
+ # @!attribute [rw] selector
286
+ # @return [::String]
287
+ # The fully qualified name of the method, for which the options below apply.
288
+ # This is used to find the method to apply the options.
289
+ # @!attribute [rw] long_running
290
+ # @return [::Google::Api::MethodSettings::LongRunning]
291
+ # Describes settings to use for long-running operations when generating
292
+ # API methods for RPCs. Complements RPCs that use the annotations in
293
+ # google/longrunning/operations.proto.
294
+ #
295
+ # Example of a YAML configuration::
296
+ #
297
+ # publishing:
298
+ # method_settings:
299
+ # - selector: google.cloud.speech.v2.Speech.BatchRecognize
300
+ # long_running:
301
+ # initial_poll_delay:
302
+ # seconds: 60 # 1 minute
303
+ # poll_delay_multiplier: 1.5
304
+ # max_poll_delay:
305
+ # seconds: 360 # 6 minutes
306
+ # total_poll_timeout:
307
+ # seconds: 54000 # 90 minutes
308
+ # @!attribute [rw] auto_populated_fields
309
+ # @return [::Array<::String>]
310
+ # List of top-level fields of the request message, that should be
311
+ # automatically populated by the client libraries based on their
312
+ # (google.api.field_info).format. Currently supported format: UUID4.
313
+ #
314
+ # Example of a YAML configuration:
315
+ #
316
+ # publishing:
317
+ # method_settings:
318
+ # - selector: google.example.v1.ExampleService.CreateExample
319
+ # auto_populated_fields:
320
+ # - request_id
321
+ class MethodSettings
322
+ include ::Google::Protobuf::MessageExts
323
+ extend ::Google::Protobuf::MessageExts::ClassMethods
324
+
325
+ # Describes settings to use when generating API methods that use the
326
+ # long-running operation pattern.
327
+ # All default values below are from those used in the client library
328
+ # generators (e.g.
329
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
330
+ # @!attribute [rw] initial_poll_delay
331
+ # @return [::Google::Protobuf::Duration]
332
+ # Initial delay after which the first poll request will be made.
333
+ # Default value: 5 seconds.
334
+ # @!attribute [rw] poll_delay_multiplier
335
+ # @return [::Float]
336
+ # Multiplier to gradually increase delay between subsequent polls until it
337
+ # reaches max_poll_delay.
338
+ # Default value: 1.5.
339
+ # @!attribute [rw] max_poll_delay
340
+ # @return [::Google::Protobuf::Duration]
341
+ # Maximum time between two subsequent poll requests.
342
+ # Default value: 45 seconds.
343
+ # @!attribute [rw] total_poll_timeout
344
+ # @return [::Google::Protobuf::Duration]
345
+ # Total polling timeout.
346
+ # Default value: 5 minutes.
347
+ class LongRunning
348
+ include ::Google::Protobuf::MessageExts
349
+ extend ::Google::Protobuf::MessageExts::ClassMethods
350
+ end
351
+ end
352
+
353
+ # The organization for which the client libraries are being published.
354
+ # Affects the url where generated docs are published, etc.
355
+ module ClientLibraryOrganization
356
+ # Not useful.
357
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
358
+
359
+ # Google Cloud Platform Org.
360
+ CLOUD = 1
361
+
362
+ # Ads (Advertising) Org.
363
+ ADS = 2
364
+
365
+ # Photos Org.
366
+ PHOTOS = 3
367
+
368
+ # Street View Org.
369
+ STREET_VIEW = 4
370
+
371
+ # Shopping Org.
372
+ SHOPPING = 5
373
+
374
+ # Geo Org.
375
+ GEO = 6
376
+
377
+ # Generative AI - https://developers.generativeai.google
378
+ GENERATIVE_AI = 7
379
+ end
380
+
381
+ # To where should client libraries be published?
382
+ module ClientLibraryDestination
383
+ # Client libraries will neither be generated nor published to package
384
+ # managers.
385
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
386
+
387
+ # Generate the client library in a repo under github.com/googleapis,
388
+ # but don't publish it to package managers.
389
+ GITHUB = 10
390
+
391
+ # Publish the library to package managers like nuget.org and npmjs.com.
392
+ PACKAGE_MANAGER = 20
393
+ end
394
+ end
395
+ end
@@ -0,0 +1,196 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module CloudQuotas
23
+ module V1
24
+ # Message for requesting list of QuotaInfos
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. Parent value of QuotaInfo resources.
28
+ # Listing across different resource containers (such as 'projects/-') is not
29
+ # allowed.
30
+ #
31
+ # Example names:
32
+ # `projects/123/locations/global/services/compute.googleapis.com`
33
+ # `folders/234/locations/global/services/compute.googleapis.com`
34
+ # `organizations/345/locations/global/services/compute.googleapis.com`
35
+ # @!attribute [rw] page_size
36
+ # @return [::Integer]
37
+ # Optional. Requested page size. Server may return fewer items than
38
+ # requested. If unspecified, server will pick an appropriate default.
39
+ # @!attribute [rw] page_token
40
+ # @return [::String]
41
+ # Optional. A token identifying a page of results the server should return.
42
+ class ListQuotaInfosRequest
43
+ include ::Google::Protobuf::MessageExts
44
+ extend ::Google::Protobuf::MessageExts::ClassMethods
45
+ end
46
+
47
+ # Message for response to listing QuotaInfos
48
+ # @!attribute [rw] quota_infos
49
+ # @return [::Array<::Google::Cloud::CloudQuotas::V1::QuotaInfo>]
50
+ # The list of QuotaInfo
51
+ # @!attribute [rw] next_page_token
52
+ # @return [::String]
53
+ # A token, which can be sent as `page_token` to retrieve the next page.
54
+ # If this field is omitted, there are no subsequent pages.
55
+ class ListQuotaInfosResponse
56
+ include ::Google::Protobuf::MessageExts
57
+ extend ::Google::Protobuf::MessageExts::ClassMethods
58
+ end
59
+
60
+ # Message for getting a QuotaInfo
61
+ # @!attribute [rw] name
62
+ # @return [::String]
63
+ # Required. The resource name of the quota info.
64
+ #
65
+ # An example name:
66
+ # `projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`
67
+ class GetQuotaInfoRequest
68
+ include ::Google::Protobuf::MessageExts
69
+ extend ::Google::Protobuf::MessageExts::ClassMethods
70
+ end
71
+
72
+ # Message for requesting list of QuotaPreferences
73
+ # @!attribute [rw] parent
74
+ # @return [::String]
75
+ # Required. Parent value of QuotaPreference resources.
76
+ # Listing across different resource containers (such as 'projects/-') is not
77
+ # allowed.
78
+ #
79
+ # When the value starts with 'folders' or 'organizations', it lists the
80
+ # QuotaPreferences for org quotas in the container. It does not list the
81
+ # QuotaPreferences in the descendant projects of the container.
82
+ #
83
+ # Example parents:
84
+ # `projects/123/locations/global`
85
+ # @!attribute [rw] page_size
86
+ # @return [::Integer]
87
+ # Optional. Requested page size. Server may return fewer items than
88
+ # requested. If unspecified, server will pick an appropriate default.
89
+ # @!attribute [rw] page_token
90
+ # @return [::String]
91
+ # Optional. A token identifying a page of results the server should return.
92
+ # @!attribute [rw] filter
93
+ # @return [::String]
94
+ # Optional. Filter result QuotaPreferences by their state, type,
95
+ # create/update time range.
96
+ #
97
+ # Example filters:
98
+ # `state=PENDING OR state=PENDING_PARTIALLY_GRANTED`
99
+ # `state=PENDING OR state=PENDING_PARTIALLY_GRANTED AND
100
+ # creation_time>2022-12-03T10:30:00`
101
+ #
102
+ # If no filter is provided, returns all pending quota preferences.
103
+ # @!attribute [rw] order_by
104
+ # @return [::String]
105
+ # Optional. How to order of the results. By default, the results are ordered
106
+ # by create time.
107
+ #
108
+ # Example orders:
109
+ # `type`
110
+ # `state, create_time`
111
+ class ListQuotaPreferencesRequest
112
+ include ::Google::Protobuf::MessageExts
113
+ extend ::Google::Protobuf::MessageExts::ClassMethods
114
+ end
115
+
116
+ # Message for response to listing QuotaPreferences
117
+ # @!attribute [rw] quota_preferences
118
+ # @return [::Array<::Google::Cloud::CloudQuotas::V1::QuotaPreference>]
119
+ # The list of QuotaPreference
120
+ # @!attribute [rw] next_page_token
121
+ # @return [::String]
122
+ # A token, which can be sent as `page_token` to retrieve the next page.
123
+ # If this field is omitted, there are no subsequent pages.
124
+ # @!attribute [rw] unreachable
125
+ # @return [::Array<::String>]
126
+ # Locations that could not be reached.
127
+ class ListQuotaPreferencesResponse
128
+ include ::Google::Protobuf::MessageExts
129
+ extend ::Google::Protobuf::MessageExts::ClassMethods
130
+ end
131
+
132
+ # Message for getting a QuotaPreference
133
+ # @!attribute [rw] name
134
+ # @return [::String]
135
+ # Required. Name of the resource
136
+ #
137
+ # Example name:
138
+ # `projects/123/locations/global/quota_preferences/my-config-for-us-east1`
139
+ class GetQuotaPreferenceRequest
140
+ include ::Google::Protobuf::MessageExts
141
+ extend ::Google::Protobuf::MessageExts::ClassMethods
142
+ end
143
+
144
+ # Message for creating a QuotaPreference
145
+ # @!attribute [rw] parent
146
+ # @return [::String]
147
+ # Required. Value for parent.
148
+ #
149
+ # Example:
150
+ # `projects/123/locations/global`
151
+ # @!attribute [rw] quota_preference_id
152
+ # @return [::String]
153
+ # Optional. Id of the requesting object, must be unique under its parent.
154
+ # If client does not set this field, the service will generate one.
155
+ # @!attribute [rw] quota_preference
156
+ # @return [::Google::Cloud::CloudQuotas::V1::QuotaPreference]
157
+ # Required. The resource being created
158
+ # @!attribute [rw] ignore_safety_checks
159
+ # @return [::Array<::Google::Cloud::CloudQuotas::V1::QuotaSafetyCheck>]
160
+ # The list of quota safety checks to be ignored.
161
+ class CreateQuotaPreferenceRequest
162
+ include ::Google::Protobuf::MessageExts
163
+ extend ::Google::Protobuf::MessageExts::ClassMethods
164
+ end
165
+
166
+ # Message for updating a QuotaPreference
167
+ # @!attribute [rw] update_mask
168
+ # @return [::Google::Protobuf::FieldMask]
169
+ # Optional. Field mask is used to specify the fields to be overwritten in the
170
+ # QuotaPreference resource by the update.
171
+ # The fields specified in the update_mask are relative to the resource, not
172
+ # the full request. A field will be overwritten if it is in the mask. If the
173
+ # user does not provide a mask then all fields will be overwritten.
174
+ # @!attribute [rw] quota_preference
175
+ # @return [::Google::Cloud::CloudQuotas::V1::QuotaPreference]
176
+ # Required. The resource being updated
177
+ # @!attribute [rw] allow_missing
178
+ # @return [::Boolean]
179
+ # Optional. If set to true, and the quota preference is not found, a new one
180
+ # will be created. In this situation, `update_mask` is ignored.
181
+ # @!attribute [rw] validate_only
182
+ # @return [::Boolean]
183
+ # Optional. If set to true, validate the request, but do not actually update.
184
+ # Note that a request being valid does not mean that the request is
185
+ # guaranteed to be fulfilled.
186
+ # @!attribute [rw] ignore_safety_checks
187
+ # @return [::Array<::Google::Cloud::CloudQuotas::V1::QuotaSafetyCheck>]
188
+ # The list of quota safety checks to be ignored.
189
+ class UpdateQuotaPreferenceRequest
190
+ include ::Google::Protobuf::MessageExts
191
+ extend ::Google::Protobuf::MessageExts::ClassMethods
192
+ end
193
+ end
194
+ end
195
+ end
196
+ end