Class CollectUserEventRequest.Builder (2.41.0)

Version 2.41.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public static final class CollectUserEventRequest.Builder extends GeneratedMessageV3.Builder<CollectUserEventRequest.Builder> implements CollectUserEventRequestOrBuilder

Request message for CollectUserEvent method.

Protobuf type google.cloud.retail.v2.CollectUserEventRequest

Inheritance

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

Implements

CollectUserEventRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CollectUserEventRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CollectUserEventRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public CollectUserEventRequest build()

Returns
Type	Description
CollectUserEventRequest

buildPartial()

public CollectUserEventRequest buildPartial()

Returns
Type	Description
CollectUserEventRequest

clear()

public CollectUserEventRequest.Builder clear()

Returns
Type	Description
CollectUserEventRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearConversionRule()

public CollectUserEventRequest.Builder clearConversionRule()

Returns
Type	Description
CollectUserEventRequest.Builder

clearEts()

public CollectUserEventRequest.Builder clearEts()

The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

int64 ets = 4;

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CollectUserEventRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
CollectUserEventRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public CollectUserEventRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
CollectUserEventRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParent()

public CollectUserEventRequest.Builder clearParent()

Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

clearPrebuiltRule()

public CollectUserEventRequest.Builder clearPrebuiltRule()

The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.

string prebuilt_rule = 6;

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

clearRawJson()

public CollectUserEventRequest.Builder clearRawJson()

An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only.

string raw_json = 5;

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

clearUri()

public CollectUserEventRequest.Builder clearUri()

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.

string uri = 3;

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

clearUserEvent()

public CollectUserEventRequest.Builder clearUserEvent()

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

clone()

public CollectUserEventRequest.Builder clone()

Returns
Type	Description
CollectUserEventRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getConversionRuleCase()

public CollectUserEventRequest.ConversionRuleCase getConversionRuleCase()

Returns
Type	Description
CollectUserEventRequest.ConversionRuleCase

getDefaultInstanceForType()

public CollectUserEventRequest getDefaultInstanceForType()

Returns
Type	Description
CollectUserEventRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEts()

public long getEts()

The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

int64 ets = 4;

Returns
Type	Description
long	The ets.

getParent()

public String getParent()

Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for parent.

getPrebuiltRule()

public String getPrebuiltRule()

The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.

string prebuilt_rule = 6;

Returns
Type	Description
String	The prebuiltRule.

getPrebuiltRuleBytes()

public ByteString getPrebuiltRuleBytes()

The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.

string prebuilt_rule = 6;

Returns
Type	Description
ByteString	The bytes for prebuiltRule.

getRawJson()

public String getRawJson()

An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only.

string raw_json = 5;

Returns
Type	Description
String	The rawJson.

getRawJsonBytes()

public ByteString getRawJsonBytes()

An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only.

string raw_json = 5;

Returns
Type	Description
ByteString	The bytes for rawJson.

getUri()

public String getUri()

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.

string uri = 3;

Returns
Type	Description
String	The uri.

getUriBytes()

public ByteString getUriBytes()

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.

string uri = 3;

Returns
Type	Description
ByteString	The bytes for uri.

getUserEvent()

public String getUserEvent()

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The userEvent.

getUserEventBytes()

public ByteString getUserEventBytes()

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for userEvent.

hasPrebuiltRule()

public boolean hasPrebuiltRule()

The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.

string prebuilt_rule = 6;

Returns
Type	Description
boolean	Whether the prebuiltRule field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CollectUserEventRequest other)

public CollectUserEventRequest.Builder mergeFrom(CollectUserEventRequest other)

Parameter
Name	Description
other	CollectUserEventRequest

Returns
Type	Description
CollectUserEventRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CollectUserEventRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CollectUserEventRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public CollectUserEventRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
CollectUserEventRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CollectUserEventRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CollectUserEventRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setEts(long value)

public CollectUserEventRequest.Builder setEts(long value)

The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

int64 ets = 4;

Parameter
Name	Description
value	long The ets to set.

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CollectUserEventRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
CollectUserEventRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setParent(String value)

public CollectUserEventRequest.Builder setParent(String value)

Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The parent to set.

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public CollectUserEventRequest.Builder setParentBytes(ByteString value)

Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for parent to set.

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

setPrebuiltRule(String value)

public CollectUserEventRequest.Builder setPrebuiltRule(String value)

The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.

string prebuilt_rule = 6;

Parameter
Name	Description
value	String The prebuiltRule to set.

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

setPrebuiltRuleBytes(ByteString value)

public CollectUserEventRequest.Builder setPrebuiltRuleBytes(ByteString value)

The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.

string prebuilt_rule = 6;

Parameter
Name	Description
value	ByteString The bytes for prebuiltRule to set.

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

setRawJson(String value)

public CollectUserEventRequest.Builder setRawJson(String value)

An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only.

string raw_json = 5;

Parameter
Name	Description
value	String The rawJson to set.

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

setRawJsonBytes(ByteString value)

public CollectUserEventRequest.Builder setRawJsonBytes(ByteString value)

An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only.

string raw_json = 5;

Parameter
Name	Description
value	ByteString The bytes for rawJson to set.

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
CollectUserEventRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final CollectUserEventRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
CollectUserEventRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUri(String value)

public CollectUserEventRequest.Builder setUri(String value)

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.

string uri = 3;

Parameter
Name	Description
value	String The uri to set.

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

setUriBytes(ByteString value)

public CollectUserEventRequest.Builder setUriBytes(ByteString value)

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.

string uri = 3;

Parameter
Name	Description
value	ByteString The bytes for uri to set.

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

setUserEvent(String value)

public CollectUserEventRequest.Builder setUserEvent(String value)

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The userEvent to set.

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.

setUserEventBytes(ByteString value)

public CollectUserEventRequest.Builder setUserEventBytes(ByteString value)

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for userEvent to set.

Returns
Type	Description
CollectUserEventRequest.Builder	This builder for chaining.