# 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/entity_type_pb" module Google module Cloud module Dialogflow module V2 module EntityTypes ## # Client for the EntityTypes service. # # Entities are extracted from user input and represent parameters that are # meaningful to your application. For example, a date range, a proper name # such as a geographic location or landmark, and so on. Entities represent # actionable data for your application. # # When you define an entity, you can also include synonyms that all map to # that entity. For example, "soft drink", "soda", "pop", and so on. # # There are three types of entities: # # * **System** - entities that are defined by the Dialogflow API for common # data types such as date, time, currency, and so on. A system entity is # represented by the `EntityType` type. # # * **Custom** - entities that are defined by you that represent # actionable data that is meaningful to your application. For example, # you could define a `pizza.sauce` entity for red or white pizza sauce, # a `pizza.cheese` entity for the different types of cheese on a pizza, # a `pizza.topping` entity for different toppings, and so on. A custom # entity is represented by the `EntityType` type. # # * **User** - entities that are built for an individual user such as # favorites, preferences, playlists, and so on. A user entity is # represented by the {Google::Cloud::Dialogflow::V2::SessionEntityType SessionEntityType} type. # # For more information about entity types, see the # [Dialogflow # documentation](https://cloud.google.com/dialogflow/docs/entities-overview). # class Client include Paths # @private attr_reader :entity_types_stub ## # Configure the EntityTypes Client class. # # See {Google::Cloud::Dialogflow::V2::EntityTypes::Client::Configuration} # for a description of the configuration fields. # # ## Example # # To modify the configuration for all EntityTypes clients: # # Google::Cloud::Dialogflow::V2::EntityTypes::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_entity_types.timeout = 60.0 default_config.rpcs.list_entity_types.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"] } default_config.rpcs.get_entity_type.timeout = 60.0 default_config.rpcs.get_entity_type.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"] } default_config.rpcs.create_entity_type.timeout = 60.0 default_config.rpcs.update_entity_type.timeout = 60.0 default_config.rpcs.delete_entity_type.timeout = 60.0 default_config.rpcs.delete_entity_type.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"] } default_config.rpcs.batch_update_entity_types.timeout = 60.0 default_config.rpcs.batch_delete_entity_types.timeout = 60.0 default_config.rpcs.batch_delete_entity_types.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"] } default_config.rpcs.batch_create_entities.timeout = 60.0 default_config.rpcs.batch_update_entities.timeout = 60.0 default_config.rpcs.batch_delete_entities.timeout = 60.0 default_config.rpcs.batch_delete_entities.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 EntityTypes 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::EntityTypes::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 EntityTypes client object. # # ## Examples # # To create a new EntityTypes client with the default # configuration: # # client = Google::Cloud::Dialogflow::V2::EntityTypes::Client.new # # To create a new EntityTypes client with a custom # configuration: # # client = Google::Cloud::Dialogflow::V2::EntityTypes::Client.new do |config| # config.timeout = 10_000 # end # # @yield [config] Configure the EntityTypes 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/entity_type_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 @entity_types_stub = Gapic::ServiceStub.new( Google::Cloud::Dialogflow::V2::EntityTypes::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::EntityTypes::Operations] # attr_reader :operations_client # Service calls ## # Returns the list of all entity types in the specified agent. # # @overload list_entity_types(request, options = nil) # Pass arguments to `list_entity_types` via a request object, either of type # {Google::Cloud::Dialogflow::V2::ListEntityTypesRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::ListEntityTypesRequest, 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_entity_types(parent: nil, language_code: nil, page_size: nil, page_token: nil) # Pass arguments to `list_entity_types` 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 entity types 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 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_entity_types request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::ListEntityTypesRequest # 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_entity_types.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_entity_types.timeout, metadata: metadata, retry_policy: @config.rpcs.list_entity_types.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @entity_types_stub.call_rpc :list_entity_types, request, options: options do |response, operation| response = Gapic::PagedEnumerable.new @entity_types_stub, :list_entity_types, 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 entity type. # # @overload get_entity_type(request, options = nil) # Pass arguments to `get_entity_type` via a request object, either of type # {Google::Cloud::Dialogflow::V2::GetEntityTypeRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::GetEntityTypeRequest, 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_entity_type(name: nil, language_code: nil) # Pass arguments to `get_entity_type` 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 entity type. # Format: `projects//agent/entityTypes/`. # @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). # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [Google::Cloud::Dialogflow::V2::EntityType] # @yieldparam operation [GRPC::ActiveCall::Operation] # # @return [Google::Cloud::Dialogflow::V2::EntityType] # # @raise [Google::Cloud::Error] if the RPC is aborted. # def get_entity_type request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::GetEntityTypeRequest # 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_entity_type.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_entity_type.timeout, metadata: metadata, retry_policy: @config.rpcs.get_entity_type.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @entity_types_stub.call_rpc :get_entity_type, 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 entity type in the specified agent. # # @overload create_entity_type(request, options = nil) # Pass arguments to `create_entity_type` via a request object, either of type # {Google::Cloud::Dialogflow::V2::CreateEntityTypeRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::CreateEntityTypeRequest, 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_entity_type(parent: nil, entity_type: nil, language_code: nil) # Pass arguments to `create_entity_type` 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 entity type for. # Format: `projects//agent`. # @param entity_type [Google::Cloud::Dialogflow::V2::EntityType, Hash] # Required. The entity type 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). # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [Google::Cloud::Dialogflow::V2::EntityType] # @yieldparam operation [GRPC::ActiveCall::Operation] # # @return [Google::Cloud::Dialogflow::V2::EntityType] # # @raise [Google::Cloud::Error] if the RPC is aborted. # def create_entity_type request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::CreateEntityTypeRequest # 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_entity_type.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_entity_type.timeout, metadata: metadata, retry_policy: @config.rpcs.create_entity_type.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @entity_types_stub.call_rpc :create_entity_type, 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 entity type. # # @overload update_entity_type(request, options = nil) # Pass arguments to `update_entity_type` via a request object, either of type # {Google::Cloud::Dialogflow::V2::UpdateEntityTypeRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::UpdateEntityTypeRequest, 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_entity_type(entity_type: nil, language_code: nil, update_mask: nil) # Pass arguments to `update_entity_type` 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 entity_type [Google::Cloud::Dialogflow::V2::EntityType, Hash] # Required. The entity type 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. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [Google::Cloud::Dialogflow::V2::EntityType] # @yieldparam operation [GRPC::ActiveCall::Operation] # # @return [Google::Cloud::Dialogflow::V2::EntityType] # # @raise [Google::Cloud::Error] if the RPC is aborted. # def update_entity_type request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::UpdateEntityTypeRequest # 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_entity_type.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 = { "entity_type.name" => request.entity_type.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_entity_type.timeout, metadata: metadata, retry_policy: @config.rpcs.update_entity_type.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @entity_types_stub.call_rpc :update_entity_type, 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 entity type. # # @overload delete_entity_type(request, options = nil) # Pass arguments to `delete_entity_type` via a request object, either of type # {Google::Cloud::Dialogflow::V2::DeleteEntityTypeRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::DeleteEntityTypeRequest, 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_entity_type(name: nil) # Pass arguments to `delete_entity_type` 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 entity type to delete. # Format: `projects//agent/entityTypes/`. # # @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_entity_type request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::DeleteEntityTypeRequest # 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_entity_type.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_entity_type.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_entity_type.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @entity_types_stub.call_rpc :delete_entity_type, 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 entity types in the specified agent. # # Operation # # @overload batch_update_entity_types(request, options = nil) # Pass arguments to `batch_update_entity_types` via a request object, either of type # {Google::Cloud::Dialogflow::V2::BatchUpdateEntityTypesRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::BatchUpdateEntityTypesRequest, 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_entity_types(parent: nil, entity_type_batch_uri: nil, entity_type_batch_inline: nil, language_code: nil, update_mask: nil) # Pass arguments to `batch_update_entity_types` 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 entity types in. # Format: `projects//agent`. # @param entity_type_batch_uri [String] # The URI to a Google Cloud Storage file containing entity types to update # or create. The file format can either be a serialized proto (of # EntityBatch type) or a JSON object. Note: The URI must start with # "gs://". # @param entity_type_batch_inline [Google::Cloud::Dialogflow::V2::EntityTypeBatch, Hash] # The collection of entity types 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. # # @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_entity_types request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::BatchUpdateEntityTypesRequest # 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_entity_types.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_entity_types.timeout, metadata: metadata, retry_policy: @config.rpcs.batch_update_entity_types.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @entity_types_stub.call_rpc :batch_update_entity_types, 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 entity types in the specified agent. # # Operation # # @overload batch_delete_entity_types(request, options = nil) # Pass arguments to `batch_delete_entity_types` via a request object, either of type # {Google::Cloud::Dialogflow::V2::BatchDeleteEntityTypesRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::BatchDeleteEntityTypesRequest, 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_entity_types(parent: nil, entity_type_names: nil) # Pass arguments to `batch_delete_entity_types` 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 entity_type_names [Array] # Required. The names entity types to delete. All names must point to the # same agent as `parent`. # # @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_entity_types request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::BatchDeleteEntityTypesRequest # 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_entity_types.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_entity_types.timeout, metadata: metadata, retry_policy: @config.rpcs.batch_delete_entity_types.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @entity_types_stub.call_rpc :batch_delete_entity_types, 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 ## # Creates multiple new entities in the specified entity type. # # Operation # # @overload batch_create_entities(request, options = nil) # Pass arguments to `batch_create_entities` via a request object, either of type # {Google::Cloud::Dialogflow::V2::BatchCreateEntitiesRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::BatchCreateEntitiesRequest, 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_create_entities(parent: nil, entities: nil, language_code: nil) # Pass arguments to `batch_create_entities` 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 entity type to create entities in. Format: # `projects//agent/entityTypes/`. # @param entities [Array] # Required. The entities 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). # # @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_create_entities request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::BatchCreateEntitiesRequest # 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_create_entities.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_create_entities.timeout, metadata: metadata, retry_policy: @config.rpcs.batch_create_entities.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @entity_types_stub.call_rpc :batch_create_entities, 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 ## # Updates or creates multiple entities in the specified entity type. This # method does not affect entities in the entity type that aren't explicitly # specified in the request. # # # Operation # # @overload batch_update_entities(request, options = nil) # Pass arguments to `batch_update_entities` via a request object, either of type # {Google::Cloud::Dialogflow::V2::BatchUpdateEntitiesRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::BatchUpdateEntitiesRequest, 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_entities(parent: nil, entities: nil, language_code: nil, update_mask: nil) # Pass arguments to `batch_update_entities` 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 entity type to update or create entities in. # Format: `projects//agent/entityTypes/`. # @param entities [Array] # Required. The entities 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. # # @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_entities request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::BatchUpdateEntitiesRequest # 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_entities.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_entities.timeout, metadata: metadata, retry_policy: @config.rpcs.batch_update_entities.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @entity_types_stub.call_rpc :batch_update_entities, 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 entities in the specified entity type. # # # Operation # # @overload batch_delete_entities(request, options = nil) # Pass arguments to `batch_delete_entities` via a request object, either of type # {Google::Cloud::Dialogflow::V2::BatchDeleteEntitiesRequest} or an equivalent Hash. # # @param request [Google::Cloud::Dialogflow::V2::BatchDeleteEntitiesRequest, 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_entities(parent: nil, entity_values: nil, language_code: nil) # Pass arguments to `batch_delete_entities` 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 entity type to delete entries for. Format: # `projects//agent/entityTypes/`. # @param entity_values [Array] # Required. The reference `values` of the entities to delete. Note that # these are not fully-qualified names, i.e. they don't start with # `projects/`. # @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). # # @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_entities request, options = nil raise ArgumentError, "request must be provided" if request.nil? request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::BatchDeleteEntitiesRequest # 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_entities.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_entities.timeout, metadata: metadata, retry_policy: @config.rpcs.batch_delete_entities.retry_policy options.apply_defaults metadata: @config.metadata, retry_policy: @config.retry_policy @entity_types_stub.call_rpc :batch_delete_entities, 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 EntityTypes API. # # This class represents the configuration for EntityTypes, # 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::EntityTypes::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_entity_types # to 20 seconds, and all remaining timeouts to 10 seconds: # # Google::Cloud::Dialogflow::V2::EntityTypes::Client.configure do |config| # config.timeout = 10_000 # config.rpcs.list_entity_types.timeout = 20_000 # end # # To apply the above configuration only to a new client: # # client = Google::Cloud::Dialogflow::V2::EntityTypes::Client.new do |config| # config.timeout = 10_000 # config.rpcs.list_entity_types.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 EntityTypes 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_entity_types` # @return [Gapic::Config::Method] # attr_reader :list_entity_types ## # RPC-specific configuration for `get_entity_type` # @return [Gapic::Config::Method] # attr_reader :get_entity_type ## # RPC-specific configuration for `create_entity_type` # @return [Gapic::Config::Method] # attr_reader :create_entity_type ## # RPC-specific configuration for `update_entity_type` # @return [Gapic::Config::Method] # attr_reader :update_entity_type ## # RPC-specific configuration for `delete_entity_type` # @return [Gapic::Config::Method] # attr_reader :delete_entity_type ## # RPC-specific configuration for `batch_update_entity_types` # @return [Gapic::Config::Method] # attr_reader :batch_update_entity_types ## # RPC-specific configuration for `batch_delete_entity_types` # @return [Gapic::Config::Method] # attr_reader :batch_delete_entity_types ## # RPC-specific configuration for `batch_create_entities` # @return [Gapic::Config::Method] # attr_reader :batch_create_entities ## # RPC-specific configuration for `batch_update_entities` # @return [Gapic::Config::Method] # attr_reader :batch_update_entities ## # RPC-specific configuration for `batch_delete_entities` # @return [Gapic::Config::Method] # attr_reader :batch_delete_entities # @private def initialize parent_rpcs = nil list_entity_types_config = parent_rpcs&.list_entity_types if parent_rpcs&.respond_to? :list_entity_types @list_entity_types = Gapic::Config::Method.new list_entity_types_config get_entity_type_config = parent_rpcs&.get_entity_type if parent_rpcs&.respond_to? :get_entity_type @get_entity_type = Gapic::Config::Method.new get_entity_type_config create_entity_type_config = parent_rpcs&.create_entity_type if parent_rpcs&.respond_to? :create_entity_type @create_entity_type = Gapic::Config::Method.new create_entity_type_config update_entity_type_config = parent_rpcs&.update_entity_type if parent_rpcs&.respond_to? :update_entity_type @update_entity_type = Gapic::Config::Method.new update_entity_type_config delete_entity_type_config = parent_rpcs&.delete_entity_type if parent_rpcs&.respond_to? :delete_entity_type @delete_entity_type = Gapic::Config::Method.new delete_entity_type_config batch_update_entity_types_config = parent_rpcs&.batch_update_entity_types if parent_rpcs&.respond_to? :batch_update_entity_types @batch_update_entity_types = Gapic::Config::Method.new batch_update_entity_types_config batch_delete_entity_types_config = parent_rpcs&.batch_delete_entity_types if parent_rpcs&.respond_to? :batch_delete_entity_types @batch_delete_entity_types = Gapic::Config::Method.new batch_delete_entity_types_config batch_create_entities_config = parent_rpcs&.batch_create_entities if parent_rpcs&.respond_to? :batch_create_entities @batch_create_entities = Gapic::Config::Method.new batch_create_entities_config batch_update_entities_config = parent_rpcs&.batch_update_entities if parent_rpcs&.respond_to? :batch_update_entities @batch_update_entities = Gapic::Config::Method.new batch_update_entities_config batch_delete_entities_config = parent_rpcs&.batch_delete_entities if parent_rpcs&.respond_to? :batch_delete_entities @batch_delete_entities = Gapic::Config::Method.new batch_delete_entities_config yield self if block_given? end end end end end end end end end