Interface EventOrBuilder (3.52.0) 

public interface EventOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExpectedAction()

public abstract String getExpectedAction()

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.

string expected_action = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The expectedAction.

getExpectedActionBytes()

public abstract ByteString getExpectedActionBytes()

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.

string expected_action = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for expectedAction.

getExpress()

public abstract boolean getExpress()

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

bool express = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The express.

getFirewallPolicyEvaluation()

public abstract boolean getFirewallPolicyEvaluation()

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.

bool firewall_policy_evaluation = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The firewallPolicyEvaluation.

getFraudPrevention()

public abstract Event.FraudPrevention getFraudPrevention()

Optional. The Fraud Prevention setting for this assessment.

.google.cloud.recaptchaenterprise.v1.Event.FraudPrevention fraud_prevention = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Event.FraudPrevention

The fraudPrevention.

getFraudPreventionValue()

public abstract int getFraudPreventionValue()

Optional. The Fraud Prevention setting for this assessment.

.google.cloud.recaptchaenterprise.v1.Event.FraudPrevention fraud_prevention = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for fraudPrevention.

getHashedAccountId() (deprecated)

public abstract ByteString getHashedAccountId()

Deprecated. google.cloud.recaptchaenterprise.v1.Event.hashed_account_id is deprecated. See google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto;l=747

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.

bytes hashed_account_id = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The hashedAccountId.

getHeaders(int index)

public abstract String getHeaders(int index)

Optional. HTTP header information about the request.

repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The headers at the given index.

getHeadersBytes(int index)

public abstract ByteString getHeadersBytes(int index)

Optional. HTTP header information about the request.

repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the headers at the given index.

getHeadersCount()

public abstract int getHeadersCount()

Optional. HTTP header information about the request.

repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of headers.

getHeadersList()

public abstract List<String> getHeadersList()

Optional. HTTP header information about the request.

repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the headers.

getJa3()

public abstract String getJa3()

Optional. JA3 fingerprint for SSL clients.

string ja3 = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The ja3.

getJa3Bytes()

public abstract ByteString getJa3Bytes()

Optional. JA3 fingerprint for SSL clients.

string ja3 = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for ja3.

getRequestedUri()

public abstract String getRequestedUri()

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

string requested_uri = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The requestedUri.

getRequestedUriBytes()

public abstract ByteString getRequestedUriBytes()

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

string requested_uri = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for requestedUri.

getSiteKey()

public abstract String getSiteKey()

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

string site_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The siteKey.

getSiteKeyBytes()

public abstract ByteString getSiteKeyBytes()

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

string site_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for siteKey.

getToken()

public abstract String getToken()

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

string token = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The token.

getTokenBytes()

public abstract ByteString getTokenBytes()

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

string token = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for token.

getTransactionData()

public abstract TransactionData getTransactionData()

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

.google.cloud.recaptchaenterprise.v1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransactionData

The transactionData.

getTransactionDataOrBuilder()

public abstract TransactionDataOrBuilder getTransactionDataOrBuilder()

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

.google.cloud.recaptchaenterprise.v1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransactionDataOrBuilder

getUserAgent()

public abstract String getUserAgent()

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

string user_agent = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The userAgent.

getUserAgentBytes()

public abstract ByteString getUserAgentBytes()

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

string user_agent = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for userAgent.

getUserInfo()

public abstract UserInfo getUserInfo()

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.

.google.cloud.recaptchaenterprise.v1.UserInfo user_info = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UserInfo

The userInfo.

getUserInfoOrBuilder()

public abstract UserInfoOrBuilder getUserInfoOrBuilder()

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.

.google.cloud.recaptchaenterprise.v1.UserInfo user_info = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UserInfoOrBuilder

getUserIpAddress()

public abstract String getUserIpAddress()

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

string user_ip_address = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
String

The userIpAddress.

getUserIpAddressBytes()

public abstract ByteString getUserIpAddressBytes()

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

string user_ip_address = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for userIpAddress.

getWafTokenAssessment()

public abstract boolean getWafTokenAssessment()

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

bool waf_token_assessment = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The wafTokenAssessment.

hasTransactionData()

public abstract boolean hasTransactionData()

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

.google.cloud.recaptchaenterprise.v1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the transactionData field is set.

hasUserInfo()

public abstract boolean hasUserInfo()

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.

.google.cloud.recaptchaenterprise.v1.UserInfo user_info = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the userInfo field is set.