lib/google/cloud/resource_manager/v3/folders/client.rb in google-cloud-resource_manager-v3-0.1.0 vs lib/google/cloud/resource_manager/v3/folders/client.rb in google-cloud-resource_manager-v3-0.1.1

- old
+ new

@@ -219,10 +219,25 @@ # # @return [::Google::Cloud::ResourceManager::V3::Folder] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # + # @example Basic example + # require "google/cloud/resource_manager/v3" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::ResourceManager::V3::Folders::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::ResourceManager::V3::GetFolderRequest.new + # + # # Call the get_folder method. + # result = client.get_folder request + # + # # The returned object is of type Google::Cloud::ResourceManager::V3::Folder. + # p result + # def get_folder request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::GetFolderRequest @@ -236,13 +251,15 @@ metadata[:"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 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - header_params = { - "name" => request.name - } + header_params = {} + if request.name + header_params["name"] = request.name + end + request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_folder.timeout, metadata: metadata, @@ -307,10 +324,31 @@ # # @return [::Gapic::PagedEnumerable<::Google::Cloud::ResourceManager::V3::Folder>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # + # @example Basic example + # require "google/cloud/resource_manager/v3" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::ResourceManager::V3::Folders::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::ResourceManager::V3::ListFoldersRequest.new + # + # # Call the list_folders method. + # result = client.list_folders request + # + # # The returned object is of type Gapic::PagedEnumerable. You can + # # iterate over all elements by calling #each, and the enumerable + # # will lazily make API calls to fetch subsequent pages. Other + # # methods are also available for managing paging directly. + # result.each do |response| + # # Each element is of type ::Google::Cloud::ResourceManager::V3::Folder. + # p response + # end + # def list_folders request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::ListFoldersRequest @@ -382,15 +420,17 @@ # can be used along with the suffix wildcard symbol `*`. # # The `displayName` field in a query expression should use escaped quotes # for values that include whitespace to prevent unexpected behavior. # + # ``` # | Field | Description | # |-------------------------|----------------------------------------| # | displayName | Filters by displayName. | # | parent | Filters by parent (for example: folders/123). | # | state, lifecycleState | Filters by state. | + # ``` # # Some example queries are: # # * Query `displayName=Test*` returns Folder resources whose display name # starts with "Test". @@ -409,10 +449,31 @@ # # @return [::Gapic::PagedEnumerable<::Google::Cloud::ResourceManager::V3::Folder>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # + # @example Basic example + # require "google/cloud/resource_manager/v3" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::ResourceManager::V3::Folders::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::ResourceManager::V3::SearchFoldersRequest.new + # + # # Call the search_folders method. + # result = client.search_folders request + # + # # The returned object is of type Gapic::PagedEnumerable. You can + # # iterate over all elements by calling #each, and the enumerable + # # will lazily make API calls to fetch subsequent pages. Other + # # methods are also available for managing paging directly. + # result.each do |response| + # # Each element is of type ::Google::Cloud::ResourceManager::V3::Folder. + # p response + # end + # def search_folders request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::SearchFoldersRequest @@ -499,10 +560,32 @@ # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # + # @example Basic example + # require "google/cloud/resource_manager/v3" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::ResourceManager::V3::Folders::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::ResourceManager::V3::CreateFolderRequest.new + # + # # Call the create_folder method. + # result = client.create_folder request + # + # # The returned object is of type Gapic::Operation. You can use this + # # object to check the status of an operation, cancel it, or wait + # # for results. Here is how to block until completion: + # result.wait_until_done! timeout: 60 + # if result.response? + # p result.response + # else + # puts "Error!" + # end + # def create_folder request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::CreateFolderRequest @@ -580,10 +663,32 @@ # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # + # @example Basic example + # require "google/cloud/resource_manager/v3" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::ResourceManager::V3::Folders::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::ResourceManager::V3::UpdateFolderRequest.new + # + # # Call the update_folder method. + # result = client.update_folder request + # + # # The returned object is of type Gapic::Operation. You can use this + # # object to check the status of an operation, cancel it, or wait + # # for results. Here is how to block until completion: + # result.wait_until_done! timeout: 60 + # if result.response? + # p result.response + # else + # puts "Error!" + # end + # def update_folder request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::UpdateFolderRequest @@ -597,13 +702,15 @@ metadata[:"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 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - header_params = { - "folder.name" => request.folder.name - } + header_params = {} + if request.folder&.name + header_params["folder.name"] = request.folder.name + end + request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_folder.timeout, metadata: metadata, @@ -670,10 +777,32 @@ # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # + # @example Basic example + # require "google/cloud/resource_manager/v3" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::ResourceManager::V3::Folders::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::ResourceManager::V3::MoveFolderRequest.new + # + # # Call the move_folder method. + # result = client.move_folder request + # + # # The returned object is of type Gapic::Operation. You can use this + # # object to check the status of an operation, cancel it, or wait + # # for results. Here is how to block until completion: + # result.wait_until_done! timeout: 60 + # if result.response? + # p result.response + # else + # puts "Error!" + # end + # def move_folder request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::MoveFolderRequest @@ -687,13 +816,15 @@ metadata[:"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 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - header_params = { - "name" => request.name - } + header_params = {} + if request.name + header_params["name"] = request.name + end + request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.move_folder.timeout, metadata: metadata, @@ -748,10 +879,32 @@ # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # + # @example Basic example + # require "google/cloud/resource_manager/v3" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::ResourceManager::V3::Folders::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::ResourceManager::V3::DeleteFolderRequest.new + # + # # Call the delete_folder method. + # result = client.delete_folder request + # + # # The returned object is of type Gapic::Operation. You can use this + # # object to check the status of an operation, cancel it, or wait + # # for results. Here is how to block until completion: + # result.wait_until_done! timeout: 60 + # if result.response? + # p result.response + # else + # puts "Error!" + # end + # def delete_folder request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::DeleteFolderRequest @@ -765,13 +918,15 @@ metadata[:"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 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - header_params = { - "name" => request.name - } + header_params = {} + if request.name + header_params["name"] = request.name + end + request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_folder.timeout, metadata: metadata, @@ -826,10 +981,32 @@ # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # + # @example Basic example + # require "google/cloud/resource_manager/v3" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::ResourceManager::V3::Folders::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::ResourceManager::V3::UndeleteFolderRequest.new + # + # # Call the undelete_folder method. + # result = client.undelete_folder request + # + # # The returned object is of type Gapic::Operation. You can use this + # # object to check the status of an operation, cancel it, or wait + # # for results. Here is how to block until completion: + # result.wait_until_done! timeout: 60 + # if result.response? + # p result.response + # else + # puts "Error!" + # end + # def undelete_folder request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ResourceManager::V3::UndeleteFolderRequest @@ -843,13 +1020,15 @@ metadata[:"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 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - header_params = { - "name" => request.name - } + header_params = {} + if request.name + header_params["name"] = request.name + end + request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.undelete_folder.timeout, metadata: metadata, @@ -903,10 +1082,25 @@ # # @return [::Google::Iam::V1::Policy] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # + # @example Basic example + # require "google/cloud/resource_manager/v3" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::ResourceManager::V3::Folders::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Iam::V1::GetIamPolicyRequest.new + # + # # Call the get_iam_policy method. + # result = client.get_iam_policy request + # + # # The returned object is of type Google::Iam::V1::Policy. + # p result + # def get_iam_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::GetIamPolicyRequest @@ -920,13 +1114,15 @@ metadata[:"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 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - header_params = { - "resource" => request.resource - } + header_params = {} + if request.resource + header_params["resource"] = request.resource + end + request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_iam_policy.timeout, metadata: metadata, @@ -981,10 +1177,25 @@ # # @return [::Google::Iam::V1::Policy] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # + # @example Basic example + # require "google/cloud/resource_manager/v3" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::ResourceManager::V3::Folders::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Iam::V1::SetIamPolicyRequest.new + # + # # Call the set_iam_policy method. + # result = client.set_iam_policy request + # + # # The returned object is of type Google::Iam::V1::Policy. + # p result + # def set_iam_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::SetIamPolicyRequest @@ -998,13 +1209,15 @@ metadata[:"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 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - header_params = { - "resource" => request.resource - } + header_params = {} + if request.resource + header_params["resource"] = request.resource + end + request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.set_iam_policy.timeout, metadata: metadata, @@ -1059,10 +1272,25 @@ # # @return [::Google::Iam::V1::TestIamPermissionsResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # + # @example Basic example + # require "google/cloud/resource_manager/v3" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::ResourceManager::V3::Folders::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Iam::V1::TestIamPermissionsRequest.new + # + # # Call the test_iam_permissions method. + # result = client.test_iam_permissions request + # + # # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse. + # p result + # def test_iam_permissions request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::TestIamPermissionsRequest @@ -1076,12 +1304,14 @@ metadata[:"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 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id - header_params = { - "resource" => request.resource - } + header_params = {} + if request.resource + header_params["resource"] = request.resource + end + request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.test_iam_permissions.timeout, metadata: metadata,