public final class Event extends GeneratedMessage implements EventOrBuilder
The event being assessed.
Protobuf type google.cloud.recaptchaenterprise.v1.Event
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
EXPECTED_ACTION_FIELD_NUMBER
public static final int EXPECTED_ACTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXPRESS_FIELD_NUMBER
public static final int EXPRESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FIREWALL_POLICY_EVALUATION_FIELD_NUMBER
public static final int FIREWALL_POLICY_EVALUATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FRAUD_PREVENTION_FIELD_NUMBER
public static final int FRAUD_PREVENTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
HASHED_ACCOUNT_ID_FIELD_NUMBER
public static final int HASHED_ACCOUNT_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int HEADERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
JA3_FIELD_NUMBER
public static final int JA3_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
JA4_FIELD_NUMBER
public static final int JA4_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUESTED_URI_FIELD_NUMBER
public static final int REQUESTED_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SITE_KEY_FIELD_NUMBER
public static final int SITE_KEY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TOKEN_FIELD_NUMBER
public static final int TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TRANSACTION_DATA_FIELD_NUMBER
public static final int TRANSACTION_DATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USER_AGENT_FIELD_NUMBER
public static final int USER_AGENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USER_INFO_FIELD_NUMBER
public static final int USER_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USER_IP_ADDRESS_FIELD_NUMBER
public static final int USER_IP_ADDRESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
WAF_TOKEN_ASSESSMENT_FIELD_NUMBER
public static final int WAF_TOKEN_ASSESSMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Event getDefaultInstance()
| Returns |
| Type |
Description |
Event |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Event.Builder newBuilder()
newBuilder(Event prototype)
public static Event.Builder newBuilder(Event prototype)
| Parameter |
| Name |
Description |
prototype |
Event
|
public static Event parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Event |
|
public static Event parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Event |
|
parseFrom(byte[] data)
public static Event parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Event |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Event parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Event |
|
parseFrom(ByteString data)
public static Event parseFrom(ByteString data)
| Returns |
| Type |
Description |
Event |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Event parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Event |
|
public static Event parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Event |
|
public static Event parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Event |
|
public static Event parseFrom(InputStream input)
| Returns |
| Type |
Description |
Event |
|
public static Event parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Event |
|
parseFrom(ByteBuffer data)
public static Event parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Event |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Event parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Event |
|
parser()
public static Parser<Event> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Event getDefaultInstanceForType()
| Returns |
| Type |
Description |
Event |
|
getExpectedAction()
public 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 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 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 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 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];
getFraudPreventionValue()
public 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 ByteString getHashedAccountId()
Deprecated. google.cloud.recaptchaenterprise.v1.Event.hashed_account_id is deprecated. See
google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto;l=765
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.
|
public 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.
|
public 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.
|
public 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.
|
public ProtocolStringList getHeadersList()
Optional. HTTP header information about the request.
repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];
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 |
| Type |
Description |
String |
The ja3.
|
getJa3Bytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for ja3.
|
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 |
| Type |
Description |
String |
The ja4.
|
getJa4Bytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for ja4.
|
getParserForType()
public Parser<Event> getParserForType()
Overrides
getRequestedUri()
public 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 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSiteKey()
public 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 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()
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 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 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];
getTransactionDataOrBuilder()
public 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];
getUserAgent()
public 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 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 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 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];
getUserIpAddress()
public 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 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 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 |
| Type |
Description |
boolean |
The wafTokenAssessment.
|
hasTransactionData()
public 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Event.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Event.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public Event.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides