Interface EventOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Event,Event.Builder
@Generated
public interface EventOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionOptional.com.google.protobuf.ByteStringOptional.booleanOptional.booleanOptional.Optional.intOptional.com.google.protobuf.ByteStringDeprecated.google.cloud.recaptchaenterprise.v1.Event.hashed_account_id is deprecated.getHeaders(int index) Optional.com.google.protobuf.ByteStringgetHeadersBytes(int index) Optional.intOptional.Optional.getJa3()Optional.com.google.protobuf.ByteStringOptional.getJa4()Optional.com.google.protobuf.ByteStringOptional.Optional.com.google.protobuf.ByteStringOptional.Optional.com.google.protobuf.ByteStringOptional.getToken()Optional.com.google.protobuf.ByteStringOptional.Optional.Optional.Optional.com.google.protobuf.ByteStringOptional.Optional.Optional.Optional.com.google.protobuf.ByteStringOptional.booleanOptional.booleanOptional.booleanOptional.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getToken
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:
- The token.
-
getTokenBytes
com.google.protobuf.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:
- The bytes for token.
-
getSiteKey
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:
- The siteKey.
-
getSiteKeyBytes
com.google.protobuf.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:
- The bytes for siteKey.
-
getUserAgent
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:
- The userAgent.
-
getUserAgentBytes
com.google.protobuf.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:
- The bytes for userAgent.
-
getUserIpAddress
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:
- The userIpAddress.
-
getUserIpAddressBytes
com.google.protobuf.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:
- The bytes for userIpAddress.
-
getExpectedAction
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:
- The expectedAction.
-
getExpectedActionBytes
com.google.protobuf.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:
- The bytes for expectedAction.
-
getHashedAccountId
Deprecated.google.cloud.recaptchaenterprise.v1.Event.hashed_account_id is deprecated. See google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto;l=765Optional. 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:
- The hashedAccountId.
-
getExpress
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:
- The express.
-
getRequestedUri
String getRequestedUri()Optional. The URI resource the user requested that triggered an assessment.
string requested_uri = 8 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The requestedUri.
-
getRequestedUriBytes
com.google.protobuf.ByteString getRequestedUriBytes()Optional. The URI resource the user requested that triggered an assessment.
string requested_uri = 8 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for requestedUri.
-
getWafTokenAssessment
boolean getWafTokenAssessment()Optional. Flag for running Web Application Firewall (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:
- The wafTokenAssessment.
-
getJa3
String getJa3()Optional. JA3 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/salesforce/ja3.
string ja3 = 10 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The ja3.
-
getJa3Bytes
com.google.protobuf.ByteString getJa3Bytes()Optional. JA3 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/salesforce/ja3.
string ja3 = 10 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for ja3.
-
getJa4
String getJa4()Optional. JA4 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/FoxIO-LLC/ja4.
string ja4 = 18 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The ja4.
-
getJa4Bytes
com.google.protobuf.ByteString getJa4Bytes()Optional. JA4 fingerprint for SSL clients. To learn how to compute this fingerprint, please refer to https://github.com/FoxIO-LLC/ja4.
string ja4 = 18 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for ja4.
-
getHeadersList
Optional. HTTP header information about the request.
repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- A list containing the headers.
-
getHeadersCount
int getHeadersCount()Optional. HTTP header information about the request.
repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The count of headers.
-
getHeaders
Optional. HTTP header information about the request.
repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
index- The index of the element to return.- Returns:
- The headers at the given index.
-
getHeadersBytes
com.google.protobuf.ByteString getHeadersBytes(int index) Optional. HTTP header information about the request.
repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the headers at the given index.
-
getFirewallPolicyEvaluation
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:
- The firewallPolicyEvaluation.
-
hasTransactionData
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:
- Whether the transactionData field is set.
-
getTransactionData
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:
- The transactionData.
-
getTransactionDataOrBuilder
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]; -
hasUserInfo
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:
- Whether the userInfo field is set.
-
getUserInfo
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:
- The userInfo.
-
getUserInfoOrBuilder
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]; -
getFraudPreventionValue
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:
- The enum numeric value on the wire for fraudPrevention.
-
getFraudPrevention
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:
- The fraudPrevention.
-