Struct google_api_proto::google::cloud::recaptchaenterprise::v1::Event

pub struct Event {

    pub token: String,
    pub site_key: String,
    pub user_agent: String,
    pub user_ip_address: String,
    pub expected_action: String,
    pub hashed_account_id: Bytes,
    pub express: bool,
    pub requested_uri: String,
    pub waf_token_assessment: bool,
    pub ja3: String,
    pub headers: Vec<String>,
    pub firewall_policy_evaluation: bool,
    pub transaction_data: Option<TransactionData>,
    pub user_info: Option<UserInfo>,
    pub fraud_prevention: i32,
}

The event being assessed.

Fields

token: String

Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.

site_key: String

Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.

user_agent: String

Optional. The user agent present in the request from the user’s device related to this event.

user_ip_address: String

Optional. The IP address in the request from the user’s device related to this event.

expected_action: 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.

hashed_account_id: Bytes

👎Deprecated

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.

express: bool

Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, site_key must reference an express key.

requested_uri: String

Optional. The URI resource the user requested that triggered an assessment.

waf_token_assessment: bool

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

ja3: String

Optional. JA3 fingerprint for SSL clients.

headers: Vec<String>

Optional. HTTP header information about the request.

firewall_policy_evaluation: bool

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.

transaction_data: Option<TransactionData>

Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Fraud Prevention and the FraudPreventionAssessment component in the response.

user_info: Option<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.

fraud_prevention: i32

Optional. The Fraud Prevention setting for this assessment.

Implementations

impl Event

pub fn fraud_prevention(&self) -> FraudPrevention

Returns the enum value of fraud_prevention, or the default if the field is set to an invalid enum value.

pub fn set_fraud_prevention(&mut self, value: FraudPrevention)

Sets fraud_prevention to the provided enum value.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Event

fn default() -> Self

Returns the “default value” for a type.

impl Message for Event

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Event

fn eq(&self, other: &Event) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Event