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.



875
876
877
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 875

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

Instance Attribute Details

#android_settingsGoogle::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1AndroidKeySettings

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



833
834
835
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 833

def android_settings
  @android_settings
end

#create_timeString

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

Returns:

  • (String)


838
839
840
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 838

def create_time
  @create_time
end

#display_nameString

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

Returns:

  • (String)


843
844
845
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 843

def display_name
  @display_name
end

#ios_settingsGoogle::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1IosKeySettings

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



848
849
850
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 848

def ios_settings
  @ios_settings
end

#labelsHash<String,String>

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

Returns:

  • (Hash<String,String>)


853
854
855
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 853

def labels
  @labels
end

#nameString

The resource name for the Key in the format "projects/project/keys/key". Corresponds to the JSON property name

Returns:

  • (String)


858
859
860
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 858

def name
  @name
end

#testing_optionsGoogle::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TestingOptions

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



863
864
865
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 863

def testing_options
  @testing_options
end

#waf_settingsGoogle::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1WafSettings

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



868
869
870
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 868

def waf_settings
  @waf_settings
end

#web_settingsGoogle::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1WebKeySettings

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



873
874
875
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 873

def web_settings
  @web_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



880
881
882
883
884
885
886
887
888
889
890
# File 'lib/google/apis/recaptchaenterprise_v1/classes.rb', line 880

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)
  @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)
  @waf_settings = args[:waf_settings] if args.key?(:waf_settings)
  @web_settings = args[:web_settings] if args.key?(:web_settings)
end