lib/google/cloud/resource_manager/v3/folders/client.rb in google-cloud-resource_manager-v3-0.4.0 vs lib/google/cloud/resource_manager/v3/folders/client.rb in google-cloud-resource_manager-v3-0.5.0

- old
+ new

@@ -301,18 +301,23 @@ # Pass arguments to `list_folders` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] - # Required. The resource name of the organization or folder whose folders are - # being listed. - # Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. + # Required. The name of the parent resource whose folders are being listed. + # Only children of this parent resource are listed; descendants are not + # listed. + # + # If the parent is a folder, use the value `folders/{folder_id}`. If the + # parent is an organization, use the value `organizations/{org_id}`. + # # Access to this method is controlled by checking the # `resourcemanager.folders.list` permission on the `parent`. # @param page_size [::Integer] - # Optional. The maximum number of folders to return in the response. - # If unspecified, server picks an appropriate default. + # Optional. The maximum number of folders to return in the response. The + # server can return fewer folders than requested. If unspecified, server + # picks an appropriate default. # @param page_token [::String] # Optional. A pagination token returned from a previous call to `ListFolders` # that indicates where this listing should continue from. # @param show_deleted [::Boolean] # Optional. Controls whether folders in the @@ -402,15 +407,16 @@ # Pass arguments to `search_folders` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param page_size [::Integer] - # Optional. The maximum number of folders to return in the response. - # If unspecified, server picks an appropriate default. + # Optional. The maximum number of folders to return in the response. The + # server can return fewer folders than requested. If unspecified, server + # picks an appropriate default. # @param page_token [::String] - # Optional. A pagination token returned from a previous call to `SearchFolders` - # that indicates from where search should continue. + # Optional. A pagination token returned from a previous call to + # `SearchFolders` that indicates from where search should continue. # @param query [::String] # Optional. Search criteria used to select the folders to return. # If no search criteria is specified then all accessible folders will be # returned. # @@ -546,12 +552,12 @@ # Pass arguments to `create_folder` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param folder [::Google::Cloud::ResourceManager::V3::Folder, ::Hash] - # Required. The folder being created, only the display name and parent will be - # consulted. All other fields will be ignored. + # Required. The folder being created, only the display name and parent will + # be consulted. All other fields will be ignored. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # @@ -617,11 +623,13 @@ ## # 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 {::Google::Cloud::ResourceManager::V3::Folders::Client#create_folder CreateFolder} documentation. + # described in the + # {::Google::Cloud::ResourceManager::V3::Folders::Client#create_folder 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}]`. @@ -646,12 +654,12 @@ # Pass arguments to `update_folder` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param folder [::Google::Cloud::ResourceManager::V3::Folder, ::Hash] - # Required. The new definition of the Folder. It must include the `name` field, which - # cannot be changed. + # Required. The new definition of the Folder. It must include the `name` + # field, which cannot be changed. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Required. Fields to be updated. # Only the `display_name` can be updated. # # @yield [response, operation] Access the result along with the RPC operation @@ -739,13 +747,13 @@ # 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 - # {::Google::Cloud::ResourceManager::V3::Folders::Client#create_folder CreateFolder} documentation. - # The caller must have `resourcemanager.folders.move` permission on the - # folder's current and proposed new parent. + # {::Google::Cloud::ResourceManager::V3::Folders::Client#create_folder CreateFolder} + # documentation. The caller must have `resourcemanager.folders.move` + # permission on the folder's current and proposed new parent. # # @overload move_folder(request, options = nil) # Pass arguments to `move_folder` via a request object, either of type # {::Google::Cloud::ResourceManager::V3::MoveFolderRequest} or an equivalent Hash. # @@ -762,13 +770,13 @@ # # @param name [::String] # Required. The resource name of the Folder to move. # Must be of the form folders/\\{folder_id} # @param destination_parent [::String] - # Required. The resource name of the folder or organization which should be the - # folder's new parent. - # Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. + # Required. The resource name of the folder or organization which should be + # the folder's new parent. Must be of the form `folders/{folder_id}` or + # `organizations/{org_id}`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # @@ -840,15 +848,17 @@ raise ::Google::Cloud::Error.from_error(e) end ## # Requests deletion of a folder. The folder is moved into the - # {::Google::Cloud::ResourceManager::V3::Folder::State::DELETE_REQUESTED 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 {::Google::Cloud::ResourceManager::V3::Folder::State::ACTIVE ACTIVE} state. - # If called on a folder in {::Google::Cloud::ResourceManager::V3::Folder::State::DELETE_REQUESTED DELETE_REQUESTED} + # {::Google::Cloud::ResourceManager::V3::Folder::State::DELETE_REQUESTED 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 + # {::Google::Cloud::ResourceManager::V3::Folder::State::ACTIVE ACTIVE} state. If + # called on a folder in + # {::Google::Cloud::ResourceManager::V3::Folder::State::DELETE_REQUESTED DELETE_REQUESTED} # state the operation will result in a no-op success. # The caller must have `resourcemanager.folders.delete` permission on the # identified folder. # # @overload delete_folder(request, options = nil) @@ -942,18 +952,20 @@ raise ::Google::Cloud::Error.from_error(e) end ## # Cancels the deletion request for a folder. This method may be called on a - # folder in any state. If the folder is in the {::Google::Cloud::ResourceManager::V3::Folder::State::ACTIVE ACTIVE} - # state the result will be a no-op success. In order to succeed, the folder's - # parent must be in the {::Google::Cloud::ResourceManager::V3::Folder::State::ACTIVE ACTIVE} state. In addition, - # reintroducing the folder into the tree must not violate folder naming, - # height, and fanout constraints described in the - # {::Google::Cloud::ResourceManager::V3::Folders::Client#create_folder CreateFolder} documentation. - # The caller must have `resourcemanager.folders.undelete` permission on the - # identified folder. + # folder in any state. If the folder is in the + # {::Google::Cloud::ResourceManager::V3::Folder::State::ACTIVE ACTIVE} state the + # result will be a no-op success. In order to succeed, the folder's parent + # must be in the + # {::Google::Cloud::ResourceManager::V3::Folder::State::ACTIVE ACTIVE} state. In + # addition, reintroducing the folder into the tree must not violate folder + # naming, height, and fanout constraints described in the + # {::Google::Cloud::ResourceManager::V3::Folders::Client#create_folder CreateFolder} + # documentation. The caller must have `resourcemanager.folders.undelete` + # permission on the identified folder. # # @overload undelete_folder(request, options = nil) # Pass arguments to `undelete_folder` via a request object, either of type # {::Google::Cloud::ResourceManager::V3::UndeleteFolderRequest} or an equivalent Hash. # @@ -1369,12 +1381,12 @@ # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object - # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html)) + # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object - # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html)) + # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) # * (`GRPC::Core::Channel`) a gRPC channel with included credentials # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope