Class: Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1Key

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

A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecaptchaenterpriseV1Key

Returns a new instance of GoogleCloudRecaptchaenterpriseV1Key.



1452
1453
1454
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1452

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

Instance Attribute Details

#android_settings ⇒ Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1AndroidKeySettings

Settings specific to keys that can be used by Android apps. Corresponds to the JSON property androidSettings

Returns:



1398
1399
1400
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1398

def android_settings
  @android_settings
end

#create_time ⇒ String

Output only. The timestamp corresponding to the creation of this key. Corresponds to the JSON property createTime

Returns:

  • (String) 


1403
1404
1405
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1403

def create_time
  @create_time
end

#display_name ⇒ String

Required. Human-readable display name of this key. Modifiable by user. Corresponds to the JSON property displayName

Returns:

  • (String) 


1408
1409
1410
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1408

def display_name
  @display_name
end

#express_settings ⇒ Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1ExpressKeySettings

Settings specific to keys that can be used for reCAPTCHA Express. Corresponds to the JSON property expressSettings

Returns:



1413
1414
1415
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1413

def express_settings
  @express_settings
end

#ios_settings ⇒ Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1IosKeySettings

Settings specific to keys that can be used by iOS apps. Corresponds to the JSON property iosSettings

Returns:



1418
1419
1420
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1418

def ios_settings
  @ios_settings
end

#labels ⇒ Hash<String,String>

Optional. See Creating and managing labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1424
1425
1426
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1424

def labels
  @labels
end

#name ⇒ String

Identifier. The resource name for the Key in the format projects/project/ keys/key`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


1430
1431
1432
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1430

def name
  @name
end

#testing_options ⇒ Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TestingOptions

Options for user acceptance testing. Corresponds to the JSON property testingOptions

Returns:



1435
1436
1437
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1435

def testing_options
  @testing_options
end

#universal_settings ⇒ Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1UniversalKeySettings

Settings for keys that are configured through their Policy. Corresponds to the JSON property universalSettings

Returns:



1440
1441
1442
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1440

def universal_settings
  @universal_settings
end

#waf_settings ⇒ Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1WafSettings

Settings specific to keys that can be used for WAF (Web Application Firewall). Corresponds to the JSON property wafSettings

Returns:



1445
1446
1447
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1445

def waf_settings
  @waf_settings
end

#web_settings ⇒ Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1WebKeySettings

Settings specific to keys that can be used by websites. Corresponds to the JSON property webSettings

Returns:



1450
1451
1452
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1450

def web_settings
  @web_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
 
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 1457

def update!(**args)
  @android_settings = args[:android_settings] if args.key?(:android_settings)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @express_settings = args[:express_settings] if args.key?(:express_settings)
  @ios_settings = args[:ios_settings] if args.key?(:ios_settings)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @testing_options = args[:testing_options] if args.key?(:testing_options)
  @universal_settings = args[:universal_settings] if args.key?(:universal_settings)
  @waf_settings = args[:waf_settings] if args.key?(:waf_settings)
  @web_settings = args[:web_settings] if args.key?(:web_settings)
end