google-cloud-app_hub-v1 0.a → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (46) 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/cloud/app_hub/v1/app_hub/client.rb +3426 -0
  6. data/lib/google/cloud/app_hub/v1/app_hub/credentials.rb +47 -0
  7. data/lib/google/cloud/app_hub/v1/app_hub/operations.rb +809 -0
  8. data/lib/google/cloud/app_hub/v1/app_hub/paths.rb +182 -0
  9. data/lib/google/cloud/app_hub/v1/app_hub/rest/client.rb +3214 -0
  10. data/lib/google/cloud/app_hub/v1/app_hub/rest/operations.rb +902 -0
  11. data/lib/google/cloud/app_hub/v1/app_hub/rest/service_stub.rb +1670 -0
  12. data/lib/google/cloud/app_hub/v1/app_hub/rest.rb +54 -0
  13. data/lib/google/cloud/app_hub/v1/app_hub.rb +56 -0
  14. data/lib/google/cloud/app_hub/v1/bindings_override.rb +135 -0
  15. data/lib/google/cloud/app_hub/v1/rest.rb +38 -0
  16. data/lib/google/cloud/app_hub/v1/version.rb +7 -2
  17. data/lib/google/cloud/app_hub/v1.rb +45 -0
  18. data/lib/google/cloud/apphub/v1/apphub_service_pb.rb +98 -0
  19. data/lib/google/cloud/apphub/v1/apphub_service_services_pb.rb +104 -0
  20. data/lib/google/cloud/apphub/v1/application_pb.rb +53 -0
  21. data/lib/google/cloud/apphub/v1/attributes_pb.rb +49 -0
  22. data/lib/google/cloud/apphub/v1/service_pb.rb +54 -0
  23. data/lib/google/cloud/apphub/v1/service_project_attachment_pb.rb +49 -0
  24. data/lib/google/cloud/apphub/v1/workload_pb.rb +54 -0
  25. data/lib/google-cloud-app_hub-v1.rb +21 -0
  26. data/proto_docs/README.md +4 -0
  27. data/proto_docs/google/api/client.rb +420 -0
  28. data/proto_docs/google/api/field_behavior.rb +85 -0
  29. data/proto_docs/google/api/field_info.rb +88 -0
  30. data/proto_docs/google/api/launch_stage.rb +71 -0
  31. data/proto_docs/google/api/resource.rb +227 -0
  32. data/proto_docs/google/cloud/apphub/v1/apphub_service.rb +786 -0
  33. data/proto_docs/google/cloud/apphub/v1/application.rb +100 -0
  34. data/proto_docs/google/cloud/apphub/v1/attributes.rb +115 -0
  35. data/proto_docs/google/cloud/apphub/v1/service.rb +139 -0
  36. data/proto_docs/google/cloud/apphub/v1/service_project_attachment.rb +72 -0
  37. data/proto_docs/google/cloud/apphub/v1/workload.rb +140 -0
  38. data/proto_docs/google/longrunning/operations.rb +164 -0
  39. data/proto_docs/google/protobuf/any.rb +145 -0
  40. data/proto_docs/google/protobuf/duration.rb +98 -0
  41. data/proto_docs/google/protobuf/empty.rb +34 -0
  42. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  43. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  44. data/proto_docs/google/rpc/status.rb +48 -0
  45. data/proto_docs/google/type/expr.rb +75 -0
  46. metadata +125 -10
