google-cloud-resource_manager-v3 0.4.0 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/resource_manager/v3/folders/client.rb +47 -35
  4. data/lib/google/cloud/resource_manager/v3/folders/operations.rb +2 -2
  5. data/lib/google/cloud/resource_manager/v3/folders/rest/client.rb +47 -35
  6. data/lib/google/cloud/resource_manager/v3/folders/rest/operations.rb +2 -2
  7. data/lib/google/cloud/resource_manager/v3/organizations/client.rb +12 -10
  8. data/lib/google/cloud/resource_manager/v3/organizations/rest/client.rb +12 -10
  9. data/lib/google/cloud/resource_manager/v3/projects/client.rb +53 -54
  10. data/lib/google/cloud/resource_manager/v3/projects/operations.rb +2 -2
  11. data/lib/google/cloud/resource_manager/v3/projects/rest/client.rb +53 -54
  12. data/lib/google/cloud/resource_manager/v3/projects/rest/operations.rb +2 -2
  13. data/lib/google/cloud/resource_manager/v3/rest.rb +1 -0
  14. data/lib/google/cloud/resource_manager/v3/tag_bindings/client.rb +115 -17
  15. data/lib/google/cloud/resource_manager/v3/tag_bindings/operations.rb +2 -2
  16. data/lib/google/cloud/resource_manager/v3/tag_bindings/rest/client.rb +96 -17
  17. data/lib/google/cloud/resource_manager/v3/tag_bindings/rest/operations.rb +2 -2
  18. data/lib/google/cloud/resource_manager/v3/tag_bindings/rest/service_stub.rb +57 -0
  19. data/lib/google/cloud/resource_manager/v3/tag_bindings/rest.rb +1 -1
  20. data/lib/google/cloud/resource_manager/v3/tag_bindings.rb +1 -1
  21. data/lib/google/cloud/resource_manager/v3/tag_holds/client.rb +640 -0
  22. data/lib/google/cloud/resource_manager/v3/tag_holds/credentials.rb +52 -0
  23. data/lib/google/cloud/resource_manager/v3/tag_holds/operations.rb +768 -0
  24. data/lib/google/cloud/resource_manager/v3/tag_holds/paths.rb +64 -0
  25. data/lib/google/cloud/resource_manager/v3/tag_holds/rest/client.rb +533 -0
  26. data/lib/google/cloud/resource_manager/v3/tag_holds/rest/operations.rb +793 -0
  27. data/lib/google/cloud/resource_manager/v3/tag_holds/rest/service_stub.rb +226 -0
  28. data/lib/google/cloud/resource_manager/v3/tag_holds/rest.rb +57 -0
  29. data/lib/google/cloud/resource_manager/v3/tag_holds.rb +60 -0
  30. data/lib/google/cloud/resource_manager/v3/tag_keys/client.rb +114 -24
  31. data/lib/google/cloud/resource_manager/v3/tag_keys/operations.rb +2 -2
  32. data/lib/google/cloud/resource_manager/v3/tag_keys/rest/client.rb +99 -24
  33. data/lib/google/cloud/resource_manager/v3/tag_keys/rest/operations.rb +2 -2
  34. data/lib/google/cloud/resource_manager/v3/tag_keys/rest/service_stub.rb +57 -0
  35. data/lib/google/cloud/resource_manager/v3/tag_values/client.rb +123 -29
  36. data/lib/google/cloud/resource_manager/v3/tag_values/operations.rb +2 -2
  37. data/lib/google/cloud/resource_manager/v3/tag_values/rest/client.rb +108 -29
  38. data/lib/google/cloud/resource_manager/v3/tag_values/rest/operations.rb +2 -2
  39. data/lib/google/cloud/resource_manager/v3/tag_values/rest/service_stub.rb +57 -0
  40. data/lib/google/cloud/resource_manager/v3/version.rb +1 -1
  41. data/lib/google/cloud/resource_manager/v3.rb +1 -0
  42. data/lib/google/cloud/resourcemanager/v3/folders_services_pb.rb +23 -17
  43. data/lib/google/cloud/resourcemanager/v3/projects_services_pb.rb +16 -13
  44. data/lib/google/cloud/resourcemanager/v3/tag_bindings_pb.rb +22 -0
  45. data/lib/google/cloud/resourcemanager/v3/tag_bindings_services_pb.rb +7 -5
  46. data/lib/google/cloud/resourcemanager/v3/tag_holds_pb.rb +63 -0
  47. data/lib/google/cloud/resourcemanager/v3/tag_holds_services_pb.rb +54 -0
  48. data/lib/google/cloud/resourcemanager/v3/tag_keys_pb.rb +11 -0
  49. data/lib/google/cloud/resourcemanager/v3/tag_keys_services_pb.rb +6 -2
  50. data/lib/google/cloud/resourcemanager/v3/tag_values_pb.rb +4 -0
  51. data/lib/google/cloud/resourcemanager/v3/tag_values_services_pb.rb +7 -4
  52. data/proto_docs/google/api/client.rb +67 -4
  53. data/proto_docs/google/cloud/resourcemanager/v3/folders.rb +25 -19
  54. data/proto_docs/google/cloud/resourcemanager/v3/organizations.rb +13 -11
  55. data/proto_docs/google/cloud/resourcemanager/v3/projects.rb +41 -45
  56. data/proto_docs/google/cloud/resourcemanager/v3/tag_bindings.rb +104 -15
  57. data/proto_docs/google/cloud/resourcemanager/v3/tag_holds.rb +161 -0
  58. data/proto_docs/google/cloud/resourcemanager/v3/tag_keys.rb +93 -27
  59. data/proto_docs/google/cloud/resourcemanager/v3/tag_values.rb +52 -29
  60. data/proto_docs/google/iam/v1/policy.rb +8 -4
  61. metadata +14 -2
@@ -0,0 +1,54 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/cloud/resourcemanager/v3/tag_holds.proto for package 'Google.Cloud.ResourceManager.V3'
3
+ # Original file comments:
4
+ # Copyright 2023 Google LLC
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'grpc'
20
+ require 'google/cloud/resourcemanager/v3/tag_holds_pb'
21
+
22
+ module Google
23
+ module Cloud
24
+ module ResourceManager
25
+ module V3
26
+ module TagHolds
27
+ # Allow users to create and manage TagHolds for TagValues. TagHolds represent
28
+ # the use of a Tag Value that is not captured by TagBindings but
29
+ # should still block TagValue deletion (such as a reference in a policy
30
+ # condition). This service provides isolated failure domains by cloud location
31
+ # so that TagHolds can be managed in the same location as their usage.
32
+ class Service
33
+
34
+ include ::GRPC::GenericService
35
+
36
+ self.marshal_class_method = :encode
37
+ self.unmarshal_class_method = :decode
38
+ self.service_name = 'google.cloud.resourcemanager.v3.TagHolds'
39
+
40
+ # Creates a TagHold. Returns ALREADY_EXISTS if a TagHold with the same
41
+ # resource and origin exists under the same TagValue.
42
+ rpc :CreateTagHold, ::Google::Cloud::ResourceManager::V3::CreateTagHoldRequest, ::Google::Longrunning::Operation
43
+ # Deletes a TagHold.
44
+ rpc :DeleteTagHold, ::Google::Cloud::ResourceManager::V3::DeleteTagHoldRequest, ::Google::Longrunning::Operation
45
+ # Lists TagHolds under a TagValue.
46
+ rpc :ListTagHolds, ::Google::Cloud::ResourceManager::V3::ListTagHoldsRequest, ::Google::Cloud::ResourceManager::V3::ListTagHoldsResponse
47
+ end
48
+
49
+ Stub = Service.rpc_stub_class
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end
@@ -24,6 +24,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
24
24
  optional :create_time, :message, 6, "google.protobuf.Timestamp"
25
25
  optional :update_time, :message, 7, "google.protobuf.Timestamp"
26
26
  optional :etag, :string, 8
27
+ optional :purpose, :enum, 11, "google.cloud.resourcemanager.v3.Purpose"
28
+ map :purpose_data, :string, :string, 12
27
29
  end
28
30
  add_message "google.cloud.resourcemanager.v3.ListTagKeysRequest" do
29
31
  optional :parent, :string, 1
@@ -37,6 +39,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
37
39
  add_message "google.cloud.resourcemanager.v3.GetTagKeyRequest" do
38
40
  optional :name, :string, 1
39
41
  end
