Class Event.Builder (3.39.0) 

public static final class Event.Builder extends GeneratedMessageV3.Builder<Event.Builder> implements EventOrBuilder

The event being assessed.

Protobuf type google.cloud.recaptchaenterprise.v1.Event

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Event.Builder

Implements

EventOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllHeaders(Iterable<String> values)

public Event.Builder addAllHeaders(Iterable<String> values)

Optional. HTTP header information about the request.

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

Parameter
Name Description
values Iterable<String>

The headers to add.
Returns
Type Description
Event.Builder

This builder for chaining.

addHeaders(String value)

public Event.Builder addHeaders(String value)

Optional. HTTP header information about the request.

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

Parameter
Name Description
value String

The headers to add.
Returns
Type Description
Event.Builder

This builder for chaining.

addHeadersBytes(ByteString value)

public Event.Builder addHeadersBytes(ByteString value)

Optional. HTTP header information about the request.

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

Parameter
Name Description
value ByteString

The bytes of the headers to add.
Returns
Type Description
Event.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Event.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Event.Builder
Overrides

build()

public Event build()
Returns
Type Description
Event

buildPartial()

public Event buildPartial()
Returns
Type Description
Event

clear()

public Event.Builder clear()
Returns
Type Description
Event.Builder
Overrides

clearExpectedAction()

public Event.Builder clearExpectedAction()

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
Event.Builder

This builder for chaining.

clearExpress()

public Event.Builder clearExpress()

Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, site_key must reference a SCORE key with WAF feature set to EXPRESS.

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

Returns
Type Description
Event.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Event.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Event.Builder
Overrides

clearFirewallPolicyEvaluation()

public Event.Builder clearFirewallPolicyEvaluation()

Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response.

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

Returns
Type Description
Event.Builder

This builder for chaining.

clearFraudPrevention()

public Event.Builder clearFraudPrevention()

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.Builder

This builder for chaining.

clearHashedAccountId() (deprecated)

public Event.Builder clearHashedAccountId()

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

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
Event.Builder

This builder for chaining.

clearHeaders()

public Event.Builder clearHeaders()

Optional. HTTP header information about the request.

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

Returns
Type Description
Event.Builder

This builder for chaining.

clearJa3()

public Event.Builder clearJa3()

Optional. JA3 fingerprint for SSL clients.

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

Returns
Type Description
Event.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Event.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Event.Builder
Overrides

clearRequestedUri()

public Event.Builder clearRequestedUri()

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

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

Returns
Type Description
Event.Builder

This builder for chaining.

clearSiteKey()

public Event.Builder clearSiteKey()

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
Event.Builder

This builder for chaining.

clearToken()

public Event.Builder clearToken()

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
Event.Builder

This builder for chaining.

clearTransactionData()

public Event.Builder clearTransactionData()

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
Event.Builder

clearUserAgent()

public Event.Builder clearUserAgent()

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
Event.Builder

This builder for chaining.

clearUserInfo()

public Event.Builder clearUserInfo()

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
Event.Builder

clearUserIpAddress()

public Event.Builder clearUserIpAddress()

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
Event.Builder

This builder for chaining.

clearWafTokenAssessment()

public Event.Builder clearWafTokenAssessment()

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
Event.Builder

This builder for chaining.

clone()

public Event.Builder clone()
Returns
Type Description
Event.Builder
Overrides

getDefaultInstanceForType()

public Event getDefaultInstanceForType()
Returns
Type Description
Event

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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 a SCORE key with WAF feature set to EXPRESS.

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 will be evaluated and a suggested firewall action will be 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];

Returns
Type Description
Event.FraudPrevention

The fraudPrevention.

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=700

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 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 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 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 ProtocolStringList getHeadersList()

Optional. HTTP header information about the request.

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

Returns
Type Description
ProtocolStringList

A list containing the headers.

getJa3()

public String getJa3()

Optional. JA3 fingerprint for SSL clients.

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

Returns
Type Description
String

The ja3.

getJa3Bytes()

public 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 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.

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()

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

Returns
Type Description
TransactionData

The transactionData.

getTransactionDataBuilder()

public TransactionData.Builder getTransactionDataBuilder()

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.Builder

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

Returns
Type Description
TransactionDataOrBuilder

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.

getUserInfoBuilder()

public UserInfo.Builder getUserInfoBuilder()

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.Builder

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

Returns
Type Description
UserInfoOrBuilder

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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Event.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Event.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Event.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Event.Builder
Overrides

mergeFrom(Event other)

public Event.Builder mergeFrom(Event other)
Parameter
Name Description
other Event
Returns
Type Description
Event.Builder

mergeTransactionData(TransactionData value)

public Event.Builder mergeTransactionData(TransactionData value)

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

