public final class Event extends com.google.protobuf.GeneratedMessageV3 implements EventOrBuilder
The event being assessed.Protobuf type
google.cloud.recaptchaenterprise.v1.Event| Modifier and Type | Class and Description |
|---|---|
static class |
Event.Builder
The event being assessed.
|
static class |
Event.FraudPrevention
Setting that controls Fraud Prevention assessments.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
EXPECTED_ACTION_FIELD_NUMBER |
static int |
EXPRESS_FIELD_NUMBER |
static int |
FIREWALL_POLICY_EVALUATION_FIELD_NUMBER |
static int |
FRAUD_PREVENTION_FIELD_NUMBER |
static int |
HASHED_ACCOUNT_ID_FIELD_NUMBER |
static int |
HEADERS_FIELD_NUMBER |
static int |
JA3_FIELD_NUMBER |
static int |
JA4_FIELD_NUMBER |
static int |
REQUESTED_URI_FIELD_NUMBER |
static int |
SITE_KEY_FIELD_NUMBER |
static int |
TOKEN_FIELD_NUMBER |
static int |
TRANSACTION_DATA_FIELD_NUMBER |
static int |
USER_AGENT_FIELD_NUMBER |
static int |
USER_INFO_FIELD_NUMBER |
static int |
USER_IP_ADDRESS_FIELD_NUMBER |
static int |
WAF_TOKEN_ASSESSMENT_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static Event |
getDefaultInstance() |
Event |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getExpectedAction()
Optional.
|
com.google.protobuf.ByteString |
getExpectedActionBytes()
Optional.
|
boolean |
getExpress()
Optional.
|
boolean |
getFirewallPolicyEvaluation()
Optional.
|
Event.FraudPrevention |
getFraudPrevention()
Optional.
|
int |
getFraudPreventionValue()
Optional.
|
com.google.protobuf.ByteString |
getHashedAccountId()
Deprecated.
google.cloud.recaptchaenterprise.v1.Event.hashed_account_id is deprecated. See
google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto;l=745
|
String |
getHeaders(int index)
Optional.
|
com.google.protobuf.ByteString |
getHeadersBytes(int index)
Optional.
|
int |
getHeadersCount()
Optional.
|
com.google.protobuf.ProtocolStringList |
getHeadersList()
Optional.
|
String |
getJa3()
Optional.
|
com.google.protobuf.ByteString |
getJa3Bytes()
Optional.
|
String |
getJa4()
Optional.
|
com.google.protobuf.ByteString |
getJa4Bytes()
Optional.
|
com.google.protobuf.Parser<Event> |
getParserForType() |
String |
getRequestedUri()
Optional.
|
com.google.protobuf.ByteString |
getRequestedUriBytes()
Optional.
|
int |
getSerializedSize() |
String |
getSiteKey()
Optional.
|
com.google.protobuf.ByteString |
getSiteKeyBytes()
Optional.
|
String |
getToken()
Optional.
|
com.google.protobuf.ByteString |
getTokenBytes()
Optional.
|
TransactionData |
getTransactionData()
Optional.
|
TransactionDataOrBuilder |
getTransactionDataOrBuilder()
Optional.
|
String |
getUserAgent()
Optional.
|
com.google.protobuf.ByteString |
getUserAgentBytes()
Optional.
|
UserInfo |
getUserInfo()
Optional.
|
UserInfoOrBuilder |
getUserInfoOrBuilder()
Optional.
|
String |
getUserIpAddress()
Optional.
|
com.google.protobuf.ByteString |
getUserIpAddressBytes()
Optional.
|
boolean |
getWafTokenAssessment()
Optional.
|
int |
hashCode() |
boolean |
hasTransactionData()
Optional.
|
boolean |
hasUserInfo()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Event.Builder |
newBuilder() |
static Event.Builder |
newBuilder(Event prototype) |
Event.Builder |
newBuilderForType() |
protected Event.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Event |
parseDelimitedFrom(InputStream input) |
static Event |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Event |
parseFrom(byte[] data) |
static Event |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Event |
parseFrom(ByteBuffer data) |
static Event |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Event |
parseFrom(com.google.protobuf.ByteString data) |
static Event |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Event |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Event |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Event |
parseFrom(InputStream input) |
static Event |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Event> |
parser() |
Event.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int TOKEN_FIELD_NUMBER
public static final int SITE_KEY_FIELD_NUMBER
public static final int USER_AGENT_FIELD_NUMBER
public static final int USER_IP_ADDRESS_FIELD_NUMBER
public static final int EXPECTED_ACTION_FIELD_NUMBER
public static final int HASHED_ACCOUNT_ID_FIELD_NUMBER
public static final int EXPRESS_FIELD_NUMBER
public static final int REQUESTED_URI_FIELD_NUMBER
public static final int WAF_TOKEN_ASSESSMENT_FIELD_NUMBER
public static final int JA3_FIELD_NUMBER
public static final int JA4_FIELD_NUMBER
public static final int HEADERS_FIELD_NUMBER
public static final int FIREWALL_POLICY_EVALUATION_FIELD_NUMBER
public static final int TRANSACTION_DATA_FIELD_NUMBER
public static final int USER_INFO_FIELD_NUMBER
public static final int FRAUD_PREVENTION_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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];getToken in interface EventOrBuilderpublic 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];getTokenBytes in interface EventOrBuilderpublic 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];getSiteKey in interface EventOrBuilderpublic 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];getSiteKeyBytes in interface EventOrBuilderpublic 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];getUserAgent in interface EventOrBuilderpublic 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];getUserAgentBytes in interface EventOrBuilderpublic 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) = { ... }
getUserIpAddress in interface EventOrBuilderpublic 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) = { ... }
getUserIpAddressBytes in interface EventOrBuilderpublic 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];getExpectedAction in interface EventOrBuilderpublic 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];getExpectedActionBytes in interface EventOrBuilder@Deprecated public com.google.protobuf.ByteString getHashedAccountId()
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];
getHashedAccountId in interface EventOrBuilderpublic 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];getExpress in interface EventOrBuilderpublic String getRequestedUri()
Optional. The URI resource the user requested that triggered an assessment.
string requested_uri = 8 [(.google.api.field_behavior) = OPTIONAL];getRequestedUri in interface EventOrBuilderpublic 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];getRequestedUriBytes in interface EventOrBuilderpublic 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];getWafTokenAssessment in interface EventOrBuilderpublic 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];getJa3 in interface EventOrBuilderpublic 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];getJa3Bytes in interface EventOrBuilderpublic 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];getJa4 in interface EventOrBuilderpublic 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];getJa4Bytes in interface EventOrBuilderpublic com.google.protobuf.ProtocolStringList getHeadersList()
Optional. HTTP header information about the request.
repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];getHeadersList in interface EventOrBuilderpublic int getHeadersCount()
Optional. HTTP header information about the request.
repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];getHeadersCount in interface EventOrBuilderpublic String getHeaders(int index)
Optional. HTTP header information about the request.
repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];getHeaders in interface EventOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getHeadersBytes(int index)
Optional. HTTP header information about the request.
repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];getHeadersBytes in interface EventOrBuilderindex - The index of the value to return.public 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];getFirewallPolicyEvaluation in interface EventOrBuilderpublic 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];
hasTransactionData in interface EventOrBuilderpublic 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];
getTransactionData in interface EventOrBuilderpublic 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];
getTransactionDataOrBuilder in interface EventOrBuilderpublic 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];
hasUserInfo in interface EventOrBuilderpublic 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];
getUserInfo in interface EventOrBuilderpublic 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];
getUserInfoOrBuilder in interface EventOrBuilderpublic int getFraudPreventionValue()
Optional. The Fraud Prevention setting for this assessment.
.google.cloud.recaptchaenterprise.v1.Event.FraudPrevention fraud_prevention = 17 [(.google.api.field_behavior) = OPTIONAL];
getFraudPreventionValue in interface EventOrBuilderpublic 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];
getFraudPrevention in interface EventOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Event parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Event parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Event parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Event parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Event parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Event parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Event parseFrom(InputStream input) throws IOException
IOExceptionpublic static Event parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Event parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Event parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Event parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Event parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Event.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Event.Builder newBuilder()
public static Event.Builder newBuilder(Event prototype)
public Event.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Event.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Event getDefaultInstance()
public static com.google.protobuf.Parser<Event> parser()
public com.google.protobuf.Parser<Event> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Event getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.