@@ -0,0 +1,420 @@
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
+ # @!attribute [rw] rest_reference_documentation_uri
122
+ # @return [::String]
123
+ # Optional link to REST reference documentation. Example:
124
+ # https://cloud.google.com/pubsub/lite/docs/reference/rest
125
+ class Publishing
126
+ include ::Google::Protobuf::MessageExts
127
+ extend ::Google::Protobuf::MessageExts::ClassMethods
128
+ end
129
+
130
+ # Settings for Java client libraries.
131
+ # @!attribute [rw] library_package
132
+ # @return [::String]
133
+ # The package name to use in Java. Clobbers the java_package option
134
+ # set in the protobuf. This should be used **only** by APIs
135
+ # who have already set the language_settings.java.package_name" field
136
+ # in gapic.yaml. API teams should use the protobuf java_package option
137
+ # where possible.
138
+ #
139
+ # Example of a YAML configuration::
140
+ #
141
+ # publishing:
142
+ # java_settings:
143
+ # library_package: com.google.cloud.pubsub.v1
144
+ # @!attribute [rw] service_class_names
145
+ # @return [::Google::Protobuf::Map{::String => ::String}]
146
+ # Configure the Java class name to use instead of the service's for its
147
+ # corresponding generated GAPIC client. Keys are fully-qualified
148
+ # service names as they appear in the protobuf (including the full
149
+ # the language_settings.java.interface_names" field in gapic.yaml. API
150
+ # teams should otherwise use the service name as it appears in the
151
+ # protobuf.
152
+ #
153
+ # Example of a YAML configuration::
154
+ #
155
+ # publishing:
156
+ # java_settings:
157
+ # service_class_names:
158
+ # - google.pubsub.v1.Publisher: TopicAdmin
159
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
160
+ # @!attribute [rw] common
161
+ # @return [::Google::Api::CommonLanguageSettings]
162
+ # Some settings.
163
+ class JavaSettings
164
+ include ::Google::Protobuf::MessageExts
165
+ extend ::Google::Protobuf::MessageExts::ClassMethods
166
+
167
+ # @!attribute [rw] key
168
+ # @return [::String]
169
+ # @!attribute [rw] value
170
+ # @return [::String]
171
+ class ServiceClassNamesEntry
172
+ include ::Google::Protobuf::MessageExts
173
+ extend ::Google::Protobuf::MessageExts::ClassMethods
174
+ end
175
+ end
176
+
177
+ # Settings for C++ client libraries.
178
+ # @!attribute [rw] common
179
+ # @return [::Google::Api::CommonLanguageSettings]
180
+ # Some settings.
181
+ class CppSettings
182
+ include ::Google::Protobuf::MessageExts
183
+ extend ::Google::Protobuf::MessageExts::ClassMethods
184
+ end
185
+
186
+ # Settings for Php client libraries.
187
+ # @!attribute [rw] common
188
+ # @return [::Google::Api::CommonLanguageSettings]
189
+ # Some settings.
190
+ class PhpSettings
191
+ include ::Google::Protobuf::MessageExts
192
+ extend ::Google::Protobuf::MessageExts::ClassMethods
193
+ end
194
+
195
+ # Settings for Python client libraries.
196
+ # @!attribute [rw] common
197
+ # @return [::Google::Api::CommonLanguageSettings]
198
+ # Some settings.
199
+ # @!attribute [rw] experimental_features
200
+ # @return [::Google::Api::PythonSettings::ExperimentalFeatures]
201
+ # Experimental features to be included during client library generation.
202
+ class PythonSettings
203
+ include ::Google::Protobuf::MessageExts
204
+ extend ::Google::Protobuf::MessageExts::ClassMethods
205
+
206
+ # Experimental features to be included during client library generation.
207
+ # These fields will be deprecated once the feature graduates and is enabled
208
+ # by default.
209
+ # @!attribute [rw] rest_async_io_enabled
210
+ # @return [::Boolean]
211
+ # Enables generation of asynchronous REST clients if `rest` transport is
212
+ # enabled. By default, asynchronous REST clients will not be generated.
213
+ # This feature will be enabled by default 1 month after launching the
214
+ # feature in preview packages.
215
+ class ExperimentalFeatures
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+ end
220
+
221
+ # Settings for Node client libraries.
222
+ # @!attribute [rw] common
223
+ # @return [::Google::Api::CommonLanguageSettings]
224
+ # Some settings.
225
+ class NodeSettings
226
+ include ::Google::Protobuf::MessageExts
227
+ extend ::Google::Protobuf::MessageExts::ClassMethods
228
+ end
229
+
230
+ # Settings for Dotnet client libraries.
231
+ # @!attribute [rw] common
232
+ # @return [::Google::Api::CommonLanguageSettings]
233
+ # Some settings.
234
+ # @!attribute [rw] renamed_services
235
+ # @return [::Google::Protobuf::Map{::String => ::String}]
236
+ # Map from original service names to renamed versions.
237
+ # This is used when the default generated types
238
+ # would cause a naming conflict. (Neither name is
239
+ # fully-qualified.)
240
+ # Example: Subscriber to SubscriberServiceApi.
241
+ # @!attribute [rw] renamed_resources
242
+ # @return [::Google::Protobuf::Map{::String => ::String}]
243
+ # Map from full resource types to the effective short name
244
+ # for the resource. This is used when otherwise resource
245
+ # named from different services would cause naming collisions.
246
+ # Example entry:
247
+ # "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
248
+ # @!attribute [rw] ignored_resources
249
+ # @return [::Array<::String>]
250
+ # List of full resource types to ignore during generation.
251
+ # This is typically used for API-specific Location resources,
252
+ # which should be handled by the generator as if they were actually
253
+ # the common Location resources.
254
+ # Example entry: "documentai.googleapis.com/Location"
255
+ # @!attribute [rw] forced_namespace_aliases
256
+ # @return [::Array<::String>]
257
+ # Namespaces which must be aliased in snippets due to
258
+ # a known (but non-generator-predictable) naming collision
259
+ # @!attribute [rw] handwritten_signatures
260
+ # @return [::Array<::String>]
261
+ # Method signatures (in the form "service.method(signature)")
262
+ # which are provided separately, so shouldn't be generated.
263
+ # Snippets *calling* these methods are still generated, however.
264
+ class DotnetSettings
265
+ include ::Google::Protobuf::MessageExts
266
+ extend ::Google::Protobuf::MessageExts::ClassMethods
267
+
268
+ # @!attribute [rw] key
269
+ # @return [::String]
270
+ # @!attribute [rw] value
271
+ # @return [::String]
272
+ class RenamedServicesEntry
273
+ include ::Google::Protobuf::MessageExts
274
+ extend ::Google::Protobuf::MessageExts::ClassMethods
275
+ end
276
+
277
+ # @!attribute [rw] key
278
+ # @return [::String]
279
+ # @!attribute [rw] value
280
+ # @return [::String]
281
+ class RenamedResourcesEntry
282
+ include ::Google::Protobuf::MessageExts
283
+ extend ::Google::Protobuf::MessageExts::ClassMethods
284
+ end
285
+ end
286
+
287
+ # Settings for Ruby client libraries.
288
+ # @!attribute [rw] common
289
+ # @return [::Google::Api::CommonLanguageSettings]
290
+ # Some settings.
291
+ class RubySettings
292
+ include ::Google::Protobuf::MessageExts
293
+ extend ::Google::Protobuf::MessageExts::ClassMethods
294
+ end
295
+
296
+ # Settings for Go client libraries.
297
+ # @!attribute [rw] common
298
+ # @return [::Google::Api::CommonLanguageSettings]
299
+ # Some settings.
300
+ class GoSettings
301
+ include ::Google::Protobuf::MessageExts
302
+ extend ::Google::Protobuf::MessageExts::ClassMethods
303
+ end
304
+
305
+ # Describes the generator configuration for a method.
306
+ # @!attribute [rw] selector
307
+ # @return [::String]
308
+ # The fully qualified name of the method, for which the options below apply.
309
+ # This is used to find the method to apply the options.
310
+ #
311
+ # Example:
312
+ #
313
+ # publishing:
314
+ # method_settings:
315
+ # - selector: google.storage.control.v2.StorageControl.CreateFolder
316
+ # # method settings for CreateFolder...
317
+ # @!attribute [rw] long_running
318
+ # @return [::Google::Api::MethodSettings::LongRunning]
319
+ # Describes settings to use for long-running operations when generating
320
+ # API methods for RPCs. Complements RPCs that use the annotations in
321
+ # google/longrunning/operations.proto.
322
+ #
323
+ # Example of a YAML configuration::
324
+ #
325
+ # publishing:
326
+ # method_settings:
327
+ # - selector: google.cloud.speech.v2.Speech.BatchRecognize
328
+ # long_running:
329
+ # initial_poll_delay: 60s # 1 minute
330
+ # poll_delay_multiplier: 1.5
331
+ # max_poll_delay: 360s # 6 minutes
332
+ # total_poll_timeout: 54000s # 90 minutes
333
+ # @!attribute [rw] auto_populated_fields
334
+ # @return [::Array<::String>]
335
+ # List of top-level fields of the request message, that should be
336
+ # automatically populated by the client libraries based on their
337
+ # (google.api.field_info).format. Currently supported format: UUID4.
338
+ #
339
+ # Example of a YAML configuration:
340
+ #
341
+ # publishing:
342
+ # method_settings:
343
+ # - selector: google.example.v1.ExampleService.CreateExample
344
+ # auto_populated_fields:
345
+ # - request_id
346
+ class MethodSettings
347
+ include ::Google::Protobuf::MessageExts
348
+ extend ::Google::Protobuf::MessageExts::ClassMethods
349
+
350
+ # Describes settings to use when generating API methods that use the
351
+ # long-running operation pattern.
352
+ # All default values below are from those used in the client library
353
+ # generators (e.g.
354
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
355
+ # @!attribute [rw] initial_poll_delay
356
+ # @return [::Google::Protobuf::Duration]
357
+ # Initial delay after which the first poll request will be made.
358
+ # Default value: 5 seconds.
359
+ # @!attribute [rw] poll_delay_multiplier
360
+ # @return [::Float]
361
+ # Multiplier to gradually increase delay between subsequent polls until it
362
+ # reaches max_poll_delay.
363
+ # Default value: 1.5.
364
+ # @!attribute [rw] max_poll_delay
365
+ # @return [::Google::Protobuf::Duration]
366
+ # Maximum time between two subsequent poll requests.
367
+ # Default value: 45 seconds.
368
+ # @!attribute [rw] total_poll_timeout
369
+ # @return [::Google::Protobuf::Duration]
370
+ # Total polling timeout.
371
+ # Default value: 5 minutes.
372
+ class LongRunning
373
+ include ::Google::Protobuf::MessageExts
374
+ extend ::Google::Protobuf::MessageExts::ClassMethods
375
+ end
376
+ end
377
+
378
+ # The organization for which the client libraries are being published.
379
+ # Affects the url where generated docs are published, etc.
380
+ module ClientLibraryOrganization
381
+ # Not useful.
382
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
383
+
384
+ # Google Cloud Platform Org.
385
+ CLOUD = 1
386
+
387
+ # Ads (Advertising) Org.
388
+ ADS = 2
389
+
390
+ # Photos Org.
391
+ PHOTOS = 3
392
+
393
+ # Street View Org.
394
+ STREET_VIEW = 4
395
+
396
+ # Shopping Org.
397
+ SHOPPING = 5
398
+
399
+ # Geo Org.
400
+ GEO = 6
401
+
402
+ # Generative AI - https://developers.generativeai.google
403
+ GENERATIVE_AI = 7
404
+ end
405
+
406
+ # To where should client libraries be published?
407
+ module ClientLibraryDestination
408
+ # Client libraries will neither be generated nor published to package
409
+ # managers.
410
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
411
+
412
+ # Generate the client library in a repo under github.com/googleapis,
413
+ # but don't publish it to package managers.
414
+ GITHUB = 10
415
+
416
+ # Publish the library to package managers like nuget.org and npmjs.com.
417
+ PACKAGE_MANAGER = 20
418
+ end
419
+ end
420
+ end
@@ -0,0 +1,85 @@
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
+ # An indicator of the behavior of a given field (for example, that a field
23
+ # is required in requests, or given as output but ignored as input).
24
+ # This **does not** change the behavior in protocol buffers itself; it only
25
+ # denotes the behavior and may affect how API tooling handles the field.
26
+ #
27
+ # Note: This enum **may** receive new values in the future.
28
+ module FieldBehavior
29
+ # Conventional default for enums. Do not use this.
30
+ FIELD_BEHAVIOR_UNSPECIFIED = 0
31
+
32
+ # Specifically denotes a field as optional.
33
+ # While all fields in protocol buffers are optional, this may be specified
34
+ # for emphasis if appropriate.
35
+ OPTIONAL = 1
36
+
37
+ # Denotes a field as required.
38
+ # This indicates that the field **must** be provided as part of the request,
39
+ # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
40
+ REQUIRED = 2
41
+
42
+ # Denotes a field as output only.
43
+ # This indicates that the field is provided in responses, but including the
44
+ # field in a request does nothing (the server *must* ignore it and
45
+ # *must not* throw an error as a result of the field's presence).
46
+ OUTPUT_ONLY = 3
47
+
48
+ # Denotes a field as input only.
49
+ # This indicates that the field is provided in requests, and the
50
+ # corresponding field is not included in output.
51
+ INPUT_ONLY = 4
52
+
53
+ # Denotes a field as immutable.
54
+ # This indicates that the field may be set once in a request to create a
55
+ # resource, but may not be changed thereafter.
56
+ IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
63
+
64
+ # Denotes that this field returns a non-empty default value if not set.
65
+ # This indicates that if the user provides the empty value in a request,
66
+ # a non-empty value will be returned. The user will not be aware of what
67
+ # non-empty value to expect.
68
+ NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
83
+ end
84
+ end
85
+ end
@@ -0,0 +1,88 @@
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
+ # Rich semantic information of an API field beyond basic typing.
23
+ # @!attribute [rw] format
24
+ # @return [::Google::Api::FieldInfo::Format]
25
+ # The standard format of a field value. This does not explicitly configure
26
+ # any API consumer, just documents the API's format for the field it is
27
+ # applied to.
28
+ # @!attribute [rw] referenced_types
29
+ # @return [::Array<::Google::Api::TypeReference>]
30
+ # The type(s) that the annotated, generic field may represent.
31
+ #
32
+ # Currently, this must only be used on fields of type `google.protobuf.Any`.
33
+ # Supporting other generic types may be considered in the future.
34
+ class FieldInfo
35
+ include ::Google::Protobuf::MessageExts
36
+ extend ::Google::Protobuf::MessageExts::ClassMethods
37
+
38
+ # The standard format of a field value. The supported formats are all backed
39
+ # by either an RFC defined by the IETF or a Google-defined AIP.
40
+ module Format
41
+ # Default, unspecified value.
42
+ FORMAT_UNSPECIFIED = 0
43
+
44
+ # Universally Unique Identifier, version 4, value as defined by
45
+ # https://datatracker.ietf.org/doc/html/rfc4122. The value may be
46
+ # normalized to entirely lowercase letters. For example, the value
47
+ # `F47AC10B-58CC-0372-8567-0E02B2C3D479` would be normalized to
48
+ # `f47ac10b-58cc-0372-8567-0e02b2c3d479`.
49
+ UUID4 = 1
50
+
51
+ # Internet Protocol v4 value as defined by [RFC
52
+ # 791](https://datatracker.ietf.org/doc/html/rfc791). The value may be
53
+ # condensed, with leading zeros in each octet stripped. For example,
54
+ # `001.022.233.040` would be condensed to `1.22.233.40`.
55
+ IPV4 = 2
56
+
57
+ # Internet Protocol v6 value as defined by [RFC
58
+ # 2460](https://datatracker.ietf.org/doc/html/rfc2460). The value may be
59
+ # normalized to entirely lowercase letters with zeros compressed, following
60
+ # [RFC 5952](https://datatracker.ietf.org/doc/html/rfc5952). For example,
61
+ # the value `2001:0DB8:0::0` would be normalized to `2001:db8::`.
62
+ IPV6 = 3
63
+
64
+ # An IP address in either v4 or v6 format as described by the individual
65
+ # values defined herein. See the comments on the IPV4 and IPV6 types for
66
+ # allowed normalizations of each.
67
+ IPV4_OR_IPV6 = 4
68
+ end
69
+ end
70
+
71
+ # A reference to a message type, for use in {::Google::Api::FieldInfo FieldInfo}.
72
+ # @!attribute [rw] type_name
73
+ # @return [::String]
74
+ # The name of the type that the annotated, generic field may represent.
75
+ # If the type is in the same protobuf package, the value can be the simple
76
+ # message name e.g., `"MyMessage"`. Otherwise, the value must be the
77
+ # fully-qualified message name e.g., `"google.library.v1.Book"`.
78
+ #
79
+ # If the type(s) are unknown to the service (e.g. the field accepts generic
80
+ # user input), use the wildcard `"*"` to denote this behavior.
81
+ #
82
+ # See [AIP-202](https://google.aip.dev/202#type-references) for more details.
83
+ class TypeReference
84
+ include ::Google::Protobuf::MessageExts
85
+ extend ::Google::Protobuf::MessageExts::ClassMethods
86
+ end
87
+ end
88
+ end
@@ -0,0 +1,71 @@
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
+ # The launch stage as defined by [Google Cloud Platform
23
+ # Launch Stages](https://cloud.google.com/terms/launch-stages).
24
+ module LaunchStage
25
+ # Do not use this default value.
26
+ LAUNCH_STAGE_UNSPECIFIED = 0
27
+
28
+ # The feature is not yet implemented. Users can not use it.
29
+ UNIMPLEMENTED = 6
30
+
31
+ # Prelaunch features are hidden from users and are only visible internally.
32
+ PRELAUNCH = 7
33
+
34
+ # Early Access features are limited to a closed group of testers. To use
35
+ # these features, you must sign up in advance and sign a Trusted Tester
36
+ # agreement (which includes confidentiality provisions). These features may
37
+ # be unstable, changed in backward-incompatible ways, and are not
38
+ # guaranteed to be released.
39
+ EARLY_ACCESS = 1
40
+
41
+ # Alpha is a limited availability test for releases before they are cleared
42
+ # for widespread use. By Alpha, all significant design issues are resolved
43
+ # and we are in the process of verifying functionality. Alpha customers
44
+ # need to apply for access, agree to applicable terms, and have their
45
+ # projects allowlisted. Alpha releases don't have to be feature complete,
46
+ # no SLAs are provided, and there are no technical support obligations, but
47
+ # they will be far enough along that customers can actually use them in
48
+ # test environments or for limited-use tests -- just like they would in
49
+ # normal production cases.
50
+ ALPHA = 2
51
+
52
+ # Beta is the point at which we are ready to open a release for any
53
+ # customer to use. There are no SLA or technical support obligations in a
54
+ # Beta release. Products will be complete from a feature perspective, but
55
+ # may have some open outstanding issues. Beta releases are suitable for
56
+ # limited production use cases.
57
+ BETA = 3
58
+
59
+ # GA features are open to all developers and are considered stable and
60
+ # fully qualified for production use.
61
+ GA = 4
62
+
63
+ # Deprecated features are scheduled to be shut down and removed. For more
64
+ # information, see the "Deprecation Policy" section of our [Terms of
65
+ # Service](https://cloud.google.com/terms/)
66
+ # and the [Google Cloud Platform Subject to the Deprecation
67
+ # Policy](https://cloud.google.com/terms/deprecation) documentation.
68
+ DEPRECATED = 5
69
+ end
70
+ end
71
+ end