public sealed class Event : IMessage<Event>, IEquatable<Event>, IDeepCloneable<Event>, IBufferMessage, IMessage
Reference documentation and code samples for the Google Cloud reCAPTCHA Enterprise v1 API class Event.
The event being assessed.
Namespace
Google.Cloud.RecaptchaEnterprise.V1Assembly
Google.Cloud.RecaptchaEnterprise.V1.dll
Constructors
Event()
public Event()
Event(Event)
public Event(Event other)
Parameter | |
---|---|
Name | Description |
other | Event |
Properties
ExpectedAction
public string ExpectedAction { get; set; }
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.
Property Value | |
---|---|
Type | Description |
string |
Express
public bool Express { get; set; }
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.
Property Value | |
---|---|
Type | Description |
bool |
FirewallPolicyEvaluation
public bool FirewallPolicyEvaluation { get; set; }
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.
Property Value | |
---|---|
Type | Description |
bool |
HashedAccountId
public ByteString HashedAccountId { get; set; }
Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.
Property Value | |
---|---|
Type | Description |
ByteString |
Headers
public RepeatedField<string> Headers { get; }
Optional. HTTP header information about the request.
Property Value | |
---|---|
Type | Description |
RepeatedFieldstring |
Ja3
public string Ja3 { get; set; }
Optional. JA3 fingerprint for SSL clients.
Property Value | |
---|---|
Type | Description |
string |
RequestedUri
public string RequestedUri { get; set; }
Optional. The URI resource the user requested that triggered an assessment.
Property Value | |
---|---|
Type | Description |
string |
SiteKey
public string SiteKey { get; set; }
Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.
Property Value | |
---|---|
Type | Description |
string |
Token
public string Token { get; set; }
Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.
Property Value | |
---|---|
Type | Description |
string |
TransactionData
public TransactionData TransactionData { get; set; }
Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.
Property Value | |
---|---|
Type | Description |
TransactionData |
UserAgent
public string UserAgent { get; set; }
Optional. The user agent present in the request from the user's device related to this event.
Property Value | |
---|---|
Type | Description |
string |
UserIpAddress
public string UserIpAddress { get; set; }
Optional. The IP address in the request from the user's device related to this event.
Property Value | |
---|---|
Type | Description |
string |
WafTokenAssessment
public bool WafTokenAssessment { get; set; }
Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.
Property Value | |
---|---|
Type | Description |
bool |