# frozen_string_literal: true # Copyright 2020 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/intent_pb" module Google module Cloud module Dialogflow module V2 module Intents ## # Client for the Intents service. # # An intent represents a mapping between input from a user and an action to # be taken by your application. When you pass user input to the # {Google::Cloud::Dialogflow::V2::Sessions::Client#detect_intent DetectIntent} (or # {Google::Cloud::Dialogflow::V2::Sessions::Client#streaming_detect_intent StreamingDetectIntent}) method, the # Dialogflow API analyzes the input and searches # for a matching intent. If no match is found, the Dialogflow API returns a # fallback intent (`is_fallback` = true). # # You can provide additional information for the Dialogflow API to use to # match user input to an intent by adding the following to your intent. # # * **Contexts** - provide additional context for intent analysis. For # example, if an intent is related to an object in your application that # plays music, you can provide a context to determine when to match the # intent if the user input is "turn it off". You can include a context # that matches the intent when there is previous user input of # "play music", and not when there is previous user input of # "turn on the light". # # * **Events** - allow for matching an intent by using an event name # instead of user input. Your application can provide an event name and # related parameters to the Dialogflow API to match an intent. For # example, when your application starts, you can send a welcome event # with a user name parameter to the Dialogflow API to match an intent with # a personalized welcome message for the user. # # * **Training phrases** - provide examples of user input to train the # Dialogflow API agent to better match intents. # # For more information about intents, see the # [Dialogflow # documentation](https://cloud.google.com/dialogflow/docs/intents-overview). # class Client include Paths # @private attr_reader :intents_stub ## # Configure the Intents Client class. # # See {Google::Cloud::Dialogflow::V2::Intents::Client::Configuration} # for a description of the configuration fields. # # ## Example # # To modify the configuration for all Intents clients: # # Google::Cloud::Dialogflow::V2::Intents::Client.configure do |config| # config.timeout = 10_000 # 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.rpcs.list_intents.timeout = 60.0 default_config.rpcs.list_intents.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"] } default_config.rpcs.get_intent.timeout = 60.0 default_config.rpcs.get_intent.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"] } default_config.rpcs.create_intent.timeout = 60.0 default_config.rpcs.update_intent.timeout = 60.0 default_config.rpcs.delete_intent.timeout = 60.0 default_config.rpcs.delete_intent.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"] } default_config.rpcs.batch_update_intents.timeout = 60.0 default_config.rpcs.batch_delete_intents.timeout = 60.0 default_config.rpcs.batch_delete_intents.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"] } 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::V2::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 ## # Create a new Intents client object. # # ## Examples # # To create a new Intents client with the default # configuration: # # client = Google::Cloud::Dialogflow::V2::Intents::Client.new # # To create a new Intents client with a custom # configuration: # # client = Google::Cloud::Dialogflow::V2::Intents::Client.new do |config| # config.timeout = 10_000 # 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/v2/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 credentials ||= Credentials.default scope: @config.scope if credentials.is_a?(String) || credentials.is_a?(Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = credentials.respond_to?(:quota_project_id) ? credentials.quota_project_id : nil @operations_client = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @intents_stub = Gapic::ServiceStub.new( Google::Cloud::Dialogflow::V2::Intents::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::Intents::Operations] # attr_reader :operations_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::V2::ListIntentsRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::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 from. # Format: `projects//agent`. # @param language_code [String] # Optional. The language used to access language-specific data. # If not specified, the agent's default language is used. # For more information, see # [Multilingual intent and entity # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). # @param intent_view [Google::Cloud::Dialogflow::V2::IntentView] # Optional. The resource view to apply to the returned intent. # @param page_size [Integer] # Optional. The maximum number of items to return in a single page. By # default 100 and at most 1000. # @param page_token [String] # Optional. 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] # @yieldparam operation [GRPC::ActiveCall::Operation] # # @return [Gapic::PagedEnumerable] # # @raise [Google::Cloud::Error] if the RPC is aborted. # def list_intents request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::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::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } 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 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::V2::GetIntentRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::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, intent_view: 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//agent/intents/`. # @param language_code [String] # Optional. The language used to access language-specific data. # If not specified, the agent's default language is used. # For more information, see # [Multilingual intent and entity # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). # @param intent_view [Google::Cloud::Dialogflow::V2::IntentView] # Optional. The resource view to apply to the returned intent. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [Google::Cloud::Dialogflow::V2::Intent] # @yieldparam operation [GRPC::ActiveCall::Operation] # # @return [Google::Cloud::Dialogflow::V2::Intent] # # @raise [Google::Cloud::Error] if the RPC is aborted. # def get_intent request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::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::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") 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 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. # # @overload create_intent(request, options = nil) # Pass arguments to `create_intent` via a request object, either of type # {Google::Cloud::Dialogflow::V2::CreateIntentRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::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, intent_view: 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 a intent for. # Format: `projects//agent`. # @param intent [Google::Cloud::Dialogflow::V2::Intent, Hash] # Required. The intent to create. # @param language_code [String] # Optional. The language used to access language-specific data. # If not specified, the agent's default language is used. # For more information, see # [Multilingual intent and entity # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). # @param intent_view [Google::Cloud::Dialogflow::V2::IntentView] # Optional. The resource view to apply to the returned intent. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [Google::Cloud::Dialogflow::V2::Intent] # @yieldparam operation [GRPC::ActiveCall::Operation] # # @return [Google::Cloud::Dialogflow::V2::Intent] # # @raise [Google::Cloud::Error] if the RPC is aborted. # def create_intent request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::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::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } 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 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. # # @overload update_intent(request, options = nil) # Pass arguments to `update_intent` via a request object, either of type # {Google::Cloud::Dialogflow::V2::UpdateIntentRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::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, intent_view: 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::V2::Intent, Hash] # Required. The intent to update. # @param language_code [String] # Optional. The language used to access language-specific data. # If not specified, the agent's default language is used. # For more information, see # [Multilingual intent and entity # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). # @param update_mask [Google::Protobuf::FieldMask, Hash] # Optional. The mask to control which fields get updated. # @param intent_view [Google::Cloud::Dialogflow::V2::IntentView] # Optional. The resource view to apply to the returned intent. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [Google::Cloud::Dialogflow::V2::Intent] # @yieldparam operation [GRPC::ActiveCall::Operation] # # @return [Google::Cloud::Dialogflow::V2::Intent] # # @raise [Google::Cloud::Error] if the RPC is aborted. # def update_intent request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::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::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "intent.name" => request.intent.name } 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 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 and its direct or indirect followup intents. # # @overload delete_intent(request, options = nil) # Pass arguments to `delete_intent` via a request object, either of type # {Google::Cloud::Dialogflow::V2::DeleteIntentRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::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. If this intent has direct or # indirect followup intents, we also delete them. # Format: `projects//agent/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. # def delete_intent request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::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::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") 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 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 ## # Updates/Creates multiple intents in the specified agent. # # Operation # # @overload batch_update_intents(request, options = nil) # Pass arguments to `batch_update_intents` via a request object, either of type # {Google::Cloud::Dialogflow::V2::BatchUpdateIntentsRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::BatchUpdateIntentsRequest, 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 batch_update_intents(parent: nil, intent_batch_uri: nil, intent_batch_inline: nil, language_code: nil, update_mask: nil, intent_view: nil) # Pass arguments to `batch_update_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 agent to update or create intents in. # Format: `projects//agent`. # @param intent_batch_uri [String] # The URI to a Google Cloud Storage file containing intents to update or # create. The file format can either be a serialized proto (of IntentBatch # type) or JSON object. Note: The URI must start with "gs://". # @param intent_batch_inline [Google::Cloud::Dialogflow::V2::IntentBatch, Hash] # The collection of intents to update or create. # @param language_code [String] # Optional. The language used to access language-specific data. # If not specified, the agent's default language is used. # For more information, see # [Multilingual intent and entity # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity). # @param update_mask [Google::Protobuf::FieldMask, Hash] # Optional. The mask to control which fields get updated. # @param intent_view [Google::Cloud::Dialogflow::V2::IntentView] # Optional. The resource view to apply to the returned intent. # # @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. # def batch_update_intents request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::BatchUpdateIntentsRequest # 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.batch_update_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::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } 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.batch_update_intents.timeout, metadata: metadata, retry_policy: @config.rpcs.batch_update_intents.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @intents_stub.call_rpc :batch_update_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 ## # Deletes intents in the specified agent. # # Operation # # @overload batch_delete_intents(request, options = nil) # Pass arguments to `batch_delete_intents` via a request object, either of type # {Google::Cloud::Dialogflow::V2::BatchDeleteIntentsRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::BatchDeleteIntentsRequest, 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 batch_delete_intents(parent: nil, intents: nil) # Pass arguments to `batch_delete_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 agent to delete all entities types for. Format: # `projects//agent`. # @param intents [Array] # Required. The collection of intents to delete. Only intent `name` must be # filled in. # # @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. # def batch_delete_intents request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::BatchDeleteIntentsRequest # 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.batch_delete_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::V2::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } 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.batch_delete_intents.timeout, metadata: metadata, retry_policy: @config.rpcs.batch_delete_intents.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @intents_stub.call_rpc :batch_delete_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::V2::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. # # # Examples # # To modify the global config, setting the timeout for list_intents # to 20 seconds, and all remaining timeouts to 10 seconds: # # Google::Cloud::Dialogflow::V2::Intents::Client.configure do |config| # config.timeout = 10_000 # config.rpcs.list_intents.timeout = 20_000 # end # # To apply the above configuration only to a new client: # # client = Google::Cloud::Dialogflow::V2::Intents::Client.new do |config| # config.timeout = 10_000 # config.rpcs.list_intents.timeout = 20_000 # 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] # @!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] # @!attribute [rw] timeout # The call timeout in milliseconds. # @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] # class Configuration extend Gapic::Config config_attr :endpoint, "dialogflow.googleapis.com", String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::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 # @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 @parent_config&.respond_to? :rpcs Rpcs.new parent_rpcs end 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 milliseconds # * `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 `batch_update_intents` # @return [Gapic::Config::Method] # attr_reader :batch_update_intents ## # RPC-specific configuration for `batch_delete_intents` # @return [Gapic::Config::Method] # attr_reader :batch_delete_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 batch_update_intents_config = parent_rpcs&.batch_update_intents if parent_rpcs&.respond_to? :batch_update_intents @batch_update_intents = Gapic::Config::Method.new batch_update_intents_config batch_delete_intents_config = parent_rpcs&.batch_delete_intents if parent_rpcs&.respond_to? :batch_delete_intents @batch_delete_intents = Gapic::Config::Method.new batch_delete_intents_config yield self if block_given? end end end end end end end end end