class Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client

Client for the RecaptchaEnterpriseService service.

Service to determine the likelihood an event is legitimate.

Attributes

recaptcha_enterprise_service_stub[R]

@private

Public Class Methods

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

Configure the RecaptchaEnterpriseService Client class.

See {::Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all RecaptchaEnterpriseService clients
::Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::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/recaptcha_enterprise/v1/recaptcha_enterprise_service/client.rb, line 56
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "RecaptchaEnterprise", "V1"]
    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.rpcs.create_assessment.timeout = 600.0

    default_config.rpcs.annotate_assessment.timeout = 600.0

    default_config.rpcs.create_key.timeout = 600.0

    default_config.rpcs.list_keys.timeout = 600.0

    default_config.rpcs.get_key.timeout = 600.0

    default_config.rpcs.update_key.timeout = 600.0

    default_config.rpcs.delete_key.timeout = 600.0

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

Create a new RecaptchaEnterpriseService client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new do |config|
  config.timeout = 10.0
end

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

# File lib/google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service/client.rb, line 123
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/recaptchaenterprise/v1/recaptchaenterprise_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

  @recaptcha_enterprise_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

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

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fradulent.

@overload annotate_assessment(request, options = nil)

Pass arguments to `annotate_assessment` via a request object, either of type
{::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest} or an equivalent Hash.

@param request [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest, ::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 annotate_assessment(name: nil, annotation: nil)

Pass arguments to `annotate_assessment` 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 resource name of the Assessment, in the format
  "projects/\\{project}/assessments/\\{assessment}".
@param annotation [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation]
  Required. The annotation that will be assigned to the Event.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentResponse]

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

# File lib/google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service/client.rb, line 265
def annotate_assessment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest

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

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

  @recaptcha_enterprise_service_stub.call_rpc :annotate_assessment, 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
configure() { |config| ... } click to toggle source

Configure the RecaptchaEnterpriseService 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::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::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/recaptcha_enterprise/v1/recaptcha_enterprise_service/client.rb, line 102
def configure
  yield @config if block_given?
  @config
end
create_assessment(request, options = nil) { |response, operation| ... } click to toggle source

Creates an Assessment of the likelihood an event is legitimate.

@overload create_assessment(request, options = nil)

Pass arguments to `create_assessment` via a request object, either of type
{::Google::Cloud::RecaptchaEnterprise::V1::CreateAssessmentRequest} or an equivalent Hash.

@param request [::Google::Cloud::RecaptchaEnterprise::V1::CreateAssessmentRequest, ::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_assessment(parent: nil, assessment: nil)

Pass arguments to `create_assessment` 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 project in which the assessment will be created,
  in the format "projects/\\{project}".
@param assessment [::Google::Cloud::RecaptchaEnterprise::V1::Assessment, ::Hash]
  Required. The assessment details.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Assessment] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::RecaptchaEnterprise::V1::Assessment]

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

# File lib/google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service/client.rb, line 193
def create_assessment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::CreateAssessmentRequest

  # 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_assessment.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::RecaptchaEnterprise::V1::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_assessment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_assessment.retry_policy

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

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

Creates a new reCAPTCHA Enterprise key.

@overload create_key(request, options = nil)

Pass arguments to `create_key` via a request object, either of type
{::Google::Cloud::RecaptchaEnterprise::V1::CreateKeyRequest} or an equivalent Hash.

@param request [::Google::Cloud::RecaptchaEnterprise::V1::CreateKeyRequest, ::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_key(parent: nil, key: nil)

Pass arguments to `create_key` 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 project in which the key will be created, in the
  format "projects/\\{project}".
@param key [::Google::Cloud::RecaptchaEnterprise::V1::Key, ::Hash]
  Required. Information to create a reCAPTCHA Enterprise key.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Key] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::RecaptchaEnterprise::V1::Key]

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

# File lib/google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service/client.rb, line 336
def create_key request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::CreateKeyRequest

  # 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_key.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::RecaptchaEnterprise::V1::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_key.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_key.retry_policy

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

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

Deletes the specified key.

@overload delete_key(request, options = nil)

Pass arguments to `delete_key` via a request object, either of type
{::Google::Cloud::RecaptchaEnterprise::V1::DeleteKeyRequest} or an equivalent Hash.

@param request [::Google::Cloud::RecaptchaEnterprise::V1::DeleteKeyRequest, ::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_key(name: nil)

Pass arguments to `delete_key` 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 key to be deleted, in the format
  "projects/\\{project}/keys/\\{key}".

@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/recaptcha_enterprise/v1/recaptcha_enterprise_service/client.rb, line 621
def delete_key request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::DeleteKeyRequest

  # 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_key.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::RecaptchaEnterprise::V1::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_key.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_key.retry_policy

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

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

Returns the specified key.

@overload get_key(request, options = nil)

Pass arguments to `get_key` via a request object, either of type
{::Google::Cloud::RecaptchaEnterprise::V1::GetKeyRequest} or an equivalent Hash.

@param request [::Google::Cloud::RecaptchaEnterprise::V1::GetKeyRequest, ::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_key(name: nil)

Pass arguments to `get_key` 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 requested key, in the format
  "projects/\\{project}/keys/\\{key}".

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Key] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::RecaptchaEnterprise::V1::Key]

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

# File lib/google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service/client.rb, line 481
def get_key request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::GetKeyRequest

  # 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_key.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::RecaptchaEnterprise::V1::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_key.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_key.retry_policy

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

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

Returns the list of all keys that belong to a project.

@overload list_keys(request, options = nil)

Pass arguments to `list_keys` via a request object, either of type
{::Google::Cloud::RecaptchaEnterprise::V1::ListKeysRequest} or an equivalent Hash.

@param request [::Google::Cloud::RecaptchaEnterprise::V1::ListKeysRequest, ::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_keys(parent: nil, page_size: nil, page_token: nil)

Pass arguments to `list_keys` 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 project that contains the keys that will be
  listed, in the format "projects/\\{project}".
@param page_size [::Integer]
  Optional. The maximum number of keys to return. Default is 10. Max limit is
  1000.
@param page_token [::String]
  Optional. The next_page_token value returned from a previous.
  ListKeysRequest, if any.

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

@return [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::Key>]

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

# File lib/google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service/client.rb, line 411
def list_keys request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::ListKeysRequest

  # 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_keys.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::RecaptchaEnterprise::V1::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_keys.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_keys.retry_policy

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

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

Updates the specified key.

@overload update_key(request, options = nil)

Pass arguments to `update_key` via a request object, either of type
{::Google::Cloud::RecaptchaEnterprise::V1::UpdateKeyRequest} or an equivalent Hash.

@param request [::Google::Cloud::RecaptchaEnterprise::V1::UpdateKeyRequest, ::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_key(key: nil, update_mask: nil)

Pass arguments to `update_key` 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 key [::Google::Cloud::RecaptchaEnterprise::V1::Key, ::Hash]
  Required. The key to update.
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  Optional. The mask to control which field of the key get updated. If the mask is not
  present, all fields will be updated.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Key] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::RecaptchaEnterprise::V1::Key]

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

# File lib/google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service/client.rb, line 552
def update_key request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::UpdateKeyRequest

  # 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_key.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::RecaptchaEnterprise::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "key.name" => request.key.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_key.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_key.retry_policy

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

  @recaptcha_enterprise_service_stub.call_rpc :update_key, 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