Class: Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1WebKeySettings

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/recaptchaenterprise_v1/classes.rb,
lib/google/apis/recaptchaenterprise_v1/representations.rb,
lib/google/apis/recaptchaenterprise_v1/representations.rb

Overview

Settings specific to keys that can be used by websites.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecaptchaenterpriseV1WebKeySettings

Returns a new instance of GoogleCloudRecaptchaenterpriseV1WebKeySettings.



2266
2267
2268
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 2266

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allow_all_domains ⇒ Boolean Also known as: allow_all_domains?

Optional. If set to true, it means allowed_domains will not be enforced. Corresponds to the JSON property allowAllDomains

Returns:

  • (Boolean) 


2236
2237
2238
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 2236

def allow_all_domains
  @allow_all_domains
end

#allow_amp_traffic ⇒ Boolean Also known as: allow_amp_traffic?

Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type. Corresponds to the JSON property allowAmpTraffic

Returns:

  • (Boolean) 


2243
2244
2245
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 2243

def allow_amp_traffic
  @allow_amp_traffic
end

#allowed_domains ⇒ Array<String>

Optional. Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com' Corresponds to the JSON property allowedDomains

Returns:

  • (Array<String>) 


2252
2253
2254
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 2252

def allowed_domains
  @allowed_domains
end

#challenge_security_preference ⇒ String

Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. Corresponds to the JSON property challengeSecurityPreference

Returns:

  • (String) 


2259
2260
2261
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 2259

def challenge_security_preference
  @challenge_security_preference
end

#integration_type ⇒ String

Required. Describes how this key is integrated with the website. Corresponds to the JSON property integrationType

Returns:

  • (String) 


2264
2265
2266
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 2264

def integration_type
  @integration_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2271
2272
2273
2274
2275
2276
2277
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 2271

def update!(**args)
  @allow_all_domains = args[:allow_all_domains] if args.key?(:allow_all_domains)
  @allow_amp_traffic = args[:allow_amp_traffic] if args.key?(:allow_amp_traffic)
  @allowed_domains = args[:allowed_domains] if args.key?(:allowed_domains)
  @challenge_security_preference = args[:challenge_security_preference] if args.key?(:challenge_security_preference)
  @integration_type = args[:integration_type] if args.key?(:integration_type)
end