class Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client

Client for the EntityTypes service.

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

Attributes

entity_types_stub[R]

@private

Public Class Methods

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

Configure the EntityTypes Client class.

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

@example

# Modify the configuration for all EntityTypes clients
::Google::Cloud::Dialogflow::CX::V3::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/cx/v3/entity_types/client.rb, line 57
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Dialogflow", "CX", "V3"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

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

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

Create a new EntityTypes client object.

@example

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

# Create a client using a custom configuration
client = ::Google::Cloud::Dialogflow::CX::V3::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/cx/v3/entity_types/client.rb, line 115
def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/dialogflow/cx/v3/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

  @entity_types_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

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::CX::V3::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/cx/v3/entity_types/client.rb, line 94
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 a flow prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/cx/docs/concept/training).

@overload create_entity_type(request, options = nil)

Pass arguments to `create_entity_type` via a request object, either of type
{::Google::Cloud::Dialogflow::CX::V3::CreateEntityTypeRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::CX::V3::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>/locations/<Location ID>/agents/<Agent ID>`.
@param entity_type [::Google::Cloud::Dialogflow::CX::V3::EntityType, ::Hash]
  Required. The entity type to create.
@param language_code [::String]
  The language of the following fields in `entity_type`:

  *   `EntityType.entities.value`
  *   `EntityType.entities.synonyms`
  *   `EntityType.excluded_phrases.value`

  If not specified, the agent's default language is used.
  [Many
  languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
  are supported.
  Note: languages must be enabled in the agent before they can be used.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::EntityType] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dialogflow::CX::V3::EntityType]

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

# File lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb, line 372
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::CX::V3::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::CX::V3::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 a flow prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/cx/docs/concept/training).

@overload delete_entity_type(request, options = nil)

Pass arguments to `delete_entity_type` via a request object, either of type
{::Google::Cloud::Dialogflow::CX::V3::DeleteEntityTypeRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::CX::V3::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, force: 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>/locations/<Location ID>/agents/<Agent
  ID>/entityTypes/<Entity Type ID>`.
@param force [::Boolean]
  This field has no effect for entity type not being used.
  For entity types that are used by intents or pages:

  *  If `force` is set to false, an error will be returned with message
     indicating the referencing resources.
  *  If `force` is set to true, Dialogflow will remove the entity type, as
     well as any references to the entity type (i.e. Page
     {::Google::Cloud::Dialogflow::CX::V3::Form::Parameter parameter} of the entity type will be changed to
     '@sys.any' and intent {::Google::Cloud::Dialogflow::CX::V3::Intent::Parameter parameter} of the entity type
     will be removed).

@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/cx/v3/entity_types/client.rb, line 543
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::CX::V3::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::CX::V3::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::CX::V3::GetEntityTypeRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::CX::V3::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>/locations/<Location ID>/agents/<Agent
  ID>/entityTypes/<Entity Type ID>`.
@param language_code [::String]
  The language to retrieve the entity type for. The following fields are
  language dependent:

  *   `EntityType.entities.value`
  *   `EntityType.entities.synonyms`
  *   `EntityType.excluded_phrases.value`

  If not specified, the agent's default language is used.
  [Many
  languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
  are supported.
  Note: languages must be enabled in the agent before they can be used.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::EntityType] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dialogflow::CX::V3::EntityType]

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

# File lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb, line 285
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::CX::V3::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::CX::V3::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::CX::V3::ListEntityTypesRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::CX::V3::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 for.
  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
@param language_code [::String]
  The language to list entity types for. The following fields are language
  dependent:

  *   `EntityType.entities.value`
  *   `EntityType.entities.synonyms`
  *   `EntityType.excluded_phrases.value`

  If not specified, the agent's default language is used.
  [Many
  languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
  are supported.
  Note: languages must be enabled in the agent before they can be used.
@param page_size [::Integer]
  The maximum number of items to return in a single page. By default 100 and
  at most 1000.
@param page_token [::String]
  The next_page_token value returned from a previous list request.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::EntityType>] @yieldparam operation [::GRPC::ActiveCall::Operation]

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

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

# File lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb, line 201
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::CX::V3::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::CX::V3::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 a flow prior to sending it queries. See the [training documentation](cloud.google.com/dialogflow/cx/docs/concept/training).

@overload update_entity_type(request, options = nil)

Pass arguments to `update_entity_type` via a request object, either of type
{::Google::Cloud::Dialogflow::CX::V3::UpdateEntityTypeRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::CX::V3::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::CX::V3::EntityType, ::Hash]
  Required. The entity type to update.
@param language_code [::String]
  The language of the following fields in `entity_type`:

  *   `EntityType.entities.value`
  *   `EntityType.entities.synonyms`
  *   `EntityType.excluded_phrases.value`

  If not specified, the agent's default language is used.
  [Many
  languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
  are supported.
  Note: languages must be enabled in the agent before they can be used.
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  The mask to control which fields get updated.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::EntityType] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dialogflow::CX::V3::EntityType]

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

# File lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb, line 458
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::CX::V3::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::CX::V3::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