class Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client

Client for the SessionEntityTypes service.

Service for managing {::Google::Cloud::Dialogflow::V2::SessionEntityType SessionEntityTypes}.

Attributes

session_entity_types_stub[R]

@private

Public Class Methods

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

Configure the SessionEntityTypes Client class.

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

@example

# Modify the configuration for all SessionEntityTypes clients
::Google::Cloud::Dialogflow::V2::SessionEntityTypes::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/session_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 SessionEntityTypes client object.

@example

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

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

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

# File lib/google/cloud/dialogflow/v2/session_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/session_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

  @session_entity_types_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dialogflow::V2::SessionEntityTypes::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 SessionEntityTypes 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::SessionEntityTypes::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/session_entity_types/client.rb, line 93
def configure
  yield @config if block_given?
  @config
end
create_session_entity_type(request, options = nil) { |response, operation| ... } click to toggle source

Creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

@overload create_session_entity_type(request, options = nil)

Pass arguments to `create_session_entity_type` via a request object, either of type
{::Google::Cloud::Dialogflow::V2::CreateSessionEntityTypeRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::V2::CreateSessionEntityTypeRequest, ::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_session_entity_type(parent: nil, session_entity_type: nil)

Pass arguments to `create_session_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 session to create a session entity type for.
  Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
  `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/
  sessions/<Session ID>`.
  If `Environment ID` is not specified, we assume default 'draft'
  environment. If `User ID` is not specified, we assume default '-' user.
@param session_entity_type [::Google::Cloud::Dialogflow::V2::SessionEntityType, ::Hash]
  Required. The session entity type to create.

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

@return [::Google::Cloud::Dialogflow::V2::SessionEntityType]

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

# File lib/google/cloud/dialogflow/v2/session_entity_types/client.rb, line 356
def create_session_entity_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::CreateSessionEntityTypeRequest

  # 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_session_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_session_entity_type.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_session_entity_type.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @session_entity_types_stub.call_rpc :create_session_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_session_entity_type(request, options = nil) { |response, operation| ... } click to toggle source

Deletes the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

@overload delete_session_entity_type(request, options = nil)

Pass arguments to `delete_session_entity_type` via a request object, either of type
{::Google::Cloud::Dialogflow::V2::DeleteSessionEntityTypeRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::V2::DeleteSessionEntityTypeRequest, ::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_session_entity_type(name: nil)

Pass arguments to `delete_session_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/sessions/<Session ID>/entityTypes/<Entity Type
  Display Name>` or `projects/<Project ID>/agent/environments/<Environment
  ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
  Name>`.
  If `Environment ID` is not specified, we assume default 'draft'
  environment. If `User ID` is not specified, we assume default '-' user.

@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/session_entity_types/client.rb, line 508
def delete_session_entity_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::DeleteSessionEntityTypeRequest

  # 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_session_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_session_entity_type.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_session_entity_type.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @session_entity_types_stub.call_rpc :delete_session_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_session_entity_type(request, options = nil) { |response, operation| ... } click to toggle source

Retrieves the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

@overload get_session_entity_type(request, options = nil)

Pass arguments to `get_session_entity_type` via a request object, either of type
{::Google::Cloud::Dialogflow::V2::GetSessionEntityTypeRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::V2::GetSessionEntityTypeRequest, ::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_session_entity_type(name: nil)

Pass arguments to `get_session_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 session entity type. Format:
  `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
  Display Name>` or `projects/<Project ID>/agent/environments/<Environment
  ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
  Name>`.
  If `Environment ID` is not specified, we assume default 'draft'
  environment. If `User ID` is not specified, we assume default '-' user.

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

@return [::Google::Cloud::Dialogflow::V2::SessionEntityType]

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

# File lib/google/cloud/dialogflow/v2/session_entity_types/client.rb, line 274
def get_session_entity_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::GetSessionEntityTypeRequest

  # 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_session_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_session_entity_type.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_session_entity_type.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @session_entity_types_stub.call_rpc :get_session_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_session_entity_types(request, options = nil) { |response, operation| ... } click to toggle source

Returns the list of all session entity types in the specified session.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

@overload list_session_entity_types(request, options = nil)

Pass arguments to `list_session_entity_types` via a request object, either of type
{::Google::Cloud::Dialogflow::V2::ListSessionEntityTypesRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::V2::ListSessionEntityTypesRequest, ::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_session_entity_types(parent: nil, page_size: nil, page_token: nil)

Pass arguments to `list_session_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 session to list all session entity types from.
  Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
  `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/
  sessions/<Session ID>`.
  If `Environment ID` is not specified, we assume default 'draft'
  environment. If `User ID` is not specified, we assume default '-' user.
@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::SessionEntityType>] @yieldparam operation [::GRPC::ActiveCall::Operation]

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

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

# File lib/google/cloud/dialogflow/v2/session_entity_types/client.rb, line 195
def list_session_entity_types request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::ListSessionEntityTypesRequest

  # 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_session_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_session_entity_types.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_session_entity_types.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @session_entity_types_stub.call_rpc :list_session_entity_types, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @session_entity_types_stub, :list_session_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_session_entity_type(request, options = nil) { |response, operation| ... } click to toggle source

Updates the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

@overload update_session_entity_type(request, options = nil)

Pass arguments to `update_session_entity_type` via a request object, either of type
{::Google::Cloud::Dialogflow::V2::UpdateSessionEntityTypeRequest} or an equivalent Hash.

@param request [::Google::Cloud::Dialogflow::V2::UpdateSessionEntityTypeRequest, ::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_session_entity_type(session_entity_type: nil, update_mask: nil)

Pass arguments to `update_session_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 session_entity_type [::Google::Cloud::Dialogflow::V2::SessionEntityType, ::Hash]
  Required. The session entity type to update.
@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::SessionEntityType] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Dialogflow::V2::SessionEntityType]

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

# File lib/google/cloud/dialogflow/v2/session_entity_types/client.rb, line 430
def update_session_entity_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::UpdateSessionEntityTypeRequest

  # 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_session_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 = {
    "session_entity_type.name" => request.session_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_session_entity_type.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_session_entity_type.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @session_entity_types_stub.call_rpc :update_session_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