- 3.50.0 (latest)
- 3.49.0
- 3.48.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.27.0
- 3.26.0
- 3.25.0
- 3.24.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.12
- 2.6.1
- 2.5.0
- 2.4.10
- 2.3.1
public static final class Event.Builder extends GeneratedMessageV3.Builder<Event.Builder> implements EventOrBuilderThe event being assessed.
Protobuf type google.cloud.recaptchaenterprise.v1.Event
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Event.BuilderImplements
EventOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
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 | |
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 | |
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. |
clearField(Descriptors.FieldDescriptor field)
public Event.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Event.Builder | |
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 | |
|---|---|
| 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 | |
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. |
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 | |
|---|---|
| Type | Description |
Event.Builder | This builder for chaining. |
clone()
public Event.Builder clone()| Returns | |
|---|---|
| Type | Description |
Event.Builder | |
getDefaultInstanceForType()
public Event getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Event | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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. |
getHashedAccountId()
public 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 | |
|---|---|
| Type | Description |
ByteString | The hashedAccountId. |
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. |
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 | |
|---|---|
| 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];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for userIpAddress. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Event.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Event.Builder | |
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 | |
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 | StringThe 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 | ByteStringThe bytes for expectedAction 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 | |
setHashedAccountId(ByteString value)
public Event.Builder setHashedAccountId(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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe hashedAccountId 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 | |
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 | StringThe 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 | ByteStringThe 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 | StringThe 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 | ByteStringThe 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 | |
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 | StringThe 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 | ByteStringThe bytes for userAgent to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | StringThe 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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for userIpAddress to set. |
| Returns | |
|---|---|
| Type | Description |
Event.Builder | This builder for chaining. |