class Google::Cloud::Dialogflow::V2::Intents::Client

Client for the Intents service.

Service for managing {::Google::Cloud::Dialogflow::V2::Intent Intents}.

Attributes

intents_stub[R]

@private

operations_client[R]

Get the associated client for long-running operations.

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

Public Class Methods

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

Configure the Intents Client class.

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

@example

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

@example

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

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

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

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

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # 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

  @intents_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dialogflow::V2::Intents::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

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

Deletes intents 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_intents(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::V2::BatchDeleteIntentsRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload batch_delete_intents(parent: nil, intents: nil)

Pass arguments to `batch_delete_intents` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param parent [::String]
  Required. The name of the agent to delete all entities types for. Format:
  `projects/<Project ID>/agent`.
@param intents [::Array<::Google::Cloud::Dialogflow::V2::Intent, ::Hash>]
  Required. The collection of intents to delete. Only intent `name` must be
  filled in.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

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

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

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

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.batch_delete_intents.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @intents_stub.call_rpc :batch_delete_intents, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
batch_update_intents(request, options = nil) { |response, operation| ... } click to toggle source

Updates/Creates multiple intents 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_intents(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::V2::BatchUpdateIntentsRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload batch_update_intents(parent: nil, intent_batch_uri: nil, intent_batch_inline: nil, language_code: nil, update_mask: nil, intent_view: nil)

Pass arguments to `batch_update_intents` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param parent [::String]
  Required. The name of the agent to update or create intents in.
  Format: `projects/<Project ID>/agent`.
@param intent_batch_uri [::String]
  The URI to a Google Cloud Storage file containing intents to update or
  create. The file format can either be a serialized proto (of IntentBatch
  type) or JSON object. Note: The URI must start with "gs://".
@param intent_batch_inline [::Google::Cloud::Dialogflow::V2::IntentBatch, ::Hash]
  The collection of intents to update or create.
@param language_code [::String]
  Optional. The language used to access language-specific data.
  If not specified, the agent's default language is used.
  For more information, see
  [Multilingual intent and entity
  data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  Optional. The mask to control which fields get updated.
@param intent_view [::Google::Cloud::Dialogflow::V2::IntentView]
  Optional. The resource view to apply to the returned intent.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

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

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

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

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.batch_update_intents.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @intents_stub.call_rpc :batch_update_intents, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
configure() { |config| ... } click to toggle source

Configure the Intents Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.

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

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

@return [Client::Configuration]

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

Creates an intent 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_intent(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::V2::CreateIntentRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload create_intent(parent: nil, intent: nil, language_code: nil, intent_view: nil)

Pass arguments to `create_intent` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param parent [::String]
  Required. The agent to create a intent for.
  Format: `projects/<Project ID>/agent`.
@param intent [::Google::Cloud::Dialogflow::V2::Intent, ::Hash]
  Required. The intent to create.
@param language_code [::String]
  Optional. The language used to access language-specific data.
  If not specified, the agent's default language is used.
  For more information, see
  [Multilingual intent and entity
  data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
@param intent_view [::Google::Cloud::Dialogflow::V2::IntentView]
  Optional. The resource view to apply to the returned intent.

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

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

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

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

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

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_intent.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @intents_stub.call_rpc :create_intent, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
delete_intent(request, options = nil) { |response, operation| ... } click to toggle source

Deletes the specified intent and its direct or indirect followup intents.

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_intent(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::V2::DeleteIntentRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload delete_intent(name: nil)

Pass arguments to `delete_intent` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param name [::String]
  Required. The name of the intent to delete. If this intent has direct or
  indirect followup intents, we also delete them.
  Format: `projects/<Project ID>/agent/intents/<Intent 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/intents/client.rb, line 532
def delete_intent request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

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

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_intent.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @intents_stub.call_rpc :delete_intent, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
get_intent(request, options = nil) { |response, operation| ... } click to toggle source

Retrieves the specified intent.

@overload get_intent(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::V2::GetIntentRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_intent(name: nil, language_code: nil, intent_view: nil)

Pass arguments to `get_intent` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param name [::String]
  Required. The name of the intent.
  Format: `projects/<Project ID>/agent/intents/<Intent 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).
@param intent_view [::Google::Cloud::Dialogflow::V2::IntentView]
  Optional. The resource view to apply to the returned intent.

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

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

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

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

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

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_intent.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @intents_stub.call_rpc :get_intent, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
list_intents(request, options = nil) { |response, operation| ... } click to toggle source

Returns the list of all intents in the specified agent.

@overload list_intents(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::V2::ListIntentsRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload list_intents(parent: nil, language_code: nil, intent_view: nil, page_size: nil, page_token: nil)

Pass arguments to `list_intents` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param parent [::String]
  Required. The agent to list all intents from.
  Format: `projects/<Project ID>/agent` or `projects/<Project
  ID>/locations/<Location ID>/agent`.

  Alternatively, you can specify the environment to list intents for.
  Format: `projects/<Project ID>/agent/environments/<Environment ID>`
  or `projects/<Project ID>/locations/<Location
  ID>/agent/environments/<Environment ID>`.
  Note: training phrases of the intents will not be returned for non-draft
  environment.
@param language_code [::String]
  Optional. The language used to access language-specific data.
  If not specified, the agent's default language is used.
  For more information, see
  [Multilingual intent and entity
  data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
@param intent_view [::Google::Cloud::Dialogflow::V2::IntentView]
  Optional. The resource view to apply to the returned intent.
@param page_size [::Integer]
  Optional. The maximum number of items to return in a single page. By
  default 100 and at most 1000.
@param page_token [::String]
  Optional. The next_page_token value returned from a previous list request.

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

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

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

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

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

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_intents.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @intents_stub.call_rpc :list_intents, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @intents_stub, :list_intents, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
update_intent(request, options = nil) { |response, operation| ... } click to toggle source

Updates the specified intent.

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_intent(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::V2::UpdateIntentRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload update_intent(intent: nil, language_code: nil, update_mask: nil, intent_view: nil)

Pass arguments to `update_intent` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param intent [::Google::Cloud::Dialogflow::V2::Intent, ::Hash]
  Required. The intent to update.
@param language_code [::String]
  Optional. The language used to access language-specific data.
  If not specified, the agent's default language is used.
  For more information, see
  [Multilingual intent and entity
  data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  Optional. The mask to control which fields get updated.
@param intent_view [::Google::Cloud::Dialogflow::V2::IntentView]
  Optional. The resource view to apply to the returned intent.

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

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

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

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

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

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_intent.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "intent.name" => request.intent.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @intents_stub.call_rpc :update_intent, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end