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

Client for the Experiments service.

Service for managing {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiments}.

Attributes

experiments_stub[R]

@private

Public Class Methods

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

Configure the Experiments Client class.

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

@example

# Modify the configuration for all Experiments clients
::Google::Cloud::Dialogflow::CX::V3::Experiments::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/experiments/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 Experiments client object.

@example

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

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

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

# File lib/google/cloud/dialogflow/cx/v3/experiments/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/experiment_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

  @experiments_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dialogflow::CX::V3::Experiments::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 Experiments 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::Experiments::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/experiments/client.rb, line 94
def configure
  yield @config if block_given?
  @config
end
create_experiment(request, options = nil) { |response, operation| ... } click to toggle source

Creates an {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiment} in the specified {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.

@overload create_experiment(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::CX::V3::CreateExperimentRequest, ::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_experiment(parent: nil, experiment: nil)

Pass arguments to `create_experiment` 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 {::Google::Cloud::Dialogflow::CX::V3::Agent Agent} to create an {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} for.
  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  ID>/environments/<Environment ID>`.
@param experiment [::Google::Cloud::Dialogflow::CX::V3::Experiment, ::Hash]
  Required. The experiment to create.

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

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

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

# File lib/google/cloud/dialogflow/cx/v3/experiments/client.rb, line 332
def create_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::CreateExperimentRequest

  # 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_experiment.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_experiment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_experiment.retry_policy

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

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

Deletes the specified {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiment}.

@overload delete_experiment(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::CX::V3::DeleteExperimentRequest, ::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_experiment(name: nil)

Pass arguments to `delete_experiment` 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 {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to delete.
  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  ID>/environments/<Environment ID>/experiments/<Experiment 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/cx/v3/experiments/client.rb, line 472
def delete_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::DeleteExperimentRequest

  # 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_experiment.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_experiment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_experiment.retry_policy

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

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

Retrieves the specified {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiment}.

@overload get_experiment(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::CX::V3::GetExperimentRequest, ::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_experiment(name: nil)

Pass arguments to `get_experiment` 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 {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.
  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  ID>/environments/<Environment ID>/experiments/<Experiment ID>`.

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

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

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

# File lib/google/cloud/dialogflow/cx/v3/experiments/client.rb, line 260
def get_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::GetExperimentRequest

  # 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_experiment.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_experiment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_experiment.retry_policy

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

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

Returns the list of all experiments in the specified {::Google::Cloud::Dialogflow::CX::V3::Environment Environment}.

@overload list_experiments(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::CX::V3::ListExperimentsRequest, ::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_experiments(parent: nil, page_size: nil, page_token: nil)

Pass arguments to `list_experiments` 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 {::Google::Cloud::Dialogflow::CX::V3::Environment Environment} to list all environments for.
  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  ID>/environments/<Environment ID>`.
@param page_size [::Integer]
  The maximum number of items to return in a single page. By default 20 and
  at most 100.
@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::Experiment>] @yieldparam operation [::GRPC::ActiveCall::Operation]

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

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

# File lib/google/cloud/dialogflow/cx/v3/experiments/client.rb, line 189
def list_experiments request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ListExperimentsRequest

  # 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_experiments.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_experiments.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_experiments.retry_policy

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

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

Starts the specified {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiment}. This rpc only changes the state of experiment from PENDING to RUNNING.

@overload start_experiment(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::CX::V3::StartExperimentRequest, ::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 start_experiment(name: nil)

Pass arguments to `start_experiment` 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. Resource name of the experiment to start.
  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  ID>/environments/<Environment ID>/experiments/<Experiment ID>`.

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

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

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

# File lib/google/cloud/dialogflow/cx/v3/experiments/client.rb, line 543
def start_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::StartExperimentRequest

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

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

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

Stops the specified {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiment}. This rpc only changes the state of experiment from RUNNING to DONE.

@overload stop_experiment(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::CX::V3::StopExperimentRequest, ::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 stop_experiment(name: nil)

Pass arguments to `stop_experiment` 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. Resource name of the experiment to stop.
  Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  ID>/environments/<Environment ID>/experiments/<Experiment ID>`.

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

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

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

# File lib/google/cloud/dialogflow/cx/v3/experiments/client.rb, line 614
def stop_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::StopExperimentRequest

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

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

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

Updates the specified {::Google::Cloud::Dialogflow::CX::V3::Experiment Experiment}.

@overload update_experiment(request, options = nil)

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

@param request [::Google::Cloud::Dialogflow::CX::V3::UpdateExperimentRequest, ::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_experiment(experiment: nil, update_mask: nil)

Pass arguments to `update_experiment` 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 experiment [::Google::Cloud::Dialogflow::CX::V3::Experiment, ::Hash]
  Required. The experiment to update.
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  Required. 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::Experiment] @yieldparam operation [::GRPC::ActiveCall::Operation]

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

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

# File lib/google/cloud/dialogflow/cx/v3/experiments/client.rb, line 402
def update_experiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::UpdateExperimentRequest

  # 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_experiment.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 = {
    "experiment.name" => request.experiment.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_experiment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_experiment.retry_policy

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

  @experiments_stub.call_rpc :update_experiment, 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