42
+ add_message "google.cloud.resourcemanager.v3.GetNamespacedTagKeyRequest" do
43
+ optional :name, :string, 1
44
+ end
40
45
  add_message "google.cloud.resourcemanager.v3.CreateTagKeyRequest" do
41
46
  optional :tag_key, :message, 1, "google.cloud.resourcemanager.v3.TagKey"
42
47
  optional :validate_only, :bool, 2
@@ -57,6 +62,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
57
62
  end
58
63
  add_message "google.cloud.resourcemanager.v3.DeleteTagKeyMetadata" do
59
64
  end
65
+ add_enum "google.cloud.resourcemanager.v3.Purpose" do
66
+ value :PURPOSE_UNSPECIFIED, 0
67
+ value :GCE_FIREWALL, 1
68
+ end
60
69
  end
61
70
  end
62
71
 
@@ -68,12 +77,14 @@ module Google
68
77
  ListTagKeysRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.ListTagKeysRequest").msgclass
69
78
  ListTagKeysResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.ListTagKeysResponse").msgclass
70
79
  GetTagKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.GetTagKeyRequest").msgclass
80
+ GetNamespacedTagKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.GetNamespacedTagKeyRequest").msgclass
71
81
  CreateTagKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.CreateTagKeyRequest").msgclass
72
82
  CreateTagKeyMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.CreateTagKeyMetadata").msgclass
73
83
  UpdateTagKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.UpdateTagKeyRequest").msgclass
74
84
  UpdateTagKeyMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.UpdateTagKeyMetadata").msgclass
75
85
  DeleteTagKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.DeleteTagKeyRequest").msgclass
76
86
  DeleteTagKeyMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.DeleteTagKeyMetadata").msgclass
87
+ Purpose = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.Purpose").enummodule
77
88
  end
78
89
  end
79
90
  end
@@ -38,10 +38,14 @@ module Google
38
38
  # Retrieves a TagKey. This method will return `PERMISSION_DENIED` if the
39
39
  # key does not exist or the user does not have permission to view it.
40
40
  rpc :GetTagKey, ::Google::Cloud::ResourceManager::V3::GetTagKeyRequest, ::Google::Cloud::ResourceManager::V3::TagKey
41
+ # Retrieves a TagKey by its namespaced name.
42
+ # This method will return `PERMISSION_DENIED` if the key does not exist
43
+ # or the user does not have permission to view it.
44
+ rpc :GetNamespacedTagKey, ::Google::Cloud::ResourceManager::V3::GetNamespacedTagKeyRequest, ::Google::Cloud::ResourceManager::V3::TagKey
41
45
  # Creates a new TagKey. If another request with the same parameters is
42
46
  # sent while the original request is in process, the second request
43
- # will receive an error. A maximum of 300 TagKeys can exist under a parent at
44
- # any given time.
47
+ # will receive an error. A maximum of 1000 TagKeys can exist under a parent
48
+ # at any given time.
45
49
  rpc :CreateTagKey, ::Google::Cloud::ResourceManager::V3::CreateTagKeyRequest, ::Google::Longrunning::Operation
46
50
  # Updates the attributes of the TagKey resource.
47
51
  rpc :UpdateTagKey, ::Google::Cloud::ResourceManager::V3::UpdateTagKeyRequest, ::Google::Longrunning::Operation
@@ -37,6 +37,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
37
37
  add_message "google.cloud.resourcemanager.v3.GetTagValueRequest" do
38
38
  optional :name, :string, 1
39
39
  end
40
+ add_message "google.cloud.resourcemanager.v3.GetNamespacedTagValueRequest" do
41
+ optional :name, :string, 1
42
+ end
40
43
  add_message "google.cloud.resourcemanager.v3.CreateTagValueRequest" do
41
44
  optional :tag_value, :message, 1, "google.cloud.resourcemanager.v3.TagValue"
42
45
  optional :validate_only, :bool, 2
@@ -68,6 +71,7 @@ module Google
68
71
  ListTagValuesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.ListTagValuesRequest").msgclass
69
72
  ListTagValuesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.ListTagValuesResponse").msgclass
70
73
  GetTagValueRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.GetTagValueRequest").msgclass
74
+ GetNamespacedTagValueRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.GetNamespacedTagValueRequest").msgclass
71
75
  CreateTagValueRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.CreateTagValueRequest").msgclass
72
76
  CreateTagValueMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.CreateTagValueMetadata").msgclass
