Class Event.Builder (2.6.1)

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

Protobuf type google.cloud.recaptchaenterprise.v1.Event

Implements

EventOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Event.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Event.Builder
Overrides

build()

public Event build()
Returns
TypeDescription
Event

buildPartial()

public Event buildPartial()
Returns
TypeDescription
Event

clear()

public Event.Builder clear()
Returns
TypeDescription
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
TypeDescription
Event.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Event.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Event.Builder
Overrides

clearHashedAccountId()

public Event.Builder clearHashedAccountId()

Optional. Optional unique stable hashed user identifier for the request. The identifier should ideally be hashed using sha256 with stable secret.

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

Returns
TypeDescription
Event.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Event.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Event.Builder
Overrides

clearSiteKey()

public Event.Builder clearSiteKey()

Optional. The site key that was used to invoke reCAPTCHA on your site and generate the token.

string site_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Event.Builder

This builder for chaining.

clearToken()

public Event.Builder clearToken()

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

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

Returns
TypeDescription
Event.Builder

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

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

This builder for chaining.

clone()

public Event.Builder clone()
Returns
TypeDescription
Event.Builder
Overrides

getDefaultInstanceForType()

public Event getDefaultInstanceForType()
Returns
TypeDescription
Event

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for expectedAction.

getHashedAccountId()

public ByteString getHashedAccountId()

Optional. Optional unique stable hashed user identifier for the request. The identifier should ideally be hashed using sha256 with stable secret.

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

Returns
TypeDescription
ByteString

The hashedAccountId.

getSiteKey()

public String getSiteKey()

Optional. The site key that was used to invoke reCAPTCHA on your site and generate the token.

string site_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The siteKey.

getSiteKeyBytes()

public ByteString getSiteKeyBytes()

Optional. The site key that was used to invoke reCAPTCHA on your site and generate the token.

string site_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for siteKey.

getToken()

public String getToken()

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

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

Returns
TypeDescription
String

The token.

getTokenBytes()

public ByteString getTokenBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for token.

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
TypeDescription
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
TypeDescription
ByteString

The bytes for userAgent.

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

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

Returns
TypeDescription
ByteString

The bytes for userIpAddress.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Event.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Event.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Event.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Event.Builder
Overrides

mergeFrom(Event other)

public Event.Builder mergeFrom(Event other)
Parameter
NameDescription
otherEvent
Returns
TypeDescription
Event.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Event.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Event.Builder
Overrides

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
NameDescription
valueString

The expectedAction to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for expectedAction to set.

Returns
TypeDescription
Event.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Event.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Event.Builder
Overrides

setHashedAccountId(ByteString value)

public Event.Builder setHashedAccountId(ByteString value)

Optional. Optional unique stable hashed user identifier for the request. The identifier should ideally be hashed using sha256 with stable secret.

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

Parameter
NameDescription
valueByteString

The hashedAccountId to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Event.Builder
Overrides

setSiteKey(String value)

public Event.Builder setSiteKey(String value)

Optional. The site key that was used to invoke reCAPTCHA on your site and generate the token.

string site_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The siteKey to set.

Returns
TypeDescription
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 on your site and generate the token.

string site_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for siteKey to set.

Returns
TypeDescription
Event.Builder

This builder for chaining.

setToken(String value)

public Event.Builder setToken(String value)

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

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

Parameter
NameDescription
valueString

The token to set.

Returns
TypeDescription
Event.Builder

This builder for chaining.

setTokenBytes(ByteString value)

public Event.Builder setTokenBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for token to set.

Returns
TypeDescription
Event.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Event.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueString

The userAgent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for userAgent to set.

Returns
TypeDescription
Event.Builder

This builder for chaining.

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

Parameter
NameDescription
valueString

The userIpAddress to set.

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

Parameter
NameDescription
valueByteString

The bytes for userIpAddress to set.

Returns
TypeDescription
Event.Builder

This builder for chaining.