class Google::Cloud::Dialogflow::V2::EntityTypes::Client

Client for the EntityTypes service.

Service for managing {::Google::Cloud::Dialogflow::V2::EntityType EntityTypes}.

Attributes

entity_types_stub[R]

@private

operations_client[R]

Get the associated client for long-running operations.

@return [::Google::Cloud::Dialogflow::V2::EntityTypes::Operations]

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the EntityTypes Client class.

See {::Google::Cloud::Dialogflow::V2::EntityTypes::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all EntityTypes clients
::Google::Cloud::Dialogflow::V2::EntityTypes::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/dialogflow/v2/entity_types/client.rb, line 56
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Dialogflow", "V2"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new EntityTypes client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Dialogflow::V2::EntityTypes::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dialogflow::V2::EntityTypes::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the EntityTypes client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/dialogflow/v2/entity_types/client.rb, line 114
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
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.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

Public Instance Methods

batch_create_entities(request, options = nil) { |response, operation| ... } click to toggle source

Creates multiple new entities in the specified entity type.

This method is a [long-running operation](cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/es/docs/training).

@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/<Project ID>/agent/entityTypes/<Entity Type ID>`.
@param entities [::Array<::Google::Cloud::Dialogflow::V2::EntityType::Entity, ::Hash>]
  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.

# File lib/google/cloud/dialogflow/v2/entity_types/client.rb, line 788
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 timeout:      @config.timeout,
                         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
batch_delete_entities(request, options = nil) { |response, operation| ... } click to toggle source

Deletes entities in the specified entity type.

This method is a [long-running operation](cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/es/docs/training).

@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/<Project ID>/agent/entityTypes/<Entity Type ID>`.
@param entity_values [::Array<::String>]
  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/<Project ID>`.
@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.

# File lib/google/cloud/dialogflow/v2/entity_types/client.rb, line 976
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 timeout:      @config.timeout,
                         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
batch_delete_entity_types(request, options = nil) { |response, operation| ... } click to toggle source

Deletes entity types in the specified agent.

This method is a [long-running operation](cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/es/docs/training).

@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/<Project ID>/agent`.
@param entity_type_names [::Array<::String>]
  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.

# File lib/google/cloud/dialogflow/v2/entity_types/client.rb, line 697
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 timeout:      @config.timeout,
                         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
batch_update_entities(request, options = nil) { |response, operation| ... } click to toggle source

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.

This method is a [long-running operation](cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/es/docs/training).

@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/<Project ID>/agent/entityTypes/<Entity Type ID>`.
@param entities [::Array<::Google::Cloud::Dialogflow::V2::EntityType::Entity, ::Hash>]
  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.

# File lib/google/cloud/dialogflow/v2/entity_types/client.rb, line 883
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 timeout:      @config.timeout,
                         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
batch_update_entity_types(request, options = nil) { |response, operation| ... } click to toggle source

Updates/Creates multiple entity types in the specified agent.

This method is a [long-running operation](cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/es/docs/training).

@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/<Project ID>/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.

# File lib/google/cloud/dialogflow/v2/entity_types/client.rb, line 611
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 timeout:      @config.timeout,
                         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
configure() { |config| ... } click to toggle source

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]

# File lib/google/cloud/dialogflow/v2/entity_types/client.rb, line 93
def configure
  yield @config if block_given?
  @config
end
create_entity_type(request, options = nil) { |response, operation| ... } click to toggle source

Creates an entity type in the specified agent.

Note: You should always train an agent prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/es/docs/training).

@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/<Project ID>/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.

# File lib/google/cloud/dialogflow/v2/entity_types/client.rb, line 362
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 timeout:      @config.timeout,
                         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
delete_entity_type(request, options = nil) { |response, operation| ... } click to toggle source

Deletes the specified entity type.

Note: You should always train an agent prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/es/docs/training).

@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/<Project ID>/agent/entityTypes/<EntityType ID>`.

@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.

# File lib/google/cloud/dialogflow/v2/entity_types/client.rb, line 515
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 timeout:      @config.timeout,
                         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
get_entity_type(request, options = nil) { |response, operation| ... } click to toggle source

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/<Project ID>/agent/entityTypes/<EntityType ID>`.
@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.

# File lib/google/cloud/dialogflow/v2/entity_types/client.rb, line 281
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 timeout:      @config.timeout,
                         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
list_entity_types(request, options = nil) { |response, operation| ... } click to toggle source

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/<Project ID>/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<::Google::Cloud::Dialogflow::V2::EntityType>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::EntityType>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/dialogflow/v2/entity_types/client.rb, line 205
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 timeout:      @config.timeout,
                         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
update_entity_type(request, options = nil) { |response, operation| ... } click to toggle source

Updates the specified entity type.

Note: You should always train an agent prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/es/docs/training).

@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.

# File lib/google/cloud/dialogflow/v2/entity_types/client.rb, line 442
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 timeout:      @config.timeout,
                         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