reCAPTCHA Enterprise V1 API - Class Google::Cloud::RecaptchaEnterprise::V1::Event (v1.4.0)

Reference documentation and code samples for the reCAPTCHA Enterprise V1 API class Google::Cloud::RecaptchaEnterprise::V1::Event.

The event being assessed.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#expected_action

def expected_action() -> ::String

Returns

(::String) — Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise.

#expected_action=

def expected_action=(value) -> ::String

Parameter

value (::String) — Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise.

Returns

(::String) — Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise.

#express

def express() -> ::Boolean

Returns

(::Boolean) — Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, site_key must reference an Express site key.

#express=

def express=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, site_key must reference an Express site key.

Returns

(::Boolean) — Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, site_key must reference an Express site key.

#firewall_policy_evaluation

def firewall_policy_evaluation() -> ::Boolean

Returns

(::Boolean) — Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy is evaluated and a suggested firewall action is returned in the response.

#firewall_policy_evaluation=

def firewall_policy_evaluation=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy is evaluated and a suggested firewall action is returned in the response.

Returns

(::Boolean) — Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy is evaluated and a suggested firewall action is returned in the response.

#fraud_prevention

def fraud_prevention() -> ::Google::Cloud::RecaptchaEnterprise::V1::Event::FraudPrevention

Returns

(::Google::Cloud::RecaptchaEnterprise::V1::Event::FraudPrevention) — Optional. The Fraud Prevention setting for this assessment.

#fraud_prevention=

def fraud_prevention=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::Event::FraudPrevention

Parameter

value (::Google::Cloud::RecaptchaEnterprise::V1::Event::FraudPrevention) — Optional. The Fraud Prevention setting for this assessment.

Returns

(::Google::Cloud::RecaptchaEnterprise::V1::Event::FraudPrevention) — Optional. The Fraud Prevention setting for this assessment.

#hashed_account_id

def hashed_account_id() -> ::String

Returns

(::String) — Optional. Deprecated: use user_info.account_id instead. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.

#hashed_account_id=

def hashed_account_id=(value) -> ::String

Parameter

value (::String) — Optional. Deprecated: use user_info.account_id instead. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.

Returns

(::String) — Optional. Deprecated: use user_info.account_id instead. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.

#headers

def headers() -> ::Array<::String>

Returns

(::Array<::String>) — Optional. HTTP header information about the request.

#headers=

def headers=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — Optional. HTTP header information about the request.

Returns

(::Array<::String>) — Optional. HTTP header information about the request.

#ja3

def ja3() -> ::String

Returns

(::String) — Optional. JA3 fingerprint for SSL clients.

#ja3=

def ja3=(value) -> ::String

Parameter

value (::String) — Optional. JA3 fingerprint for SSL clients.

Returns

(::String) — Optional. JA3 fingerprint for SSL clients.

#requested_uri

def requested_uri() -> ::String

Returns

(::String) — Optional. The URI resource the user requested that triggered an assessment.

#requested_uri=

def requested_uri=(value) -> ::String

Parameter

value (::String) — Optional. The URI resource the user requested that triggered an assessment.

Returns

(::String) — Optional. The URI resource the user requested that triggered an assessment.

#site_key

def site_key() -> ::String

Returns

(::String) — Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.

#site_key=

def site_key=(value) -> ::String

Parameter

value (::String) — Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.

Returns

(::String) — Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.

#token

def token() -> ::String

Returns

(::String) — Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.

#token=

def token=(value) -> ::String

Parameter

value (::String) — Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.

Returns

(::String) — Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.

#transaction_data

def transaction_data() -> ::Google::Cloud::RecaptchaEnterprise::V1::TransactionData

Returns

(::Google::Cloud::RecaptchaEnterprise::V1::TransactionData) — Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.

#transaction_data=

def transaction_data=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::TransactionData

Parameter

value (::Google::Cloud::RecaptchaEnterprise::V1::TransactionData) — Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.

Returns

(::Google::Cloud::RecaptchaEnterprise::V1::TransactionData) — Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.

#user_agent

def user_agent() -> ::String

Returns

(::String) — Optional. The user agent present in the request from the user's device related to this event.

#user_agent=

def user_agent=(value) -> ::String

Parameter

value (::String) — Optional. The user agent present in the request from the user's device related to this event.

Returns

(::String) — Optional. The user agent present in the request from the user's device related to this event.

#user_info

def user_info() -> ::Google::Cloud::RecaptchaEnterprise::V1::UserInfo

Returns

(::Google::Cloud::RecaptchaEnterprise::V1::UserInfo) — Optional. Information about the user that generates this event, when they can be identified. They are often identified through the use of an account for logged-in requests or login/registration requests, or by providing user identifiers for guest actions like checkout.

#user_info=

def user_info=(value) -> ::Google::Cloud::RecaptchaEnterprise::V1::UserInfo

Parameter

value (::Google::Cloud::RecaptchaEnterprise::V1::UserInfo) — Optional. Information about the user that generates this event, when they can be identified. They are often identified through the use of an account for logged-in requests or login/registration requests, or by providing user identifiers for guest actions like checkout.

Returns

(::Google::Cloud::RecaptchaEnterprise::V1::UserInfo) — Optional. Information about the user that generates this event, when they can be identified. They are often identified through the use of an account for logged-in requests or login/registration requests, or by providing user identifiers for guest actions like checkout.

#user_ip_address

def user_ip_address() -> ::String

Returns

(::String) — Optional. The IP address in the request from the user's device related to this event.

#user_ip_address=

def user_ip_address=(value) -> ::String

Parameter

value (::String) — Optional. The IP address in the request from the user's device related to this event.

Returns

(::String) — Optional. The IP address in the request from the user's device related to this event.

#waf_token_assessment

def waf_token_assessment() -> ::Boolean

Returns

(::Boolean) — Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.

#waf_token_assessment=

def waf_token_assessment=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.

Returns

(::Boolean) — Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.