Module: Google::Cloud::RecaptchaEnterprise

Defined in:
lib/google/cloud/recaptcha_enterprise.rb,
lib/google/cloud/recaptcha_enterprise/version.rb

Constant Summary collapse

VERSION = 
"1.5.1"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.recaptcha_enterprise| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-recaptcha_enterprise library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



106
107
108
109
110
 
# File 'lib/google/cloud/recaptcha_enterprise.rb', line 106

def self.configure
  yield ::Google::Cloud.configure.recaptcha_enterprise if block_given?

  ::Google::Cloud.configure.recaptcha_enterprise
end

.recaptcha_enterprise_service(version: :v1, &block) ⇒ ::Object

Create a new client object for RecaptchaEnterpriseService.

By default, this returns an instance of Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the RecaptchaEnterpriseService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About RecaptchaEnterpriseService

Service to determine the likelihood an event is legitimate.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (::Object) —

    A client object for the specified version.



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/google/cloud/recaptcha_enterprise.rb', line 67

def self.recaptcha_enterprise_service version: :v1, &block
  require "google/cloud/recaptcha_enterprise/#{version.to_s.downcase}"

  package_name = Google::Cloud::RecaptchaEnterprise
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::RecaptchaEnterprise.const_get(package_name).const_get(:RecaptchaEnterpriseService)
  service_module.const_get(:Client).new(&block)
end