com.google.recaptchaenterprise.v1beta1

Interface EventOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Event, Event.Builder

public interface EventOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getExpectedAction() Optional.
com.google.protobuf.ByteString	getExpectedActionBytes() Optional.
com.google.protobuf.ByteString	getHashedAccountId() Optional.
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.
String	getUserIpAddress() Optional.
com.google.protobuf.ByteString	getUserIpAddressBytes() Optional.
boolean	hasTransactionData() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

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];

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];

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

com.google.protobuf.ByteString getHashedAccountId()

 Optional. Unique stable hashed user identifier for the request. The
 identifier must be hashed using hmac-sha256 with stable secret.
 

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

Returns:

The hashedAccountId.

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.v1beta1.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.v1beta1.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.v1beta1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL];