Class: Google::Cloud::ResourceManager::V3::Folders::Client
- Inherits:
-
Object
- Object
- Google::Cloud::ResourceManager::V3::Folders::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/resource_manager/v3/folders/client.rb
Overview
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::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) {|response, operation| ... } ⇒ ::Gapic::Operation
Creates a folder in the resource hierarchy.
-
#delete_folder(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Requests deletion of a folder.
-
#get_folder(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::ResourceManager::V3::Folder
Retrieves a folder identified by the supplied resource name.
-
#get_iam_policy(request, options = nil) {|response, operation| ... } ⇒ ::Google::Iam::V1::Policy
Gets the access control policy for a folder.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new Folders client object.
-
#list_folders(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ResourceManager::V3::Folder>
Lists the folders that are direct descendants of supplied parent resource.
-
#move_folder(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Moves a folder under a new resource parent.
-
#search_folders(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ResourceManager::V3::Folder>
Search for folders that match specific filter criteria.
-
#set_iam_policy(request, options = nil) {|response, operation| ... } ⇒ ::Google::Iam::V1::Policy
Sets the access control policy on a folder, replacing any existing policy.
-
#test_iam_permissions(request, options = nil) {|response, operation| ... } ⇒ ::Google::Iam::V1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified folder.
-
#undelete_folder(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Cancels the deletion request for a folder.
-
#update_folder(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Updates a folder, changing its
display_name
.
Methods included from Paths
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new Folders client object.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 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 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 140 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/resourcemanager/v3/folders_services_pb" # 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 == Client.configure.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 = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @folders_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::ResourceManager::V3::Folders::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Instance Attribute Details
#operations_client ⇒ ::Google::Cloud::ResourceManager::V3::Folders::Operations (readonly)
Get the associated client for long-running operations.
186 187 188 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 186 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.
58 59 60 61 62 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 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 58 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.
119 120 121 122 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 119 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.
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 504 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 [:"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.call_rpc :create_folder, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => 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.
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 753 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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .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.call_rpc :delete_folder, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => 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.
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 224 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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .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.call_rpc :get_folder, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => 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.
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 939 940 941 942 943 944 945 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 908 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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "resource" => request.resource } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .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.call_rpc :get_iam_policy, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_folders(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ResourceManager::V3::Folder> #list_folders(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) ⇒ ::Gapic::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.
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 312 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 [:"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.call_rpc :list_folders, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @folders_stub, :list_folders, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => 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.
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 675 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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .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.call_rpc :move_folder, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#search_folders(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::ResourceManager::V3::Folder> #search_folders(page_size: nil, page_token: nil, query: nil) ⇒ ::Gapic::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
.
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 414 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 [:"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.call_rpc :search_folders, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @folders_stub, :search_folders, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => 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) ⇒ ::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.
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 986 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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "resource" => request.resource } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .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.call_rpc :set_iam_policy, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => 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.
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 1064 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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "resource" => request.resource } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .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.call_rpc :test_iam_permissions, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => 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.
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 831 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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .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.call_rpc :undelete_folder, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) 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.
585 586 587 588 589 590 591 592 593 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 |
# File 'lib/google/cloud/resource_manager/v3/folders/client.rb', line 585 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 [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "folder.name" => request.folder.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .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.call_rpc :update_folder, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |