Class CollectUserEventRequest.Builder (2.48.0) 

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

Request message for CollectUserEvent method.

Protobuf type google.cloud.retail.v2beta.CollectUserEventRequest

Inheritance

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

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

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

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

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

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

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

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.