73
77
  UpdateTagValueRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.resourcemanager.v3.UpdateTagValueRequest").msgclass
@@ -35,13 +35,16 @@ module Google
35
35
 
36
36
  # Lists all TagValues for a specific TagKey.
37
37
  rpc :ListTagValues, ::Google::Cloud::ResourceManager::V3::ListTagValuesRequest, ::Google::Cloud::ResourceManager::V3::ListTagValuesResponse
38
- # Retrieves TagValue. If the TagValue or namespaced name does not exist, or
39
- # if the user does not have permission to view it, this method will return
40
- # `PERMISSION_DENIED`.
38
+ # Retrieves a TagValue. This method will return `PERMISSION_DENIED` if the
39
+ # value does not exist or the user does not have permission to view it.
41
40
  rpc :GetTagValue, ::Google::Cloud::ResourceManager::V3::GetTagValueRequest, ::Google::Cloud::ResourceManager::V3::TagValue
41
+ # Retrieves a TagValue by its namespaced name.
42
+ # This method will return `PERMISSION_DENIED` if the value does not exist
43
+ # or the user does not have permission to view it.
44
+ rpc :GetNamespacedTagValue, ::Google::Cloud::ResourceManager::V3::GetNamespacedTagValueRequest, ::Google::Cloud::ResourceManager::V3::TagValue
42
45
  # Creates a TagValue as a child of the specified TagKey. If a another
43
46
  # request with the same parameters is sent while the original request is in
44
- # process the second request will receive an error. A maximum of 300
47
+ # process the second request will receive an error. A maximum of 1000
45
48
  # TagValues can exist under a TagKey at any given time.
46
49
  rpc :CreateTagValue, ::Google::Cloud::ResourceManager::V3::CreateTagValueRequest, ::Google::Longrunning::Operation
47
50
  # Updates the attributes of the TagValue resource.
@@ -35,7 +35,9 @@ module Google
35
35
  # Details about how and where to publish client libraries.
36
36
  # @!attribute [rw] version
37
37
  # @return [::String]
38
- # Version of the API to apply these settings to.
38
+ # Version of the API to apply these settings to. This is the full protobuf
39
+ # package for the API, ending in the version element.
40
+ # Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
39
41
  # @!attribute [rw] launch_stage
40
42
  # @return [::Google::Api::LaunchStage]
41
43
  # Launch stage of this version of the API.
@@ -81,7 +83,7 @@ module Google
81
83
  # long-running operation pattern.
82
84
  # @!attribute [rw] new_issue_uri
83
85
  # @return [::String]
84
- # Link to a place that API users can report issues. Example:
86
+ # Link to a *public* URI where users can report issues. Example:
85
87
  # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
88
  # @!attribute [rw] documentation_uri
87
89
  # @return [::String]
@@ -111,6 +113,10 @@ module Google
111
113
  # Client library settings. If the same version string appears multiple
112
114
  # times in this list, then the last one wins. Settings from earlier
113
115
  # settings with the same version string are discarded.
116
+ # @!attribute [rw] proto_reference_documentation_uri
117
+ # @return [::String]
118
+ # Optional link to proto reference documentation. Example:
119
+ # https://cloud.google.com/pubsub/lite/docs/reference/rpc
114
120
  class Publishing
115
121
  include ::Google::Protobuf::MessageExts
116
122
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -203,9 +209,57 @@ module Google
203
209
  # @!attribute [rw] common
204
210
  # @return [::Google::Api::CommonLanguageSettings]
205
211
  # Some settings.
212
+ # @!attribute [rw] renamed_services
213
+ # @return [::Google::Protobuf::Map{::String => ::String}]
214
+ # Map from original service names to renamed versions.
215
+ # This is used when the default generated types
216
+ # would cause a naming conflict. (Neither name is
217
+ # fully-qualified.)
218
+ # Example: Subscriber to SubscriberServiceApi.
219
+ # @!attribute [rw] renamed_resources
220
+ # @return [::Google::Protobuf::Map{::String => ::String}]
221
+ # Map from full resource types to the effective short name
222
+ # for the resource. This is used when otherwise resource
223
+ # named from different services would cause naming collisions.
224
+ # Example entry:
225
+ # "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
226
+ # @!attribute [rw] ignored_resources
227
+ # @return [::Array<::String>]
228
+ # List of full resource types to ignore during generation.
229
+ # This is typically used for API-specific Location resources,
230
+ # which should be handled by the generator as if they were actually
231
+ # the common Location resources.
232
+ # Example entry: "documentai.googleapis.com/Location"
233
+ # @!attribute [rw] forced_namespace_aliases
234
+ # @return [::Array<::String>]
235
+ # Namespaces which must be aliased in snippets due to
236
+ # a known (but non-generator-predictable) naming collision
237
+ # @!attribute [rw] handwritten_signatures
238
+ # @return [::Array<::String>]
239
+ # Method signatures (in the form "service.method(signature)")
240
+ # which are provided separately, so shouldn't be generated.
241
+ # Snippets *calling* these methods are still generated, however.
206
242
  class DotnetSettings
