# frozen_string_literal: true # Copyright 2021 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! require "google/cloud/errors" require "google/cloud/dialogflow/v2/conversation_profile_pb" require "google/cloud/location" module Google module Cloud module Dialogflow module V2 module ConversationProfiles ## # Client for the ConversationProfiles service. # # Service for managing {::Google::Cloud::Dialogflow::V2::ConversationProfile ConversationProfiles}. # class Client include Paths # @private attr_reader :conversation_profiles_stub ## # Configure the ConversationProfiles Client class. # # See {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all ConversationProfiles clients # ::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Dialogflow", "V2"] 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.timeout = 60.0 default_config.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end ## # Configure the ConversationProfiles 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 {Client.configure}. # # See {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # Create a new ConversationProfiles client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the ConversationProfiles client. # @yieldparam config [Client::Configuration] # 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/dialogflow/v2/conversation_profile_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.quota_project = @quota_project_id config.endpoint = @config.endpoint end @location_client = Google::Cloud::Location::Locations::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @conversation_profiles_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Dialogflow::V2::ConversationProfiles::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end ## # Get the associated client for long-running operations. # # @return [::Google::Cloud::Dialogflow::V2::ConversationProfiles::Operations] # attr_reader :operations_client ## # Get the associated client for mix-in of the Locations. # # @return [Google::Cloud::Location::Locations::Client] # attr_reader :location_client # Service calls ## # Returns the list of all conversation profiles in the specified project. # # @overload list_conversation_profiles(request, options = nil) # Pass arguments to `list_conversation_profiles` via a request object, either of type # {::Google::Cloud::Dialogflow::V2::ListConversationProfilesRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::V2::ListConversationProfilesRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload list_conversation_profiles(parent: nil, page_size: nil, page_token: nil) # Pass arguments to `list_conversation_profiles` 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 project to list all conversation profiles from. # Format: `projects//locations/`. # @param page_size [::Integer] # The maximum number of items to return in a single page. By # default 100 and at most 1000. # @param page_token [::String] # The next_page_token value returned from a previous list request. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationProfile>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationProfile>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/dialogflow/v2" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Dialogflow::V2::ListConversationProfilesRequest.new # # # Call the list_conversation_profiles method. # result = client.list_conversation_profiles 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::Dialogflow::V2::ConversationProfile. # p response # end # def list_conversation_profiles request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::ListConversationProfilesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_conversation_profiles.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::Dialogflow::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent 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.list_conversation_profiles.timeout, metadata: metadata, retry_policy: @config.rpcs.list_conversation_profiles.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @conversation_profiles_stub.call_rpc :list_conversation_profiles, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @conversation_profiles_stub, :list_conversation_profiles, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Retrieves the specified conversation profile. # # @overload get_conversation_profile(request, options = nil) # Pass arguments to `get_conversation_profile` via a request object, either of type # {::Google::Cloud::Dialogflow::V2::GetConversationProfileRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::V2::GetConversationProfileRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload get_conversation_profile(name: nil) # Pass arguments to `get_conversation_profile` 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 name [::String] # Required. The resource name of the conversation profile. # Format: `projects//locations//conversationProfiles/`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Dialogflow::V2::ConversationProfile] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Dialogflow::V2::ConversationProfile] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/dialogflow/v2" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Dialogflow::V2::GetConversationProfileRequest.new # # # Call the get_conversation_profile method. # result = client.get_conversation_profile request # # # The returned object is of type Google::Cloud::Dialogflow::V2::ConversationProfile. # p result # def get_conversation_profile request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::GetConversationProfileRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_conversation_profile.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::Dialogflow::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id 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_conversation_profile.timeout, metadata: metadata, retry_policy: @config.rpcs.get_conversation_profile.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @conversation_profiles_stub.call_rpc :get_conversation_profile, request, options: 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 ## # Creates a conversation profile in the specified project. # # [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] # aren't populated in the response. You can retrieve them via # {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#get_conversation_profile GetConversationProfile} API. # # @overload create_conversation_profile(request, options = nil) # Pass arguments to `create_conversation_profile` via a request object, either of type # {::Google::Cloud::Dialogflow::V2::CreateConversationProfileRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::V2::CreateConversationProfileRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload create_conversation_profile(parent: nil, conversation_profile: nil) # Pass arguments to `create_conversation_profile` 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 project to create a conversation profile for. # Format: `projects//locations/`. # @param conversation_profile [::Google::Cloud::Dialogflow::V2::ConversationProfile, ::Hash] # Required. The conversation profile to create. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Dialogflow::V2::ConversationProfile] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Dialogflow::V2::ConversationProfile] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/dialogflow/v2" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Dialogflow::V2::CreateConversationProfileRequest.new # # # Call the create_conversation_profile method. # result = client.create_conversation_profile request # # # The returned object is of type Google::Cloud::Dialogflow::V2::ConversationProfile. # p result # def create_conversation_profile request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::CreateConversationProfileRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_conversation_profile.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::Dialogflow::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent 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.create_conversation_profile.timeout, metadata: metadata, retry_policy: @config.rpcs.create_conversation_profile.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @conversation_profiles_stub.call_rpc :create_conversation_profile, request, options: 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 ## # Updates the specified conversation profile. # # [ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] # aren't populated in the response. You can retrieve them via # {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client#get_conversation_profile GetConversationProfile} API. # # @overload update_conversation_profile(request, options = nil) # Pass arguments to `update_conversation_profile` via a request object, either of type # {::Google::Cloud::Dialogflow::V2::UpdateConversationProfileRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::V2::UpdateConversationProfileRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload update_conversation_profile(conversation_profile: nil, update_mask: nil) # Pass arguments to `update_conversation_profile` 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 conversation_profile [::Google::Cloud::Dialogflow::V2::ConversationProfile, ::Hash] # Required. The conversation profile to update. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Required. The mask to control which fields to update. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Dialogflow::V2::ConversationProfile] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Dialogflow::V2::ConversationProfile] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/dialogflow/v2" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Dialogflow::V2::UpdateConversationProfileRequest.new # # # Call the update_conversation_profile method. # result = client.update_conversation_profile request # # # The returned object is of type Google::Cloud::Dialogflow::V2::ConversationProfile. # p result # def update_conversation_profile request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::UpdateConversationProfileRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_conversation_profile.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::Dialogflow::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.conversation_profile&.name header_params["conversation_profile.name"] = request.conversation_profile.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_conversation_profile.timeout, metadata: metadata, retry_policy: @config.rpcs.update_conversation_profile.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @conversation_profiles_stub.call_rpc :update_conversation_profile, request, options: 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 ## # Deletes the specified conversation profile. # # @overload delete_conversation_profile(request, options = nil) # Pass arguments to `delete_conversation_profile` via a request object, either of type # {::Google::Cloud::Dialogflow::V2::DeleteConversationProfileRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::V2::DeleteConversationProfileRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload delete_conversation_profile(name: nil) # Pass arguments to `delete_conversation_profile` 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 name [::String] # Required. The name of the conversation profile to delete. # Format: `projects//locations//conversationProfiles/`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Protobuf::Empty] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Protobuf::Empty] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/dialogflow/v2" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Dialogflow::V2::DeleteConversationProfileRequest.new # # # Call the delete_conversation_profile method. # result = client.delete_conversation_profile request # # # The returned object is of type Google::Protobuf::Empty. # p result # def delete_conversation_profile request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::DeleteConversationProfileRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_conversation_profile.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::Dialogflow::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id 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_conversation_profile.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_conversation_profile.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @conversation_profiles_stub.call_rpc :delete_conversation_profile, request, options: 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 ## # Adds or updates a suggestion feature in a conversation profile. # If the conversation profile contains the type of suggestion feature for # the participant role, it will update it. Otherwise it will insert the # suggestion feature. # # This method is a [long-running # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). # The returned `Operation` type has the following method-specific fields: # # - `metadata`: {::Google::Cloud::Dialogflow::V2::SetSuggestionFeatureConfigOperationMetadata SetSuggestionFeatureConfigOperationMetadata} # - `response`: {::Google::Cloud::Dialogflow::V2::ConversationProfile ConversationProfile} # # If a long running operation to add or update suggestion feature # config for the same conversation profile, participant role and suggestion # feature type exists, please cancel the existing long running operation # before sending such request, otherwise the request will be rejected. # # @overload set_suggestion_feature_config(request, options = nil) # Pass arguments to `set_suggestion_feature_config` via a request object, either of type # {::Google::Cloud::Dialogflow::V2::SetSuggestionFeatureConfigRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::V2::SetSuggestionFeatureConfigRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload set_suggestion_feature_config(conversation_profile: nil, participant_role: nil, suggestion_feature_config: nil) # Pass arguments to `set_suggestion_feature_config` 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 conversation_profile [::String] # Required. The Conversation Profile to add or update the suggestion feature # config. Format: `projects//locations//conversationProfiles/`. # @param participant_role [::Google::Cloud::Dialogflow::V2::Participant::Role] # Required. The participant role to add or update the suggestion feature # config. Only HUMAN_AGENT or END_USER can be used. # @param suggestion_feature_config [::Google::Cloud::Dialogflow::V2::HumanAgentAssistantConfig::SuggestionFeatureConfig, ::Hash] # Required. The suggestion feature config to add or update. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/dialogflow/v2" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Dialogflow::V2::SetSuggestionFeatureConfigRequest.new # # # Call the set_suggestion_feature_config method. # result = client.set_suggestion_feature_config 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 set_suggestion_feature_config request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::SetSuggestionFeatureConfigRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.set_suggestion_feature_config.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::Dialogflow::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.conversation_profile header_params["conversation_profile"] = request.conversation_profile 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_suggestion_feature_config.timeout, metadata: metadata, retry_policy: @config.rpcs.set_suggestion_feature_config.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @conversation_profiles_stub.call_rpc :set_suggestion_feature_config, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Clears a suggestion feature from a conversation profile for the given # participant role. # # This method is a [long-running # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). # The returned `Operation` type has the following method-specific fields: # # - `metadata`: {::Google::Cloud::Dialogflow::V2::ClearSuggestionFeatureConfigOperationMetadata ClearSuggestionFeatureConfigOperationMetadata} # - `response`: {::Google::Cloud::Dialogflow::V2::ConversationProfile ConversationProfile} # # @overload clear_suggestion_feature_config(request, options = nil) # Pass arguments to `clear_suggestion_feature_config` via a request object, either of type # {::Google::Cloud::Dialogflow::V2::ClearSuggestionFeatureConfigRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::V2::ClearSuggestionFeatureConfigRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload clear_suggestion_feature_config(conversation_profile: nil, participant_role: nil, suggestion_feature_type: nil) # Pass arguments to `clear_suggestion_feature_config` 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 conversation_profile [::String] # Required. The Conversation Profile to add or update the suggestion feature # config. Format: `projects//locations//conversationProfiles/`. # @param participant_role [::Google::Cloud::Dialogflow::V2::Participant::Role] # Required. The participant role to remove the suggestion feature # config. Only HUMAN_AGENT or END_USER can be used. # @param suggestion_feature_type [::Google::Cloud::Dialogflow::V2::SuggestionFeature::Type] # Required. The type of the suggestion feature to remove. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/dialogflow/v2" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Dialogflow::V2::ClearSuggestionFeatureConfigRequest.new # # # Call the clear_suggestion_feature_config method. # result = client.clear_suggestion_feature_config 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 clear_suggestion_feature_config request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::ClearSuggestionFeatureConfigRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.clear_suggestion_feature_config.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers 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::Dialogflow::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.conversation_profile header_params["conversation_profile"] = request.conversation_profile 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.clear_suggestion_feature_config.timeout, metadata: metadata, retry_policy: @config.rpcs.clear_suggestion_feature_config.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @conversation_profiles_stub.call_rpc :clear_suggestion_feature_config, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the ConversationProfiles API. # # This class represents the configuration for ConversationProfiles, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See # {::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # # @example # # # Modify the global config, setting the timeout for # # list_conversation_profiles to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.list_conversation_profiles.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new do |config| # config.timeout = 10.0 # config.rpcs.list_conversation_profiles.timeout = 20.0 # end # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"dialogflow.googleapis.com"`. # @return [::String] # @!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)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html)) # * (`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 # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] channel_args # Extra parameters passed to the gRPC channel. Note: this is ignored if a # `GRPC::Core::Channel` object is provided as the credential. # @return [::Hash] # @!attribute [rw] interceptors # An array of interceptors that are run before calls are executed. # @return [::Array<::GRPC::ClientInterceptor>] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional gRPC headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # The retry policy. The value is a hash with the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # class Configuration extend ::Gapic::Config config_attr :endpoint, "dialogflow.googleapis.com", ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the ConversationProfiles API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_conversation_profiles` # @return [::Gapic::Config::Method] # attr_reader :list_conversation_profiles ## # RPC-specific configuration for `get_conversation_profile` # @return [::Gapic::Config::Method] # attr_reader :get_conversation_profile ## # RPC-specific configuration for `create_conversation_profile` # @return [::Gapic::Config::Method] # attr_reader :create_conversation_profile ## # RPC-specific configuration for `update_conversation_profile` # @return [::Gapic::Config::Method] # attr_reader :update_conversation_profile ## # RPC-specific configuration for `delete_conversation_profile` # @return [::Gapic::Config::Method] # attr_reader :delete_conversation_profile ## # RPC-specific configuration for `set_suggestion_feature_config` # @return [::Gapic::Config::Method] # attr_reader :set_suggestion_feature_config ## # RPC-specific configuration for `clear_suggestion_feature_config` # @return [::Gapic::Config::Method] # attr_reader :clear_suggestion_feature_config # @private def initialize parent_rpcs = nil list_conversation_profiles_config = parent_rpcs.list_conversation_profiles if parent_rpcs.respond_to? :list_conversation_profiles @list_conversation_profiles = ::Gapic::Config::Method.new list_conversation_profiles_config get_conversation_profile_config = parent_rpcs.get_conversation_profile if parent_rpcs.respond_to? :get_conversation_profile @get_conversation_profile = ::Gapic::Config::Method.new get_conversation_profile_config create_conversation_profile_config = parent_rpcs.create_conversation_profile if parent_rpcs.respond_to? :create_conversation_profile @create_conversation_profile = ::Gapic::Config::Method.new create_conversation_profile_config update_conversation_profile_config = parent_rpcs.update_conversation_profile if parent_rpcs.respond_to? :update_conversation_profile @update_conversation_profile = ::Gapic::Config::Method.new update_conversation_profile_config delete_conversation_profile_config = parent_rpcs.delete_conversation_profile if parent_rpcs.respond_to? :delete_conversation_profile @delete_conversation_profile = ::Gapic::Config::Method.new delete_conversation_profile_config set_suggestion_feature_config_config = parent_rpcs.set_suggestion_feature_config if parent_rpcs.respond_to? :set_suggestion_feature_config @set_suggestion_feature_config = ::Gapic::Config::Method.new set_suggestion_feature_config_config clear_suggestion_feature_config_config = parent_rpcs.clear_suggestion_feature_config if parent_rpcs.respond_to? :clear_suggestion_feature_config @clear_suggestion_feature_config = ::Gapic::Config::Method.new clear_suggestion_feature_config_config yield self if block_given? end end end end end end end end end