Class: Google::Cloud::ResourceManager::V3::Folders::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::ResourceManager::V3::Folders::Rest::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/resource_manager/v3/folders/rest/client.rb
Overview
REST client for the Folders service.
Manages Cloud Platform folder resources. Folders can be used to organize the resources under an organization and to control the policies applied to groups of resources.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#operations_client ⇒ ::Google::Cloud::ResourceManager::V3::Folders::Rest::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the Folders Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the Folders Client instance.
-
#create_folder(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Creates a folder in the resource hierarchy.
-
#delete_folder(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Requests deletion of a folder.
-
#get_folder(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::ResourceManager::V3::Folder
Retrieves a folder identified by the supplied resource name.
-
#get_iam_policy(request, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::Policy
Gets the access control policy for a folder.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new Folders REST client object.
-
#list_folders(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ResourceManager::V3::Folder>
Lists the folders that are direct descendants of supplied parent resource.
-
#move_folder(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Moves a folder under a new resource parent.
-
#search_folders(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ResourceManager::V3::Folder>
Search for folders that match specific filter criteria.
-
#set_iam_policy(request, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::Policy
Sets the access control policy on a folder, replacing any existing policy.
-
#test_iam_permissions(request, options = nil) {|result, operation| ... } ⇒ ::Google::Iam::V1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified folder.
-
#undelete_folder(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Cancels the deletion request for a folder.
-
#universe_domain ⇒ String
The effective universe domain.
-
#update_folder(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Updates a folder, changing its
display_name
.
Methods included from Paths
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new Folders REST client object.
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 154 def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = ::Google::Cloud::ResourceManager::V3::Folders::Rest::Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.universe_domain end @folders_stub = ::Google::Cloud::ResourceManager::V3::Folders::Rest::ServiceStub.new( endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, credentials: credentials ) end |
Instance Attribute Details
#operations_client ⇒ ::Google::Cloud::ResourceManager::V3::Folders::Rest::Operations (readonly)
Get the associated client for long-running operations.
197 198 199 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 197 def operations_client @operations_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the Folders Client class.
See Configuration for a description of the configuration fields.
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 63 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "ResourceManager", "V3"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.get_folder.timeout = 60.0 default_config.rpcs.get_folder.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.list_folders.timeout = 60.0 default_config.rpcs.list_folders.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.search_folders.timeout = 60.0 default_config.rpcs.create_folder.timeout = 60.0 default_config.rpcs.update_folder.timeout = 60.0 default_config.rpcs.move_folder.timeout = 60.0 default_config.rpcs.delete_folder.timeout = 60.0 default_config.rpcs.undelete_folder.timeout = 60.0 default_config.rpcs.get_iam_policy.timeout = 60.0 default_config.rpcs.get_iam_policy.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.set_iam_policy.timeout = 60.0 default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the Folders Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
124 125 126 127 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 124 def configure yield @config if block_given? @config end |
#create_folder(request, options = nil) ⇒ ::Gapic::Operation #create_folder(folder: nil) ⇒ ::Gapic::Operation
Creates a folder in the resource hierarchy.
Returns an Operation
which can be used to track the progress of the
folder creation workflow.
Upon success, the Operation.response
field will be populated with the
created Folder.
In order to succeed, the addition of this new folder must not violate the folder naming, height, or fanout constraints.
- The folder's
display_name
must be distinct from all other folders that share its parent. - The addition of the folder must not cause the active folder hierarchy to exceed a height of 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; this provides additional headroom when moving folders that contain deleted folders.
- The addition of the folder must not cause the total number of folders under its parent to exceed 300.
If the operation fails due to a folder constraint violation, some errors
may be returned by the CreateFolder
request, with status code
FAILED_PRECONDITION
and an error description. Other folder constraint
violations will be communicated in the Operation
, with the specific
PreconditionFailure
returned in the details list in the Operation.error
field.
The caller must have resourcemanager.folders.create
permission on the
identified parent.
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 594 def create_folder request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::CreateFolderRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_folder..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ResourceManager::V3::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.create_folder.timeout, metadata: , retry_policy: @config.rpcs.create_folder.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @folders_stub.create_folder request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_folder(request, options = nil) ⇒ ::Gapic::Operation #delete_folder(name: nil) ⇒ ::Gapic::Operation
Requests deletion of a folder. The folder is moved into the
DELETE_REQUESTED
state immediately, and is deleted approximately 30 days later. This method
may only be called on an empty folder, where a folder is empty if it
doesn't contain any folders or projects in the
ACTIVE state. If
called on a folder in
DELETE_REQUESTED
state the operation will result in a no-op success.
The caller must have resourcemanager.folders.delete
permission on the
identified folder.
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 904 def delete_folder request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::DeleteFolderRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_folder..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ResourceManager::V3::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.delete_folder.timeout, metadata: , retry_policy: @config.rpcs.delete_folder.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @folders_stub.delete_folder request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#get_folder(request, options = nil) ⇒ ::Google::Cloud::ResourceManager::V3::Folder #get_folder(name: nil) ⇒ ::Google::Cloud::ResourceManager::V3::Folder
Retrieves a folder identified by the supplied resource name.
Valid folder resource names have the format folders/{folder_id}
(for example, folders/1234
).
The caller must have resourcemanager.folders.get
permission on the
identified folder.
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 249 def get_folder request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::GetFolderRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_folder..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ResourceManager::V3::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.get_folder.timeout, metadata: , retry_policy: @config.rpcs.get_folder.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @folders_stub.get_folder request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#get_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy #get_iam_policy(resource: nil, options: nil) ⇒ ::Google::Iam::V1::Policy
Gets the access control policy for a folder. The returned policy may be
empty if no such policy or resource exists. The resource
field should
be the folder's resource name, for example: "folders/1234".
The caller must have resourcemanager.folders.getIamPolicy
permission
on the identified folder.
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 1088 def get_iam_policy request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::GetIamPolicyRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_iam_policy..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ResourceManager::V3::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.get_iam_policy.timeout, metadata: , retry_policy: @config.rpcs.get_iam_policy.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @folders_stub.get_iam_policy request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#list_folders(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ResourceManager::V3::Folder> #list_folders(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ResourceManager::V3::Folder>
Lists the folders that are direct descendants of supplied parent resource.
list()
provides a strongly consistent view of the folders underneath
the specified parent resource.
list()
returns folders sorted based upon the (ascending) lexical ordering
of their display_name.
The caller must have resourcemanager.folders.list
permission on the
identified parent.
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 356 def list_folders request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::ListFoldersRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_folders..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ResourceManager::V3::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_folders.timeout, metadata: , retry_policy: @config.rpcs.list_folders.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @folders_stub.list_folders request, do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @folders_stub, :list_folders, "folders", request, result, yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#move_folder(request, options = nil) ⇒ ::Gapic::Operation #move_folder(name: nil, destination_parent: nil) ⇒ ::Gapic::Operation
Moves a folder under a new resource parent.
Returns an Operation
which can be used to track the progress of the
folder move workflow.
Upon success, the Operation.response
field will be populated with the
moved folder.
Upon failure, a FolderOperationError
categorizing the failure cause will
be returned - if the failure occurs synchronously then the
FolderOperationError
will be returned in the Status.details
field.
If it occurs asynchronously, then the FolderOperation will be returned
in the Operation.error
field.
In addition, the Operation.metadata
field will be populated with a
FolderOperation
message as an aid to stateless clients.
Folder moves will be rejected if they violate either the naming, height,
or fanout constraints described in the
CreateFolder
documentation. The caller must have resourcemanager.folders.move
permission on the folder's current and proposed new parent.
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 807 def move_folder request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::MoveFolderRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.move_folder..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ResourceManager::V3::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.move_folder.timeout, metadata: , retry_policy: @config.rpcs.move_folder.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @folders_stub.move_folder request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#search_folders(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ResourceManager::V3::Folder> #search_folders(page_size: nil, page_token: nil, query: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ResourceManager::V3::Folder>
Search for folders that match specific filter criteria.
search()
provides an eventually consistent view of the folders a user has
access to which meet the specified filter criteria.
This will only return folders on which the caller has the
permission resourcemanager.folders.get
.
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 481 def search_folders request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::SearchFoldersRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.search_folders..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ResourceManager::V3::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.search_folders.timeout, metadata: , retry_policy: @config.rpcs.search_folders.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @folders_stub.search_folders request, do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @folders_stub, :search_folders, "folders", request, result, yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#set_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy #set_iam_policy(resource: nil, policy: nil, update_mask: nil) ⇒ ::Google::Iam::V1::Policy
Sets the access control policy on a folder, replacing any existing policy.
The resource
field should be the folder's resource name, for example:
"folders/1234".
The caller must have resourcemanager.folders.setIamPolicy
permission
on the identified folder.
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 1182 def set_iam_policy request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::SetIamPolicyRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.set_iam_policy..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ResourceManager::V3::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.set_iam_policy.timeout, metadata: , retry_policy: @config.rpcs.set_iam_policy.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @folders_stub.set_iam_policy request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#test_iam_permissions(request, options = nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse #test_iam_permissions(resource: nil, permissions: nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified folder.
The resource
field should be the folder's resource name,
for example: "folders/1234".
There are no permissions required for making this API call.
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 1270 def request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::TestIamPermissionsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs...to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ResourceManager::V3::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs..timeout, metadata: , retry_policy: @config.rpcs..retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @folders_stub. request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#undelete_folder(request, options = nil) ⇒ ::Gapic::Operation #undelete_folder(name: nil) ⇒ ::Gapic::Operation
Cancels the deletion request for a folder. This method may be called on a
folder in any state. If the folder is in the
ACTIVE state the
result will be a no-op success. In order to succeed, the folder's parent
must be in the
ACTIVE state. In
addition, reintroducing the folder into the tree must not violate folder
naming, height, and fanout constraints described in the
CreateFolder
documentation. The caller must have resourcemanager.folders.undelete
permission on the identified folder.
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 1001 def undelete_folder request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::UndeleteFolderRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.undelete_folder..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ResourceManager::V3::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.undelete_folder.timeout, metadata: , retry_policy: @config.rpcs.undelete_folder.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @folders_stub.undelete_folder request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
134 135 136 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 134 def universe_domain @folders_stub.universe_domain end |
#update_folder(request, options = nil) ⇒ ::Gapic::Operation #update_folder(folder: nil, update_mask: nil) ⇒ ::Gapic::Operation
Updates a folder, changing its display_name
.
Changes to the folder display_name
will be rejected if they violate
either the display_name
formatting rules or the naming constraints
described in the
CreateFolder
documentation.
The folder's display_name
must start and end with a letter or digit,
may contain letters, digits, spaces, hyphens and underscores and can be
between 3 and 30 characters. This is captured by the regular expression:
[\p{L}\p{N}][\p{L}\p{N}_- ]{1,28}[\p{L}\p{N}]
.
The caller must have resourcemanager.folders.update
permission on the
identified folder.
If the update fails due to the unique name constraint then a
PreconditionFailure
explaining this violation will be returned
in the Status.details field.
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'lib/google/cloud/resource_manager/v3/folders/rest/client.rb', line 700 def update_folder request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::UpdateFolderRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_folder..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ResourceManager::V3::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.update_folder.timeout, metadata: , retry_policy: @config.rpcs.update_folder.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @folders_stub.update_folder request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |