# 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/cx/v3/intent_pb" require "google/cloud/location" module Google module Cloud module Dialogflow module CX module V3 module Intents ## # Client for the Intents service. # # Service for managing {::Google::Cloud::Dialogflow::CX::V3::Intent Intents}. # class Client # @private DEFAULT_ENDPOINT_TEMPLATE = "dialogflow.$UNIVERSE_DOMAIN$" include Paths # @private attr_reader :intents_stub ## # Configure the Intents Client class. # # See {::Google::Cloud::Dialogflow::CX::V3::Intents::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all Intents clients # ::Google::Cloud::Dialogflow::CX::V3::Intents::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", "CX", "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.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 Intents 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::CX::V3::Intents::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 ## # The effective universe domain # # @return [String] # def universe_domain @intents_stub.universe_domain end ## # Create a new Intents client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::Dialogflow::CX::V3::Intents::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::Dialogflow::CX::V3::Intents::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Intents 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/cx/v3/intent_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.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.universe_domain end @location_client = Google::Cloud::Location::Locations::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.universe_domain end @intents_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Dialogflow::CX::V3::Intents::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) end ## # Get the associated client for long-running operations. # # @return [::Google::Cloud::Dialogflow::CX::V3::Intents::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 intents in the specified agent. # # @overload list_intents(request, options = nil) # Pass arguments to `list_intents` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::ListIntentsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::ListIntentsRequest, ::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_intents(parent: nil, language_code: nil, intent_view: nil, page_size: nil, page_token: nil) # Pass arguments to `list_intents` 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 agent to list all intents for. # Format: `projects//locations//agents/`. # @param language_code [::String] # The language to list intents for. The following fields are language # dependent: # # * `Intent.training_phrases.parts.text` # # If not specified, the agent's default language is used. # [Many # languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) # are supported. # Note: languages must be enabled in the agent before they can be used. # @param intent_view [::Google::Cloud::Dialogflow::CX::V3::IntentView] # The resource view to apply to the returned intent. # @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::CX::V3::Intent>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::Intent>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/dialogflow/cx/v3" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Dialogflow::CX::V3::Intents::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Dialogflow::CX::V3::ListIntentsRequest.new # # # Call the list_intents method. # result = client.list_intents request # # # The returned object is of type Gapic::PagedEnumerable. You can iterate # # over elements, and API calls will be issued to fetch pages as needed. # result.each do |item| # # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::Intent. # p item # end # def list_intents request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ListIntentsRequest # 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_intents.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::CX::V3::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_intents.timeout, metadata: metadata, retry_policy: @config.rpcs.list_intents.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @intents_stub.call_rpc :list_intents, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @intents_stub, :list_intents, 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 intent. # # @overload get_intent(request, options = nil) # Pass arguments to `get_intent` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::GetIntentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::GetIntentRequest, ::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_intent(name: nil, language_code: nil) # Pass arguments to `get_intent` 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 intent. # Format: `projects//locations//agents//intents/`. # @param language_code [::String] # The language to retrieve the intent for. The following fields are language # dependent: # # * `Intent.training_phrases.parts.text` # # If not specified, the agent's default language is used. # [Many # languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) # are supported. # Note: languages must be enabled in the agent before they can be used. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::Intent] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Dialogflow::CX::V3::Intent] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/dialogflow/cx/v3" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Dialogflow::CX::V3::Intents::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Dialogflow::CX::V3::GetIntentRequest.new # # # Call the get_intent method. # result = client.get_intent request # # # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Intent. # p result # def get_intent request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::GetIntentRequest # 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_intent.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::CX::V3::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_intent.timeout, metadata: metadata, retry_policy: @config.rpcs.get_intent.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @intents_stub.call_rpc :get_intent, 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 an intent in the specified agent. # # Note: You should always train a flow prior to sending it queries. See the # [training # documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). # # @overload create_intent(request, options = nil) # Pass arguments to `create_intent` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::CreateIntentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::CreateIntentRequest, ::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_intent(parent: nil, intent: nil, language_code: nil) # Pass arguments to `create_intent` 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 agent to create an intent for. # Format: `projects//locations//agents/`. # @param intent [::Google::Cloud::Dialogflow::CX::V3::Intent, ::Hash] # Required. The intent to create. # @param language_code [::String] # The language of the following fields in `intent`: # # * `Intent.training_phrases.parts.text` # # If not specified, the agent's default language is used. # [Many # languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) # are supported. # Note: languages must be enabled in the agent before they can be used. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::Intent] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Dialogflow::CX::V3::Intent] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/dialogflow/cx/v3" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Dialogflow::CX::V3::Intents::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Dialogflow::CX::V3::CreateIntentRequest.new # # # Call the create_intent method. # result = client.create_intent request # # # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Intent. # p result # def create_intent request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::CreateIntentRequest # 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_intent.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::CX::V3::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_intent.timeout, metadata: metadata, retry_policy: @config.rpcs.create_intent.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @intents_stub.call_rpc :create_intent, 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 intent. # # Note: You should always train a flow prior to sending it queries. See the # [training # documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). # # @overload update_intent(request, options = nil) # Pass arguments to `update_intent` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::UpdateIntentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::UpdateIntentRequest, ::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_intent(intent: nil, language_code: nil, update_mask: nil) # Pass arguments to `update_intent` 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 intent [::Google::Cloud::Dialogflow::CX::V3::Intent, ::Hash] # Required. The intent to update. # @param language_code [::String] # The language of the following fields in `intent`: # # * `Intent.training_phrases.parts.text` # # If not specified, the agent's default language is used. # [Many # languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) # are supported. # Note: languages must be enabled in the agent before they can be used. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # The mask to control which fields get updated. If the mask is not present, # all fields will be updated. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::Intent] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Dialogflow::CX::V3::Intent] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/dialogflow/cx/v3" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Dialogflow::CX::V3::Intents::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Dialogflow::CX::V3::UpdateIntentRequest.new # # # Call the update_intent method. # result = client.update_intent request # # # The returned object is of type Google::Cloud::Dialogflow::CX::V3::Intent. # p result # def update_intent request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::UpdateIntentRequest # 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_intent.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::CX::V3::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.intent&.name header_params["intent.name"] = request.intent.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_intent.timeout, metadata: metadata, retry_policy: @config.rpcs.update_intent.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @intents_stub.call_rpc :update_intent, 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 intent. # # Note: You should always train a flow prior to sending it queries. See the # [training # documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). # # @overload delete_intent(request, options = nil) # Pass arguments to `delete_intent` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::DeleteIntentRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::DeleteIntentRequest, ::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_intent(name: nil) # Pass arguments to `delete_intent` 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 intent to delete. # Format: `projects//locations//agents//intents/`. # # @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/cx/v3" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Dialogflow::CX::V3::Intents::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Dialogflow::CX::V3::DeleteIntentRequest.new # # # Call the delete_intent method. # result = client.delete_intent request # # # The returned object is of type Google::Protobuf::Empty. # p result # def delete_intent request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::DeleteIntentRequest # 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_intent.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::CX::V3::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_intent.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_intent.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @intents_stub.call_rpc :delete_intent, 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 ## # Imports the specified intents into the agent. # # This method is a [long-running # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). # The returned `Operation` type has the following method-specific fields: # # - `metadata`: # {::Google::Cloud::Dialogflow::CX::V3::ImportIntentsMetadata ImportIntentsMetadata} # - `response`: # {::Google::Cloud::Dialogflow::CX::V3::ImportIntentsResponse ImportIntentsResponse} # # @overload import_intents(request, options = nil) # Pass arguments to `import_intents` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::ImportIntentsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::ImportIntentsRequest, ::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 import_intents(parent: nil, intents_uri: nil, intents_content: nil, merge_option: nil) # Pass arguments to `import_intents` 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 agent to import the intents into. # Format: `projects//locations//agents/`. # @param intents_uri [::String] # The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI # to import intents from. The format of this URI must be # `gs:///`. # # Dialogflow performs a read operation for the Cloud Storage object # on the caller's behalf, so your request authentication must # have read permissions for the object. For more information, see # [Dialogflow access # control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). # @param intents_content [::Google::Cloud::Dialogflow::CX::V3::InlineSource, ::Hash] # Uncompressed byte content of intents. # @param merge_option [::Google::Cloud::Dialogflow::CX::V3::ImportIntentsRequest::MergeOption] # Merge option for importing intents. If not specified, `REJECT` is assumed. # # @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/cx/v3" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Dialogflow::CX::V3::Intents::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Dialogflow::CX::V3::ImportIntentsRequest.new # # # Call the import_intents method. # result = client.import_intents request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def import_intents request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ImportIntentsRequest # 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.import_intents.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::CX::V3::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.import_intents.timeout, metadata: metadata, retry_policy: @config.rpcs.import_intents.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @intents_stub.call_rpc :import_intents, 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 ## # Exports the selected intents. # # This method is a [long-running # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). # The returned `Operation` type has the following method-specific fields: # # - `metadata`: # {::Google::Cloud::Dialogflow::CX::V3::ExportIntentsMetadata ExportIntentsMetadata} # - `response`: # {::Google::Cloud::Dialogflow::CX::V3::ExportIntentsResponse ExportIntentsResponse} # # @overload export_intents(request, options = nil) # Pass arguments to `export_intents` via a request object, either of type # {::Google::Cloud::Dialogflow::CX::V3::ExportIntentsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Dialogflow::CX::V3::ExportIntentsRequest, ::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 export_intents(parent: nil, intents: nil, intents_uri: nil, intents_content_inline: nil, data_format: nil) # Pass arguments to `export_intents` 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 name of the parent agent to export intents. # Format: `projects//locations//agents/`. # @param intents [::Array<::String>] # Required. The name of the intents to export. # Format: `projects//locations//agents//intents/`. # @param intents_uri [::String] # Optional. The [Google Cloud # Storage](https://cloud.google.com/storage/docs/) URI to export the # intents to. The format of this URI must be # `gs:///`. # # Dialogflow performs a write operation for the Cloud Storage object # on the caller's behalf, so your request authentication must # have write permissions for the object. For more information, see # [Dialogflow access # control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). # @param intents_content_inline [::Boolean] # Optional. The option to return the serialized intents inline. # @param data_format [::Google::Cloud::Dialogflow::CX::V3::ExportIntentsRequest::DataFormat] # Optional. The data format of the exported intents. If not specified, `BLOB` # is assumed. # # @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/cx/v3" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Dialogflow::CX::V3::Intents::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Dialogflow::CX::V3::ExportIntentsRequest.new # # # Call the export_intents method. # result = client.export_intents request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def export_intents request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ExportIntentsRequest # 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.export_intents.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::CX::V3::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.export_intents.timeout, metadata: metadata, retry_policy: @config.rpcs.export_intents.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @intents_stub.call_rpc :export_intents, 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 Intents API. # # This class represents the configuration for Intents, # 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::CX::V3::Intents::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_intents to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::Dialogflow::CX::V3::Intents::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.list_intents.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::Dialogflow::CX::V3::Intents::Client.new do |config| # config.timeout = 10.0 # config.rpcs.list_intents.timeout = 20.0 # end # # @!attribute [rw] endpoint # A custom service endpoint, as a hostname or hostname:port. The default is # nil, indicating to use the default endpoint in the current universe domain. # @return [::String,nil] # @!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://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (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 # 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] # @!attribute [rw] universe_domain # The universe domain within which to make requests. This determines the # default endpoint URL. The default value of nil uses the environment # universe (usually the default "googleapis.com" universe). # @return [::String,nil] # class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "dialogflow.googleapis.com" config_attr :endpoint, nil, ::String, nil 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 config_attr :universe_domain, 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 for the channel pool # @return [::Gapic::ServiceStub::ChannelPool::Configuration] # def channel_pool @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new end ## # Configuration RPC class for the Intents 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_intents` # @return [::Gapic::Config::Method] # attr_reader :list_intents ## # RPC-specific configuration for `get_intent` # @return [::Gapic::Config::Method] # attr_reader :get_intent ## # RPC-specific configuration for `create_intent` # @return [::Gapic::Config::Method] # attr_reader :create_intent ## # RPC-specific configuration for `update_intent` # @return [::Gapic::Config::Method] # attr_reader :update_intent ## # RPC-specific configuration for `delete_intent` # @return [::Gapic::Config::Method] # attr_reader :delete_intent ## # RPC-specific configuration for `import_intents` # @return [::Gapic::Config::Method] # attr_reader :import_intents ## # RPC-specific configuration for `export_intents` # @return [::Gapic::Config::Method] # attr_reader :export_intents # @private def initialize parent_rpcs = nil list_intents_config = parent_rpcs.list_intents if parent_rpcs.respond_to? :list_intents @list_intents = ::Gapic::Config::Method.new list_intents_config get_intent_config = parent_rpcs.get_intent if parent_rpcs.respond_to? :get_intent @get_intent = ::Gapic::Config::Method.new get_intent_config create_intent_config = parent_rpcs.create_intent if parent_rpcs.respond_to? :create_intent @create_intent = ::Gapic::Config::Method.new create_intent_config update_intent_config = parent_rpcs.update_intent if parent_rpcs.respond_to? :update_intent @update_intent = ::Gapic::Config::Method.new update_intent_config delete_intent_config = parent_rpcs.delete_intent if parent_rpcs.respond_to? :delete_intent @delete_intent = ::Gapic::Config::Method.new delete_intent_config import_intents_config = parent_rpcs.import_intents if parent_rpcs.respond_to? :import_intents @import_intents = ::Gapic::Config::Method.new import_intents_config export_intents_config = parent_rpcs.export_intents if parent_rpcs.respond_to? :export_intents @export_intents = ::Gapic::Config::Method.new export_intents_config yield self if block_given? end end end end end end end end end end