Package com.google.recaptchaenterprise.v1

Class Event.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

com.google.recaptchaenterprise.v1.Event.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, EventOrBuilder, Cloneable

Enclosing class:

Event

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

 The event being assessed.
 

Protobuf type google.cloud.recaptchaenterprise.v1.Event

Method Summary

Modifier and Type	Method	Description
Event.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Event	build()
Event	buildPartial()
Event.Builder	clear()
Event.Builder	clearExpectedAction()	Optional.
Event.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Event.Builder	clearHashedAccountId()	Optional.
Event.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Event.Builder	clearSiteKey()	Optional.
Event.Builder	clearToken()	Optional.
Event.Builder	clearTransactionData()	Optional.
Event.Builder	clearUserAgent()	Optional.
Event.Builder	clearUserIpAddress()	Optional.
Event.Builder	clone()
Event	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
TransactionData.Builder	getTransactionDataBuilder()	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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Event.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Event.Builder	mergeFrom(com.google.protobuf.Message other)
Event.Builder	mergeFrom(Event other)
Event.Builder	mergeTransactionData(TransactionData value)	Optional.
Event.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Event.Builder	setExpectedAction(String value)	Optional.
Event.Builder	setExpectedActionBytes(com.google.protobuf.ByteString value)	Optional.
Event.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Event.Builder	setHashedAccountId(com.google.protobuf.ByteString value)	Optional.
Event.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Event.Builder	setSiteKey(String value)	Optional.
Event.Builder	setSiteKeyBytes(com.google.protobuf.ByteString value)	Optional.
Event.Builder	setToken(String value)	Optional.
Event.Builder	setTokenBytes(com.google.protobuf.ByteString value)	Optional.
Event.Builder	setTransactionData(TransactionData value)	Optional.
Event.Builder	setTransactionData(TransactionData.Builder builderForValue)	Optional.
Event.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Event.Builder	setUserAgent(String value)	Optional.
Event.Builder	setUserAgentBytes(com.google.protobuf.ByteString value)	Optional.
Event.Builder	setUserIpAddress(String value)	Optional.
Event.Builder	setUserIpAddressBytes(com.google.protobuf.ByteString value)	Optional.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

clear

public Event.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

getDefaultInstanceForType

public Event getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Event build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Event buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Event.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

setField

public Event.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                              Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

clearField

public Event.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

clearOneof

public Event.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

setRepeatedField

public Event.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      int index,
                                      Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

addRepeatedField

public Event.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

mergeFrom

public Event.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Event.Builder>

mergeFrom

public Event.Builder mergeFrom(Event other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

mergeFrom

public Event.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Event.Builder>

Throws:

IOException

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

Specified by:

getToken in interface EventOrBuilder

Returns:

The token.

getTokenBytes

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

Specified by:

getTokenBytes in interface EventOrBuilder

Returns:

The bytes for token.

setToken

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

Parameters:

value - The token to set.

Returns:

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:

This builder for chaining.

setTokenBytes

public Event.Builder setTokenBytes(com.google.protobuf.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];

Parameters:

value - The bytes for token to set.

Returns:

This builder for chaining.

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

Specified by:

getSiteKey in interface EventOrBuilder

Returns:

The siteKey.

getSiteKeyBytes

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

Specified by:

getSiteKeyBytes in interface EventOrBuilder

Returns:

The bytes for siteKey.

setSiteKey

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

Parameters:

value - The siteKey to set.

Returns:

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:

This builder for chaining.

setSiteKeyBytes

public Event.Builder setSiteKeyBytes(com.google.protobuf.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];

Parameters:

value - The bytes for siteKey to set.

Returns:

This builder for chaining.

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

Specified by:

getUserAgent in interface EventOrBuilder

Returns:

The userAgent.

getUserAgentBytes

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

Specified by:

getUserAgentBytes in interface EventOrBuilder

Returns:

The bytes for userAgent.

setUserAgent

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

Parameters:

value - The userAgent to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setUserAgentBytes

public Event.Builder setUserAgentBytes(com.google.protobuf.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];

Parameters:

value - The bytes for userAgent to set.

Returns:

This builder for chaining.

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

Specified by:

getUserIpAddress in interface EventOrBuilder

Returns:

The userIpAddress.

getUserIpAddressBytes

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

Specified by:

getUserIpAddressBytes in interface EventOrBuilder

Returns:

The bytes for userIpAddress.

setUserIpAddress

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

Parameters:

value - The userIpAddress to set.

Returns:

This builder for chaining.

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

Returns:

This builder for chaining.

setUserIpAddressBytes

public Event.Builder setUserIpAddressBytes(com.google.protobuf.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];

Parameters:

value - The bytes for userIpAddress to set.

Returns:

This builder for chaining.

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

Specified by:

getExpectedAction in interface EventOrBuilder

Returns:

The expectedAction.

getExpectedActionBytes

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

Specified by:

getExpectedActionBytes in interface EventOrBuilder

Returns:

The bytes for expectedAction.

setExpectedAction

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

Parameters:

value - The expectedAction to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setExpectedActionBytes

public Event.Builder setExpectedActionBytes(com.google.protobuf.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];

Parameters:

value - The bytes for expectedAction to set.

Returns:

This builder for chaining.

getHashedAccountId

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

Specified by:

getHashedAccountId in interface EventOrBuilder

Returns:

The hashedAccountId.

setHashedAccountId

public Event.Builder setHashedAccountId(com.google.protobuf.ByteString value)

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

Parameters:

value - The hashedAccountId to set.

Returns:

This builder for chaining.

clearHashedAccountId

public Event.Builder clearHashedAccountId()

 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:

This builder for chaining.

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

Specified by:

hasTransactionData in interface EventOrBuilder

Returns:

Whether the transactionData field is set.

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

Specified by:

getTransactionData in interface EventOrBuilder

Returns:

The transactionData.

setTransactionData

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

setTransactionData

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

mergeTransactionData

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

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

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

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

Specified by:

getTransactionDataOrBuilder in interface EventOrBuilder

setUnknownFields

public final Event.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

mergeUnknownFields

public final Event.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>