Class: Google::Cloud::RecaptchaEnterprise::V1::Event
- Inherits:
-
Object
- Object
- Google::Cloud::RecaptchaEnterprise::V1::Event
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb
Overview
The event being assessed.
Instance Attribute Summary collapse
-
#expected_action ⇒ ::String
Optional.
-
#express ⇒ ::Boolean
Optional.
-
#firewall_policy_evaluation ⇒ ::Boolean
Optional.
-
#hashed_account_id ⇒ ::String
deprecated
Deprecated.
This field is deprecated and may be removed in the next major version update.
-
#headers ⇒ ::Array<::String>
Optional.
-
#ja3 ⇒ ::String
Optional.
-
#requested_uri ⇒ ::String
Optional.
-
#site_key ⇒ ::String
Optional.
-
#token ⇒ ::String
Optional.
-
#transaction_data ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::TransactionData
Optional.
-
#user_agent ⇒ ::String
Optional.
-
#user_info ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::UserInfo
Optional.
-
#user_ip_address ⇒ ::String
Optional.
-
#waf_token_assessment ⇒ ::Boolean
Optional.
Instance Attribute Details
#expected_action ⇒ ::String
Returns 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.
502 503 504 505 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 502 class Event include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#express ⇒ ::Boolean
Returns Optional. Flag for a reCAPTCHA express request for an assessment without a
token. If enabled, site_key
must reference a SCORE key with WAF feature
set to EXPRESS.
502 503 504 505 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 502 class Event include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#firewall_policy_evaluation ⇒ ::Boolean
Returns Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response.
502 503 504 505 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 502 class Event include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#hashed_account_id ⇒ ::String
This field is deprecated and may be removed in the next major version update.
Returns 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.
502 503 504 505 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 502 class Event include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#headers ⇒ ::Array<::String>
Returns Optional. HTTP header information about the request.
502 503 504 505 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 502 class Event include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#ja3 ⇒ ::String
Returns Optional. JA3 fingerprint for SSL clients.
502 503 504 505 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 502 class Event include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#requested_uri ⇒ ::String
Returns Optional. The URI resource the user requested that triggered an assessment.
502 503 504 505 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 502 class Event include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#site_key ⇒ ::String
Returns Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.
502 503 504 505 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 502 class Event include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#token ⇒ ::String
Returns Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.
502 503 504 505 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 502 class Event include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#transaction_data ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::TransactionData
Returns Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.
502 503 504 505 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 502 class Event include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#user_agent ⇒ ::String
Returns Optional. The user agent present in the request from the user's device related to this event.
502 503 504 505 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 502 class Event include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#user_info ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::UserInfo
Returns 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.
502 503 504 505 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 502 class Event include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#user_ip_address ⇒ ::String
Returns Optional. The IP address in the request from the user's device related to this event.
502 503 504 505 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 502 class Event include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#waf_token_assessment ⇒ ::Boolean
Returns Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.
502 503 504 505 |
# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 502 class Event include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |