Reference documentation and code samples for the reCAPTCHA Enterprise V1 API class Google::Cloud::RecaptchaEnterprise::V1::Key.
A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#android_settings
def android_settings() -> ::Google::Cloud::RecaptchaEnterprise::V1::AndroidKeySettings
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::AndroidKeySettings) — Settings for keys that can be used by Android apps.
#android_settings=
def android_settings=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::AndroidKeySettings
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1::AndroidKeySettings) — Settings for keys that can be used by Android apps.
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::AndroidKeySettings) — Settings for keys that can be used by Android apps.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The timestamp corresponding to the creation of this key.
#display_name
def display_name() -> ::String
Returns
- (::String) — Required. Human-readable display name of this key. Modifiable by user.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Required. Human-readable display name of this key. Modifiable by user.
Returns
- (::String) — Required. Human-readable display name of this key. Modifiable by user.
#ios_settings
def ios_settings() -> ::Google::Cloud::RecaptchaEnterprise::V1::IOSKeySettings
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::IOSKeySettings) — Settings for keys that can be used by iOS apps.
#ios_settings=
def ios_settings=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::IOSKeySettings
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1::IOSKeySettings) — Settings for keys that can be used by iOS apps.
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::IOSKeySettings) — Settings for keys that can be used by iOS apps.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. See Creating and managing labels.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. See Creating and managing labels.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. See Creating and managing labels.
#name
def name() -> ::String
Returns
-
(::String) — Identifier. The resource name for the Key in the format
projects/{project}/keys/{key}
.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Identifier. The resource name for the Key in the format
projects/{project}/keys/{key}
.
Returns
-
(::String) — Identifier. The resource name for the Key in the format
projects/{project}/keys/{key}
.
#testing_options
def testing_options() -> ::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions) — Optional. Options for user acceptance testing.
#testing_options=
def testing_options=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions) — Optional. Options for user acceptance testing.
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions) — Optional. Options for user acceptance testing.
#waf_settings
def waf_settings() -> ::Google::Cloud::RecaptchaEnterprise::V1::WafSettings
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::WafSettings) — Optional. Settings for WAF
#waf_settings=
def waf_settings=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::WafSettings
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1::WafSettings) — Optional. Settings for WAF
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::WafSettings) — Optional. Settings for WAF
#web_settings
def web_settings() -> ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings) — Settings for keys that can be used by websites.
#web_settings=
def web_settings=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings
Parameter
- value (::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings) — Settings for keys that can be used by websites.
Returns
- (::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings) — Settings for keys that can be used by websites.