207
243
  include ::Google::Protobuf::MessageExts
208
244
  extend ::Google::Protobuf::MessageExts::ClassMethods
245
+
246
+ # @!attribute [rw] key
247
+ # @return [::String]
248
+ # @!attribute [rw] value
249
+ # @return [::String]
250
+ class RenamedServicesEntry
251
+ include ::Google::Protobuf::MessageExts
252
+ extend ::Google::Protobuf::MessageExts::ClassMethods
253
+ end
254
+
255
+ # @!attribute [rw] key
256
+ # @return [::String]
257
+ # @!attribute [rw] value
258
+ # @return [::String]
259
+ class RenamedResourcesEntry
260
+ include ::Google::Protobuf::MessageExts
261
+ extend ::Google::Protobuf::MessageExts::ClassMethods
262
+ end
209
263
  end
210
264
 
211
265
  # Settings for Ruby client libraries.
@@ -240,8 +294,8 @@ module Google
240
294
  # Example of a YAML configuration::
241
295
  #
242
296
  # publishing:
243
- # method_behavior:
244
- # - selector: CreateAdDomain
297
+ # method_settings:
298
+ # - selector: google.cloud.speech.v2.Speech.BatchRecognize
245
299
  # long_running:
246
300
  # initial_poll_delay:
247
301
  # seconds: 60 # 1 minute
@@ -299,6 +353,15 @@ module Google
299
353
 
300
354
  # Street View Org.
301
355
  STREET_VIEW = 4
356
+
357
+ # Shopping Org.
358
+ SHOPPING = 5
359
+
360
+ # Geo Org.
361
+ GEO = 6
362
+
363
+ # Generative AI - https://developers.generativeai.google
364
+ GENERATIVE_AI = 7
302
365
  end
303
366
 
304
367
  # To where should client libraries be published?
@@ -58,9 +58,9 @@ module Google
58
58
  # Output only. Timestamp when the folder was requested to be deleted.
59
59
  # @!attribute [r] etag
60
60
  # @return [::String]
61
- # Output only. A checksum computed by the server based on the current value of the folder
62
- # resource. This may be sent on update and delete requests to ensure the
63
- # client has an up-to-date value before proceeding.
61
+ # Output only. A checksum computed by the server based on the current value
62
+ # of the folder resource. This may be sent on update and delete requests to
63
+ # ensure the client has an up-to-date value before proceeding.
64
64
  class Folder
65
65
  include ::Google::Protobuf::MessageExts
66
66
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -91,15 +91,20 @@ module Google
91
91
  # The ListFolders request message.
92
92
  # @!attribute [rw] parent
93
93
  # @return [::String]
94
- # Required. The resource name of the organization or folder whose folders are
95
- # being listed.
96
- # Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
94
+ # Required. The name of the parent resource whose folders are being listed.
95
+ # Only children of this parent resource are listed; descendants are not
96
+ # listed.
97
+ #
98
+ # If the parent is a folder, use the value `folders/{folder_id}`. If the
99
+ # parent is an organization, use the value `organizations/{org_id}`.
100
+ #
97
101
  # Access to this method is controlled by checking the
98
102
  # `resourcemanager.folders.list` permission on the `parent`.
99
103
  # @!attribute [rw] page_size
100
104
  # @return [::Integer]
101
- # Optional. The maximum number of folders to return in the response.
102
- # If unspecified, server picks an appropriate default.
105
+ # Optional. The maximum number of folders to return in the response. The
106
+ # server can return fewer folders than requested. If unspecified, server
107
+ # picks an appropriate default.
103
108
  # @!attribute [rw] page_token
104
109
  # @return [::String]
105
110
  # Optional. A pagination token returned from a previous call to `ListFolders`
@@ -131,12 +136,13 @@ module Google
131
136
  # The request message for searching folders.
132
137
  # @!attribute [rw] page_size
133
138
  # @return [::Integer]
134
- # Optional. The maximum number of folders to return in the response.
135
- # If unspecified, server picks an appropriate default.
139
+ # Optional. The maximum number of folders to return in the response. The
140
+ # server can return fewer folders than requested. If unspecified, server
141
+ # picks an appropriate default.
136
142
  # @!attribute [rw] page_token
137
143
  # @return [::String]
138
- # Optional. A pagination token returned from a previous call to `SearchFolders`
139
- # that indicates from where search should continue.
144
+ # Optional. A pagination token returned from a previous call to
145
+ # `SearchFolders` that indicates from where search should continue.
140
146
  # @!attribute [rw] query
141
147
  # @return [::String]
142
148
  # Optional. Search criteria used to select the folders to return.
@@ -192,8 +198,8 @@ module Google
192
198
  # The CreateFolder request message.
193
199
  # @!attribute [rw] folder
194
200
  # @return [::Google::Cloud::ResourceManager::V3::Folder]
195
- # Required. The folder being created, only the display name and parent will be
196
- # consulted. All other fields will be ignored.
201
+ # Required. The folder being created, only the display name and parent will
202
+ # be consulted. All other fields will be ignored.
197
203
  class CreateFolderRequest
198
204
  include ::Google::Protobuf::MessageExts
199
205
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -222,8 +228,8 @@ module Google
222
228
  # change the `parent` field.
223
229
  # @!attribute [rw] folder
224
230
  # @return [::Google::Cloud::ResourceManager::V3::Folder]
225
- # Required. The new definition of the Folder. It must include the `name` field, which
226
- # cannot be changed.
231
+ # Required. The new definition of the Folder. It must include the `name`
232
+ # field, which cannot be changed.
227
233
  # @!attribute [rw] update_mask
228
234
  # @return [::Google::Protobuf::FieldMask]
229
235
  # Required. Fields to be updated.
@@ -247,9 +253,9 @@ module Google
247
253
  # Must be of the form folders/\\{folder_id}
248
254
  # @!attribute [rw] destination_parent
249
255
  # @return [::String]
250
- # Required. The resource name of the folder or organization which should be the
251
- # folder's new parent.
252
- # Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
256
+ # Required. The resource name of the folder or organization which should be
257
+ # the folder's new parent. Must be of the form `folders/{folder_id}` or
258
+ # `organizations/{org_id}`.
253
259
  class MoveFolderRequest
254
260
  include ::Google::Protobuf::MessageExts
255
261
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -51,9 +51,9 @@ module Google
51
51
  # Output only. Timestamp when the Organization was requested for deletion.
52
52
  # @!attribute [r] etag
53
53
  # @return [::String]
54
- # Output only. A checksum computed by the server based on the current value of the
55
- # Organization resource. This may be sent on update and delete requests to
56
- # ensure the client has an up-to-date value before proceeding.
54
+ # Output only. A checksum computed by the server based on the current value
55
+ # of the Organization resource. This may be sent on update and delete
56
+ # requests to ensure the client has an up-to-date value before proceeding.
57
57
  class Organization
58
58
  include ::Google::Protobuf::MessageExts
59
59
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -75,9 +75,9 @@ module Google
75
75
  # required. `organization_id` is no longer accepted.
76
76
  # @!attribute [rw] name
77
77
  # @return [::String]
78
- # Required. The resource name of the Organization to fetch. This is the organization's
79
- # relative path in the API, formatted as "organizations/[organizationId]".
80
- # For example, "organizations/1234".
78
+ # Required. The resource name of the Organization to fetch. This is the
79
+ # organization's relative path in the API, formatted as
80
+ # "organizations/[organizationId]". For example, "organizations/1234".
81
81
  class GetOrganizationRequest
82
82
  include ::Google::Protobuf::MessageExts
83
83
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -87,15 +87,17 @@ module Google
87
87
  # @!attribute [rw] page_size
88
88
  # @return [::Integer]
89
89
  # Optional. The maximum number of organizations to return in the response.