Parameter
Name Description
value TransactionData
Returns
Type Description
Event.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Event.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Event.Builder
Overrides

mergeUserInfo(UserInfo value)

public Event.Builder mergeUserInfo(UserInfo value)

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

Parameter
Name Description
value UserInfo
Returns
Type Description
Event.Builder

setExpectedAction(String value)

public Event.Builder setExpectedAction(String value)

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

Parameter
Name Description
value String

The expectedAction to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setExpectedActionBytes(ByteString value)

public Event.Builder setExpectedActionBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for expectedAction to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setExpress(boolean value)

public Event.Builder setExpress(boolean value)

Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, site_key must reference a SCORE key with WAF feature set to EXPRESS.

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

Parameter
Name Description
value boolean

The express to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Event.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Event.Builder
Overrides

setFirewallPolicyEvaluation(boolean value)

public Event.Builder setFirewallPolicyEvaluation(boolean value)

Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response.

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

Parameter
Name Description
value boolean

The firewallPolicyEvaluation to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setFraudPrevention(Event.FraudPrevention value)

public Event.Builder setFraudPrevention(Event.FraudPrevention value)

Optional. The Fraud Prevention setting for this assessment.

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

Parameter
Name Description
value Event.FraudPrevention

The fraudPrevention to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setFraudPreventionValue(int value)

public Event.Builder setFraudPreventionValue(int value)

Optional. The Fraud Prevention setting for this assessment.

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

Parameter
Name Description
value int

The enum numeric value on the wire for fraudPrevention to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setHashedAccountId(ByteString value) (deprecated)

public Event.Builder setHashedAccountId(ByteString value)

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

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

Parameter
Name Description
value ByteString

The hashedAccountId to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setHeaders(int index, String value)

public Event.Builder setHeaders(int index, String value)

Optional. HTTP header information about the request.

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

Parameters
Name Description
index int

The index to set the value at.
value String

The headers to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setJa3(String value)

public Event.Builder setJa3(String value)

Optional. JA3 fingerprint for SSL clients.

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

Parameter
Name Description
value String

The ja3 to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setJa3Bytes(ByteString value)

public Event.Builder setJa3Bytes(ByteString value)

Optional. JA3 fingerprint for SSL clients.

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

Parameter
Name Description
value ByteString

The bytes for ja3 to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Event.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Event.Builder
Overrides

setRequestedUri(String value)

public Event.Builder setRequestedUri(String value)

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

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

Parameter
Name Description
value String

The requestedUri to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setRequestedUriBytes(ByteString value)

public Event.Builder setRequestedUriBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for requestedUri to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setSiteKey(String value)

public Event.Builder setSiteKey(String value)

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

Parameter
Name Description
value String

The siteKey to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setSiteKeyBytes(ByteString value)

public Event.Builder setSiteKeyBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for siteKey to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setToken(String value)

public Event.Builder setToken(String value)

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

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

Parameter
Name Description
value String

The token to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setTokenBytes(ByteString value)

public Event.Builder setTokenBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for token to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setTransactionData(TransactionData value)

public Event.Builder setTransactionData(TransactionData value)

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

Parameter
Name Description
value TransactionData
Returns
Type Description
Event.Builder

setTransactionData(TransactionData.Builder builderForValue)

public Event.Builder setTransactionData(TransactionData.Builder builderForValue)

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

Parameter
Name Description
builderForValue TransactionData.Builder
Returns
Type Description
Event.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Event.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Event.Builder
Overrides

setUserAgent(String value)

public Event.Builder setUserAgent(String value)

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

Parameter
Name Description
value String

The userAgent to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setUserAgentBytes(ByteString value)

public Event.Builder setUserAgentBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for userAgent to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setUserInfo(UserInfo value)

public Event.Builder setUserInfo(UserInfo value)

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

Parameter
Name Description
value UserInfo
Returns
Type Description
Event.Builder

setUserInfo(UserInfo.Builder builderForValue)

public Event.Builder setUserInfo(UserInfo.Builder builderForValue)

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

Parameter
Name Description
builderForValue UserInfo.Builder
Returns
Type Description
Event.Builder

setUserIpAddress(String value)

public Event.Builder setUserIpAddress(String value)

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) = { ... }

Parameter
Name Description
value String

The userIpAddress to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setUserIpAddressBytes(ByteString value)

public Event.Builder setUserIpAddressBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for userIpAddress to set.
Returns
Type Description
Event.Builder

This builder for chaining.

setWafTokenAssessment(boolean value)

public Event.Builder setWafTokenAssessment(boolean value)

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

Parameter
Name Description
value boolean

The wafTokenAssessment to set.
Returns
Type Description
Event.Builder

This builder for chaining.