90
- # If unspecified, server picks an appropriate default.
90
+ # The server can return fewer organizations than requested. If unspecified,
91
+ # server picks an appropriate default.
91
92
  # @!attribute [rw] page_token
92
93
  # @return [::String]
93
- # Optional. A pagination token returned from a previous call to `SearchOrganizations`
94
- # that indicates from where listing should continue.
94
+ # Optional. A pagination token returned from a previous call to
95
+ # `SearchOrganizations` that indicates from where listing should continue.
95
96
  # @!attribute [rw] query
96
97
  # @return [::String]
97
- # Optional. An optional query string used to filter the Organizations to return in
98
- # the response. Query rules are case-insensitive.
98
+ # Optional. An optional query string used to filter the Organizations to
99
+ # return in the response. Query rules are case-insensitive.
100
+ #
99
101
  #
100
102
  # ```
101
103
  # | Field | Description |
@@ -26,8 +26,8 @@ module Google
26
26
  # Google Cloud Platform resources.
27
27
  # @!attribute [r] name
28
28
  # @return [::String]
29
- # Output only. The unique resource name of the project. It is an int64 generated number
30
- # prefixed by "projects/".
29
+ # Output only. The unique resource name of the project. It is an int64
30
+ # generated number prefixed by "projects/".
31
31
  #
32
32
  # Example: `projects/415104041262`
33
33
  # @!attribute [rw] parent
@@ -64,9 +64,9 @@ module Google
64
64
  # Output only. The time at which this resource was requested for deletion.
65
65
  # @!attribute [r] etag
66
66
  # @return [::String]
67
- # Output only. A checksum computed by the server based on the current value of the Project
68
- # resource. This may be sent on update and delete requests to ensure the
69
- # client has an up-to-date value before proceeding.
67
+ # Output only. A checksum computed by the server based on the current value
68
+ # of the Project resource. This may be sent on update and delete requests to
69
+ # ensure the client has an up-to-date value before proceeding.
70
70
  # @!attribute [rw] labels
71
71
  # @return [::Google::Protobuf::Map{::String => ::String}]
72
72
  # Optional. The labels associated with this project.
@@ -77,7 +77,7 @@ module Google
77
77
  # Label values must be between 0 and 63 characters long and must conform
78
78
  # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
79
79
  #
80
- # No more than 256 labels can be associated with a given resource.
80
+ # No more than 64 labels can be associated with a given resource.
81
81
  #
82
82
  # Clients should store labels in a representation such as JSON that does not
83
83
  # depend on specific characters being disallowed.
@@ -131,15 +131,17 @@ module Google
131
131
  # method.
132
132
  # @!attribute [rw] parent
133
133
  # @return [::String]
134
- # Required. The name of the parent resource to list projects under.
134
+ # Required. The name of the parent resource whose projects are being listed.
135
+ # Only children of this parent resource are listed; descendants are not
136
+ # listed.
135
137
  #
136
- # For example, setting this field to 'folders/1234' would list all projects
137
- # directly under that folder.
138
+ # If the parent is a folder, use the value `folders/{folder_id}`. If the
139
+ # parent is an organization, use the value `organizations/{org_id}`.
138
140
  # @!attribute [rw] page_token
139
141
  # @return [::String]
140
- # Optional. A pagination token returned from a previous call to [ListProjects]
141
- # [google.cloud.resourcemanager.v3.Projects.ListProjects]
142
- # that indicates from where listing should continue.
142
+ # Optional. A pagination token returned from a previous call to
143
+ # [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that
144
+ # indicates from where listing should continue.
143
145
  # @!attribute [rw] page_size
144
146
  # @return [::Integer]
145
147
  # Optional. The maximum number of projects to return in the response.
@@ -147,8 +149,8 @@ module Google
147
149
  # If unspecified, server picks an appropriate default.
148
150
  # @!attribute [rw] show_deleted
149
151
  # @return [::Boolean]
150
- # Optional. Indicate that projects in the `DELETE_REQUESTED` state should also be
151
- # returned. Normally only `ACTIVE` projects are returned.
152
+ # Optional. Indicate that projects in the `DELETE_REQUESTED` state should
153
+ # also be returned. Normally only `ACTIVE` projects are returned.
152
154
  class ListProjectsRequest
153
155
  include ::Google::Protobuf::MessageExts
154
156
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -192,48 +194,42 @@ module Google
192
194
  # @return [::String]
193
195
  # Optional. A query string for searching for projects that the caller has
194
196
  # `resourcemanager.projects.get` permission to. If multiple fields are
195
- # included in the query, the it will return results that match any of the
197
+ # included in the query, then it will return results that match any of the
196
198
  # fields. Some eligible fields are:
197
199
  #
198
- # ```
199
- # | Field | Description |
200
- # |-------------------------|----------------------------------------------|
201
- # | displayName, name | Filters by displayName. |
202
- # | parent | Project's parent. (for example: folders/123,
203
- # organizations/*) Prefer parent field over parent.type and parent.id. |
204
- # | parent.type | Parent's type: `folder` or `organization`. |
205
- # | parent.id | Parent's id number (for example: 123) |
206
- # | id, projectId | Filters by projectId. |
207
- # | state, lifecycleState | Filters by state. |
208
- # | labels | Filters by label name or value. |
209
- # | labels.<key> (where *key* is the name of a label) | Filters by label
210
- # name. |
211
- # ```
200
+ # - **`displayName`, `name`**: Filters by displayName.
201
+ # - **`parent`**: Project's parent (for example: `folders/123`,
202
+ # `organizations/*`). Prefer `parent` field over `parent.type` and
203
+ # `parent.id`.
204
+ # - **`parent.type`**: Parent's type: `folder` or `organization`.
205
+ # - **`parent.id`**: Parent's id number (for example: `123`).
206
+ # - **`id`, `projectId`**: Filters by projectId.
207
+ # - **`state`, `lifecycleState`**: Filters by state.
208
+ # - **`labels`**: Filters by label name or value.
209
+ # - **`labels.<key>` (where `<key>` is the name of a label)**: Filters by label
210
+ # name.
212
211
  #
213
212
  # Search expressions are case insensitive.
214
213
  #
215
214
  # Some examples queries:
216
215
  #
217
- # ```
218
- # | Query | Description |
219
- # |------------------|-----------------------------------------------------|
220
- # | name:how* | The project's name starts with "how". |
221
- # | name:Howl | The project's name is `Howl` or `howl`. |
222
- # | name:HOWL | Equivalent to above. |
223
- # | NAME:howl | Equivalent to above. |
224
- # | labels.color:* | The project has the label `color`. |
225
- # | labels.color:red | The project's label `color` has the value `red`. |
226
- # | labels.color:red&nbsp;labels.size:big | The project's label `color` has
227
- # the value `red` and its label `size` has the value `big`. |
228
- # ```
216
+ #
217
+ # - **`name:how*`**: The project's name starts with "how".
218
+ # - **`name:Howl`**: The project's name is `Howl` or `howl`.
219
+ # - **`name:HOWL`**: Equivalent to above.
220
+ # - **`NAME:howl`**: Equivalent to above.
221
+ # - **`labels.color:*`**: The project has the label `color`.
222
+ # - **`labels.color:red`**: The project's label `color` has the value `red`.
223
+ # - **`labels.color:red labels.size:big`**: The project's label `color` has
224
+ # the value `red` or its label `size` has the value `big`.
229
225
  #
230
226
  # If no query is specified, the call will return projects for which the user
231
227
  # has the `resourcemanager.projects.get` permission.
232
228
  # @!attribute [rw] page_token
233
229
  # @return [::String]
234
- # Optional. A pagination token returned from a previous call to [ListProjects]
235
- # [google.cloud.resourcemanager.v3.Projects.ListProjects]
236
- # that indicates from where listing should continue.
230
+ # Optional. A pagination token returned from a previous call to
231
+ # [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that
232
+ # indicates from where listing should continue.
237
233
  # @!attribute [rw] page_size
238
234
  # @return [::Integer]
239
235
  # Optional. The maximum number of projects to return in the response.
@@ -285,7 +281,7 @@ module Google
285
281
  #
286
282
  # If the `parent` field is set, the `resourcemanager.projects.create`
287
283
  # permission is checked on the parent resource. If no parent is set and
288
- # the authorization credentials belong to an Organziation, the parent
284
+ # the authorization credentials belong to an Organization, the parent
289
285
  # will be set to that Organization.
290
286
  class CreateProjectRequest
291
287
  include ::Google::Protobuf::MessageExts