java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>
    - - com.google.cloud.discoveryengine.v1.UserEvent.Builder

All Implemented Interfaces:: UserEventOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:: UserEvent

public static final class UserEvent.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>
implements UserEventOrBuilder

 UserEvent captures all metadata information Discovery Engine API needs to
 know about how end users interact with customers' website.

Protobuf type google.cloud.discoveryengine.v1.UserEvent

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`UserEvent.Builder`	`addAllDocuments(Iterable<? extends DocumentInfo> values)`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`UserEvent.Builder`	`addAllPromotionIds(Iterable<String> values)`	The promotion IDs if this is an event associated with promotions.
`UserEvent.Builder`	`addAllTagIds(Iterable<String> values)`	A list of identifiers for the independent experiment groups this user event belongs to.
`UserEvent.Builder`	`addDocuments(int index, DocumentInfo value)`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`UserEvent.Builder`	`addDocuments(int index, DocumentInfo.Builder builderForValue)`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`UserEvent.Builder`	`addDocuments(DocumentInfo value)`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`UserEvent.Builder`	`addDocuments(DocumentInfo.Builder builderForValue)`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`DocumentInfo.Builder`	`addDocumentsBuilder()`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`DocumentInfo.Builder`	`addDocumentsBuilder(int index)`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`UserEvent.Builder`	`addPromotionIds(String value)`	The promotion IDs if this is an event associated with promotions.
`UserEvent.Builder`	`addPromotionIdsBytes(com.google.protobuf.ByteString value)`	The promotion IDs if this is an event associated with promotions.
`UserEvent.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`UserEvent.Builder`	`addTagIds(String value)`	A list of identifiers for the independent experiment groups this user event belongs to.
`UserEvent.Builder`	`addTagIdsBytes(com.google.protobuf.ByteString value)`	A list of identifiers for the independent experiment groups this user event belongs to.
`UserEvent`	`build()`
`UserEvent`	`buildPartial()`
`UserEvent.Builder`	`clear()`
`UserEvent.Builder`	`clearAttributes()`
`UserEvent.Builder`	`clearAttributionToken()`	Token to attribute an API response to user action(s) to trigger the event.
`UserEvent.Builder`	`clearCompletionInfo()`	[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] details related to the event.
`UserEvent.Builder`	`clearDirectUserRequest()`	Should set to true if the request is made directly from the end user, in which case the [UserEvent.user_info.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent] can be populated from the HTTP request.
`UserEvent.Builder`	`clearDocuments()`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`UserEvent.Builder`	`clearEventTime()`	Only required for [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents] method.
`UserEvent.Builder`	`clearEventType()`	Required.
`UserEvent.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`UserEvent.Builder`	`clearFilter()`	The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`UserEvent.Builder`	`clearMediaInfo()`	Media-specific info.
`UserEvent.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`UserEvent.Builder`	`clearPageInfo()`	Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
`UserEvent.Builder`	`clearPanel()`	Panel metadata associated with this user event.
`UserEvent.Builder`	`clearPromotionIds()`	The promotion IDs if this is an event associated with promotions.
`UserEvent.Builder`	`clearSearchInfo()`	[SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] details related to the event.
`UserEvent.Builder`	`clearSessionId()`	A unique identifier for tracking a visitor session with a length limit of 128 bytes.
`UserEvent.Builder`	`clearTagIds()`	A list of identifiers for the independent experiment groups this user event belongs to.
`UserEvent.Builder`	`clearTransactionInfo()`	The transaction metadata (if any) associated with this user event.
`UserEvent.Builder`	`clearUserInfo()`	Information about the end user.
`UserEvent.Builder`	`clearUserPseudoId()`	Required.
`UserEvent.Builder`	`clone()`
`boolean`	`containsAttributes(String key)`	Extra user event features to include in the recommendation model.
`Map<String,CustomAttribute>`	`getAttributes()`	Deprecated.
`int`	`getAttributesCount()`	Extra user event features to include in the recommendation model.
`Map<String,CustomAttribute>`	`getAttributesMap()`	Extra user event features to include in the recommendation model.
`CustomAttribute`	`getAttributesOrDefault(String key, CustomAttribute defaultValue)`	Extra user event features to include in the recommendation model.
`CustomAttribute`	`getAttributesOrThrow(String key)`	Extra user event features to include in the recommendation model.
`String`	`getAttributionToken()`	Token to attribute an API response to user action(s) to trigger the event.
`com.google.protobuf.ByteString`	`getAttributionTokenBytes()`	Token to attribute an API response to user action(s) to trigger the event.
`CompletionInfo`	`getCompletionInfo()`	[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] details related to the event.
`CompletionInfo.Builder`	`getCompletionInfoBuilder()`	[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] details related to the event.
`CompletionInfoOrBuilder`	`getCompletionInfoOrBuilder()`	[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] details related to the event.
`UserEvent`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`boolean`	`getDirectUserRequest()`	Should set to true if the request is made directly from the end user, in which case the [UserEvent.user_info.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent] can be populated from the HTTP request.
`DocumentInfo`	`getDocuments(int index)`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`DocumentInfo.Builder`	`getDocumentsBuilder(int index)`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`List<DocumentInfo.Builder>`	`getDocumentsBuilderList()`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`int`	`getDocumentsCount()`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`List<DocumentInfo>`	`getDocumentsList()`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`DocumentInfoOrBuilder`	`getDocumentsOrBuilder(int index)`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`List<? extends DocumentInfoOrBuilder>`	`getDocumentsOrBuilderList()`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`com.google.protobuf.Timestamp`	`getEventTime()`	Only required for [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents] method.
`com.google.protobuf.Timestamp.Builder`	`getEventTimeBuilder()`	Only required for [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents] method.
`com.google.protobuf.TimestampOrBuilder`	`getEventTimeOrBuilder()`	Only required for [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents] method.
`String`	`getEventType()`	Required.
`com.google.protobuf.ByteString`	`getEventTypeBytes()`	Required.
`String`	`getFilter()`	The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`com.google.protobuf.ByteString`	`getFilterBytes()`	The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`MediaInfo`	`getMediaInfo()`	Media-specific info.
`MediaInfo.Builder`	`getMediaInfoBuilder()`	Media-specific info.
`MediaInfoOrBuilder`	`getMediaInfoOrBuilder()`	Media-specific info.
`Map<String,CustomAttribute>`	`getMutableAttributes()`	Deprecated.
`PageInfo`	`getPageInfo()`	Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
`PageInfo.Builder`	`getPageInfoBuilder()`	Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
`PageInfoOrBuilder`	`getPageInfoOrBuilder()`	Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
`PanelInfo`	`getPanel()`	Panel metadata associated with this user event.
`PanelInfo.Builder`	`getPanelBuilder()`	Panel metadata associated with this user event.
`PanelInfoOrBuilder`	`getPanelOrBuilder()`	Panel metadata associated with this user event.
`String`	`getPromotionIds(int index)`	The promotion IDs if this is an event associated with promotions.
`com.google.protobuf.ByteString`	`getPromotionIdsBytes(int index)`	The promotion IDs if this is an event associated with promotions.
`int`	`getPromotionIdsCount()`	The promotion IDs if this is an event associated with promotions.
`com.google.protobuf.ProtocolStringList`	`getPromotionIdsList()`	The promotion IDs if this is an event associated with promotions.
`SearchInfo`	`getSearchInfo()`	[SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] details related to the event.
`SearchInfo.Builder`	`getSearchInfoBuilder()`	[SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] details related to the event.
`SearchInfoOrBuilder`	`getSearchInfoOrBuilder()`	[SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] details related to the event.
`String`	`getSessionId()`	A unique identifier for tracking a visitor session with a length limit of 128 bytes.
`com.google.protobuf.ByteString`	`getSessionIdBytes()`	A unique identifier for tracking a visitor session with a length limit of 128 bytes.
`String`	`getTagIds(int index)`	A list of identifiers for the independent experiment groups this user event belongs to.
`com.google.protobuf.ByteString`	`getTagIdsBytes(int index)`	A list of identifiers for the independent experiment groups this user event belongs to.
`int`	`getTagIdsCount()`	A list of identifiers for the independent experiment groups this user event belongs to.
`com.google.protobuf.ProtocolStringList`	`getTagIdsList()`	A list of identifiers for the independent experiment groups this user event belongs to.
`TransactionInfo`	`getTransactionInfo()`	The transaction metadata (if any) associated with this user event.
`TransactionInfo.Builder`	`getTransactionInfoBuilder()`	The transaction metadata (if any) associated with this user event.
`TransactionInfoOrBuilder`	`getTransactionInfoOrBuilder()`	The transaction metadata (if any) associated with this user event.
`UserInfo`	`getUserInfo()`	Information about the end user.
`UserInfo.Builder`	`getUserInfoBuilder()`	Information about the end user.
`UserInfoOrBuilder`	`getUserInfoOrBuilder()`	Information about the end user.
`String`	`getUserPseudoId()`	Required.
`com.google.protobuf.ByteString`	`getUserPseudoIdBytes()`	Required.
`boolean`	`hasCompletionInfo()`	[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] details related to the event.
`boolean`	`hasEventTime()`	Only required for [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents] method.
`boolean`	`hasMediaInfo()`	Media-specific info.
`boolean`	`hasPageInfo()`	Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
`boolean`	`hasPanel()`	Panel metadata associated with this user event.
`boolean`	`hasSearchInfo()`	[SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] details related to the event.
`boolean`	`hasTransactionInfo()`	The transaction metadata (if any) associated with this user event.
`boolean`	`hasUserInfo()`	Information about the end user.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`protected com.google.protobuf.MapField`	`internalGetMutableMapField(int number)`
`boolean`	`isInitialized()`
`UserEvent.Builder`	`mergeCompletionInfo(CompletionInfo value)`	[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] details related to the event.
`UserEvent.Builder`	`mergeEventTime(com.google.protobuf.Timestamp value)`	Only required for [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents] method.
`UserEvent.Builder`	`mergeFrom(UserEvent other)`
`UserEvent.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`UserEvent.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`UserEvent.Builder`	`mergeMediaInfo(MediaInfo value)`	Media-specific info.
`UserEvent.Builder`	`mergePageInfo(PageInfo value)`	Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
`UserEvent.Builder`	`mergePanel(PanelInfo value)`	Panel metadata associated with this user event.
`UserEvent.Builder`	`mergeSearchInfo(SearchInfo value)`	[SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] details related to the event.
`UserEvent.Builder`	`mergeTransactionInfo(TransactionInfo value)`	The transaction metadata (if any) associated with this user event.
`UserEvent.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`UserEvent.Builder`	`mergeUserInfo(UserInfo value)`	Information about the end user.
`UserEvent.Builder`	`putAllAttributes(Map<String,CustomAttribute> values)`	Extra user event features to include in the recommendation model.
`UserEvent.Builder`	`putAttributes(String key, CustomAttribute value)`	Extra user event features to include in the recommendation model.
`UserEvent.Builder`	`removeAttributes(String key)`	Extra user event features to include in the recommendation model.
`UserEvent.Builder`	`removeDocuments(int index)`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`UserEvent.Builder`	`setAttributionToken(String value)`	Token to attribute an API response to user action(s) to trigger the event.
`UserEvent.Builder`	`setAttributionTokenBytes(com.google.protobuf.ByteString value)`	Token to attribute an API response to user action(s) to trigger the event.
`UserEvent.Builder`	`setCompletionInfo(CompletionInfo value)`	[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] details related to the event.
`UserEvent.Builder`	`setCompletionInfo(CompletionInfo.Builder builderForValue)`	[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] details related to the event.
`UserEvent.Builder`	`setDirectUserRequest(boolean value)`	Should set to true if the request is made directly from the end user, in which case the [UserEvent.user_info.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent] can be populated from the HTTP request.
`UserEvent.Builder`	`setDocuments(int index, DocumentInfo value)`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`UserEvent.Builder`	`setDocuments(int index, DocumentInfo.Builder builderForValue)`	List of [Document][google.cloud.discoveryengine.v1.Document]s associated with this user event.
`UserEvent.Builder`	`setEventTime(com.google.protobuf.Timestamp value)`	Only required for [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents] method.
`UserEvent.Builder`	`setEventTime(com.google.protobuf.Timestamp.Builder builderForValue)`	Only required for [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents] method.
`UserEvent.Builder`	`setEventType(String value)`	Required.
`UserEvent.Builder`	`setEventTypeBytes(com.google.protobuf.ByteString value)`	Required.
`UserEvent.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`UserEvent.Builder`	`setFilter(String value)`	The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`UserEvent.Builder`	`setFilterBytes(com.google.protobuf.ByteString value)`	The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`UserEvent.Builder`	`setMediaInfo(MediaInfo value)`	Media-specific info.
`UserEvent.Builder`	`setMediaInfo(MediaInfo.Builder builderForValue)`	Media-specific info.
`UserEvent.Builder`	`setPageInfo(PageInfo value)`	Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
`UserEvent.Builder`	`setPageInfo(PageInfo.Builder builderForValue)`	Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
`UserEvent.Builder`	`setPanel(PanelInfo value)`	Panel metadata associated with this user event.
`UserEvent.Builder`	`setPanel(PanelInfo.Builder builderForValue)`	Panel metadata associated with this user event.
`UserEvent.Builder`	`setPromotionIds(int index, String value)`	The promotion IDs if this is an event associated with promotions.
`UserEvent.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`UserEvent.Builder`	`setSearchInfo(SearchInfo value)`	[SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] details related to the event.
`UserEvent.Builder`	`setSearchInfo(SearchInfo.Builder builderForValue)`	[SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] details related to the event.
`UserEvent.Builder`	`setSessionId(String value)`	A unique identifier for tracking a visitor session with a length limit of 128 bytes.
`UserEvent.Builder`	`setSessionIdBytes(com.google.protobuf.ByteString value)`	A unique identifier for tracking a visitor session with a length limit of 128 bytes.
`UserEvent.Builder`	`setTagIds(int index, String value)`	A list of identifiers for the independent experiment groups this user event belongs to.
`UserEvent.Builder`	`setTransactionInfo(TransactionInfo value)`	The transaction metadata (if any) associated with this user event.
`UserEvent.Builder`	`setTransactionInfo(TransactionInfo.Builder builderForValue)`	The transaction metadata (if any) associated with this user event.
`UserEvent.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`UserEvent.Builder`	`setUserInfo(UserInfo value)`	Information about the end user.
`UserEvent.Builder`	`setUserInfo(UserInfo.Builder builderForValue)`	Information about the end user.
`UserEvent.Builder`	`setUserPseudoId(String value)`	Required.
`UserEvent.Builder`	`setUserPseudoIdBytes(com.google.protobuf.ByteString value)`	Required.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, 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()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>

internalGetMutableMapField
```
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
```
Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

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

clear
```
public UserEvent.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<UserEvent.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<UserEvent.Builder>

getDefaultInstanceForType
```
public UserEvent getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public UserEvent build()
```
Specified by:

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

Specified by:

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

buildPartial
```
public UserEvent buildPartial()
```
Specified by:

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

Specified by:

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

clone
```
public UserEvent.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<UserEvent.Builder>

setField

public UserEvent.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<UserEvent.Builder>

clearField
```
public UserEvent.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<UserEvent.Builder>

clearOneof
```
public UserEvent.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<UserEvent.Builder>

setRepeatedField

public UserEvent.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<UserEvent.Builder>

addRepeatedField

public UserEvent.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<UserEvent.Builder>

mergeFrom
```
public UserEvent.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<UserEvent.Builder>

mergeFrom

public UserEvent.Builder mergeFrom(UserEvent other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom
```
public UserEvent.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<UserEvent.Builder>

Throws:

IOException

getEventType

public String getEventType()

 Required. User event type. Allowed values are:

 Generic values:

 * `search`: Search for Documents.
 * `view-item`: Detailed page view of a Document.
 * `view-item-list`: View of a panel or ordered list of Documents.
 * `view-home-page`: View of the home page.
 * `view-category-page`: View of a category page, e.g. Home > Men > Jeans

 Retail-related values:

 * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping
 * `purchase`: Purchase an item(s)

 Media-related values:

 * `media-play`: Start/resume watching a video, playing a song, etc.
 * `media-complete`: Finished or stopped midway through a video, song, etc.

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

Specified by:: getEventType in interface UserEventOrBuilder
Returns:: The eventType.

getEventTypeBytes

public com.google.protobuf.ByteString getEventTypeBytes()

 Required. User event type. Allowed values are:

 Generic values:

 * `search`: Search for Documents.
 * `view-item`: Detailed page view of a Document.
 * `view-item-list`: View of a panel or ordered list of Documents.
 * `view-home-page`: View of the home page.
 * `view-category-page`: View of a category page, e.g. Home > Men > Jeans

 Retail-related values:

 * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping
 * `purchase`: Purchase an item(s)

 Media-related values:

 * `media-play`: Start/resume watching a video, playing a song, etc.
 * `media-complete`: Finished or stopped midway through a video, song, etc.

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

Specified by:: getEventTypeBytes in interface UserEventOrBuilder
Returns:: The bytes for eventType.

setEventType

public UserEvent.Builder setEventType(String value)

 Required. User event type. Allowed values are:

 Generic values:

 * `search`: Search for Documents.
 * `view-item`: Detailed page view of a Document.
 * `view-item-list`: View of a panel or ordered list of Documents.
 * `view-home-page`: View of the home page.
 * `view-category-page`: View of a category page, e.g. Home > Men > Jeans

 Retail-related values:

 * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping
 * `purchase`: Purchase an item(s)

 Media-related values:

 * `media-play`: Start/resume watching a video, playing a song, etc.
 * `media-complete`: Finished or stopped midway through a video, song, etc.

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

Parameters:: value - The eventType to set.
Returns:: This builder for chaining.

clearEventType

public UserEvent.Builder clearEventType()

 Required. User event type. Allowed values are:

 Generic values:

 * `search`: Search for Documents.
 * `view-item`: Detailed page view of a Document.
 * `view-item-list`: View of a panel or ordered list of Documents.
 * `view-home-page`: View of the home page.
 * `view-category-page`: View of a category page, e.g. Home > Men > Jeans

 Retail-related values:

 * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping
 * `purchase`: Purchase an item(s)

 Media-related values:

 * `media-play`: Start/resume watching a video, playing a song, etc.
 * `media-complete`: Finished or stopped midway through a video, song, etc.

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

Returns:: This builder for chaining.

setEventTypeBytes

public UserEvent.Builder setEventTypeBytes(com.google.protobuf.ByteString value)

 Required. User event type. Allowed values are:

 Generic values:

 * `search`: Search for Documents.
 * `view-item`: Detailed page view of a Document.
 * `view-item-list`: View of a panel or ordered list of Documents.
 * `view-home-page`: View of the home page.
 * `view-category-page`: View of a category page, e.g. Home > Men > Jeans

 Retail-related values:

 * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping
 * `purchase`: Purchase an item(s)

 Media-related values:

 * `media-play`: Start/resume watching a video, playing a song, etc.
 * `media-complete`: Finished or stopped midway through a video, song, etc.

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

Parameters:: value - The bytes for eventType to set.
Returns:: This builder for chaining.

getUserPseudoId

public String getUserPseudoId()

 Required. A unique identifier for tracking visitors.

 For example, this could be implemented with an HTTP cookie, which should be
 able to uniquely identify a visitor on a single device. This unique
 identifier should not change if the visitor log in/out of the website.

 Do not set the field to the same fixed ID for different users. This mixes
 the event history of those users together, which results in degraded model
 quality.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 The field should not contain PII or user-data. We recommend to use Google
 Analytics [Client
 ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
 for this field.

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

Specified by:: getUserPseudoId in interface UserEventOrBuilder
Returns:: The userPseudoId.

getUserPseudoIdBytes

public com.google.protobuf.ByteString getUserPseudoIdBytes()

 Required. A unique identifier for tracking visitors.

 For example, this could be implemented with an HTTP cookie, which should be
 able to uniquely identify a visitor on a single device. This unique
 identifier should not change if the visitor log in/out of the website.

 Do not set the field to the same fixed ID for different users. This mixes
 the event history of those users together, which results in degraded model
 quality.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 The field should not contain PII or user-data. We recommend to use Google
 Analytics [Client
 ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
 for this field.

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

Specified by:: getUserPseudoIdBytes in interface UserEventOrBuilder
Returns:: The bytes for userPseudoId.

setUserPseudoId

public UserEvent.Builder setUserPseudoId(String value)

 Required. A unique identifier for tracking visitors.

 For example, this could be implemented with an HTTP cookie, which should be
 able to uniquely identify a visitor on a single device. This unique
 identifier should not change if the visitor log in/out of the website.

 Do not set the field to the same fixed ID for different users. This mixes
 the event history of those users together, which results in degraded model
 quality.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 The field should not contain PII or user-data. We recommend to use Google
 Analytics [Client
 ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
 for this field.

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

Parameters:: value - The userPseudoId to set.
Returns:: This builder for chaining.

clearUserPseudoId

public UserEvent.Builder clearUserPseudoId()

 Required. A unique identifier for tracking visitors.

 For example, this could be implemented with an HTTP cookie, which should be
 able to uniquely identify a visitor on a single device. This unique
 identifier should not change if the visitor log in/out of the website.

 Do not set the field to the same fixed ID for different users. This mixes
 the event history of those users together, which results in degraded model
 quality.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 The field should not contain PII or user-data. We recommend to use Google
 Analytics [Client
 ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
 for this field.

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

Returns:: This builder for chaining.

setUserPseudoIdBytes

public UserEvent.Builder setUserPseudoIdBytes(com.google.protobuf.ByteString value)

 Required. A unique identifier for tracking visitors.

 For example, this could be implemented with an HTTP cookie, which should be
 able to uniquely identify a visitor on a single device. This unique
 identifier should not change if the visitor log in/out of the website.

 Do not set the field to the same fixed ID for different users. This mixes
 the event history of those users together, which results in degraded model
 quality.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

 The field should not contain PII or user-data. We recommend to use Google
 Analytics [Client
 ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
 for this field.

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

Parameters:: value - The bytes for userPseudoId to set.
Returns:: This builder for chaining.

hasEventTime

public boolean hasEventTime()

 Only required for
 [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

Specified by:: hasEventTime in interface UserEventOrBuilder
Returns:: Whether the eventTime field is set.

getEventTime

public com.google.protobuf.Timestamp getEventTime()

 Only required for
 [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

Specified by:: getEventTime in interface UserEventOrBuilder
Returns:: The eventTime.

setEventTime

public UserEvent.Builder setEventTime(com.google.protobuf.Timestamp value)

 Only required for
 [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

setEventTime

public UserEvent.Builder setEventTime(com.google.protobuf.Timestamp.Builder builderForValue)

 Only required for
 [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

mergeEventTime

public UserEvent.Builder mergeEventTime(com.google.protobuf.Timestamp value)

 Only required for
 [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

clearEventTime

public UserEvent.Builder clearEventTime()

 Only required for
 [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

getEventTimeBuilder

public com.google.protobuf.Timestamp.Builder getEventTimeBuilder()

 Only required for
 [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

getEventTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getEventTimeOrBuilder()

 Only required for
 [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

Specified by:: getEventTimeOrBuilder in interface UserEventOrBuilder

hasUserInfo
```
public boolean hasUserInfo()
```
```
 Information about the end user.
 
```
.google.cloud.discoveryengine.v1.UserInfo user_info = 4;
Specified by:

hasUserInfo in interface UserEventOrBuilder

Returns:

Whether the userInfo field is set.

getUserInfo
```
public UserInfo getUserInfo()
```
```
 Information about the end user.
 
```
.google.cloud.discoveryengine.v1.UserInfo user_info = 4;
Specified by:

getUserInfo in interface UserEventOrBuilder

Returns:

The userInfo.

setUserInfo

public UserEvent.Builder setUserInfo(UserInfo value)

 Information about the end user.

.google.cloud.discoveryengine.v1.UserInfo user_info = 4;

setUserInfo

public UserEvent.Builder setUserInfo(UserInfo.Builder builderForValue)

 Information about the end user.

.google.cloud.discoveryengine.v1.UserInfo user_info = 4;

mergeUserInfo

public UserEvent.Builder mergeUserInfo(UserInfo value)

 Information about the end user.

.google.cloud.discoveryengine.v1.UserInfo user_info = 4;

clearUserInfo

public UserEvent.Builder clearUserInfo()

 Information about the end user.

.google.cloud.discoveryengine.v1.UserInfo user_info = 4;

getUserInfoBuilder

public UserInfo.Builder getUserInfoBuilder()

 Information about the end user.

.google.cloud.discoveryengine.v1.UserInfo user_info = 4;

getUserInfoOrBuilder
```
public UserInfoOrBuilder getUserInfoOrBuilder()
```
```
 Information about the end user.
 
```
.google.cloud.discoveryengine.v1.UserInfo user_info = 4;
Specified by:

getUserInfoOrBuilder in interface UserEventOrBuilder

getDirectUserRequest

public boolean getDirectUserRequest()

 Should set to true if the request is made directly from the end user, in
 which case the
 [UserEvent.user_info.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
 can be populated from the HTTP request.

 This flag should be set only if the API request is made directly from the
 end user such as a mobile app (and not if a gateway or a server is
 processing and pushing the user events).

 This should not be set when using the JavaScript tag in
 [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1.UserEventService.CollectUserEvent].

bool direct_user_request = 5;

Specified by:: getDirectUserRequest in interface UserEventOrBuilder
Returns:: The directUserRequest.

setDirectUserRequest

public UserEvent.Builder setDirectUserRequest(boolean value)

 Should set to true if the request is made directly from the end user, in
 which case the
 [UserEvent.user_info.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
 can be populated from the HTTP request.

 This flag should be set only if the API request is made directly from the
 end user such as a mobile app (and not if a gateway or a server is
 processing and pushing the user events).

 This should not be set when using the JavaScript tag in
 [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1.UserEventService.CollectUserEvent].

bool direct_user_request = 5;

Parameters:: value - The directUserRequest to set.
Returns:: This builder for chaining.

clearDirectUserRequest

public UserEvent.Builder clearDirectUserRequest()

 Should set to true if the request is made directly from the end user, in
 which case the
 [UserEvent.user_info.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
 can be populated from the HTTP request.

 This flag should be set only if the API request is made directly from the
 end user such as a mobile app (and not if a gateway or a server is
 processing and pushing the user events).

 This should not be set when using the JavaScript tag in
 [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1.UserEventService.CollectUserEvent].

bool direct_user_request = 5;

Returns:: This builder for chaining.

getSessionId

public String getSessionId()

 A unique identifier for tracking a visitor session with a length limit of
 128 bytes. A session is an aggregation of an end user behavior in a time
 span.

 A general guideline to populate the session_id:

 1. If user has no activity for 30 min, a new session_id should be assigned.
 2. The session_id should be unique across users, suggest use uuid or add
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 as prefix.

string session_id = 6;

Specified by:: getSessionId in interface UserEventOrBuilder
Returns:: The sessionId.

getSessionIdBytes

public com.google.protobuf.ByteString getSessionIdBytes()

 A unique identifier for tracking a visitor session with a length limit of
 128 bytes. A session is an aggregation of an end user behavior in a time
 span.

 A general guideline to populate the session_id:

 1. If user has no activity for 30 min, a new session_id should be assigned.
 2. The session_id should be unique across users, suggest use uuid or add
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 as prefix.

string session_id = 6;

Specified by:: getSessionIdBytes in interface UserEventOrBuilder
Returns:: The bytes for sessionId.

setSessionId

public UserEvent.Builder setSessionId(String value)

 A unique identifier for tracking a visitor session with a length limit of
 128 bytes. A session is an aggregation of an end user behavior in a time
 span.

 A general guideline to populate the session_id:

 1. If user has no activity for 30 min, a new session_id should be assigned.
 2. The session_id should be unique across users, suggest use uuid or add
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 as prefix.

string session_id = 6;

Parameters:: value - The sessionId to set.
Returns:: This builder for chaining.

clearSessionId

public UserEvent.Builder clearSessionId()

 A unique identifier for tracking a visitor session with a length limit of
 128 bytes. A session is an aggregation of an end user behavior in a time
 span.

 A general guideline to populate the session_id:

 1. If user has no activity for 30 min, a new session_id should be assigned.
 2. The session_id should be unique across users, suggest use uuid or add
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 as prefix.

string session_id = 6;

Returns:: This builder for chaining.

setSessionIdBytes

public UserEvent.Builder setSessionIdBytes(com.google.protobuf.ByteString value)

 A unique identifier for tracking a visitor session with a length limit of
 128 bytes. A session is an aggregation of an end user behavior in a time
 span.

 A general guideline to populate the session_id:

 1. If user has no activity for 30 min, a new session_id should be assigned.
 2. The session_id should be unique across users, suggest use uuid or add
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 as prefix.

string session_id = 6;

Parameters:: value - The bytes for sessionId to set.
Returns:: This builder for chaining.

hasPageInfo
```
public boolean hasPageInfo()
```
```
 Page metadata such as categories and other critical information for certain
 event types such as `view-category-page`.
 
```
.google.cloud.discoveryengine.v1.PageInfo page_info = 7;
Specified by:

hasPageInfo in interface UserEventOrBuilder

Returns:

Whether the pageInfo field is set.

getPageInfo

public PageInfo getPageInfo()

 Page metadata such as categories and other critical information for certain
 event types such as `view-category-page`.

.google.cloud.discoveryengine.v1.PageInfo page_info = 7;

Specified by:: getPageInfo in interface UserEventOrBuilder
Returns:: The pageInfo.

setPageInfo

public UserEvent.Builder setPageInfo(PageInfo value)

 Page metadata such as categories and other critical information for certain
 event types such as `view-category-page`.

.google.cloud.discoveryengine.v1.PageInfo page_info = 7;

setPageInfo

public UserEvent.Builder setPageInfo(PageInfo.Builder builderForValue)

 Page metadata such as categories and other critical information for certain
 event types such as `view-category-page`.

.google.cloud.discoveryengine.v1.PageInfo page_info = 7;

mergePageInfo

public UserEvent.Builder mergePageInfo(PageInfo value)

 Page metadata such as categories and other critical information for certain
 event types such as `view-category-page`.

.google.cloud.discoveryengine.v1.PageInfo page_info = 7;

clearPageInfo

public UserEvent.Builder clearPageInfo()

 Page metadata such as categories and other critical information for certain
 event types such as `view-category-page`.

.google.cloud.discoveryengine.v1.PageInfo page_info = 7;

getPageInfoBuilder

public PageInfo.Builder getPageInfoBuilder()

 Page metadata such as categories and other critical information for certain
 event types such as `view-category-page`.

.google.cloud.discoveryengine.v1.PageInfo page_info = 7;

getPageInfoOrBuilder

public PageInfoOrBuilder getPageInfoOrBuilder()

 Page metadata such as categories and other critical information for certain
 event types such as `view-category-page`.

.google.cloud.discoveryengine.v1.PageInfo page_info = 7;

Specified by:: getPageInfoOrBuilder in interface UserEventOrBuilder

getAttributionToken

public String getAttributionToken()

 Token to attribute an API response to user action(s) to trigger the event.

 Highly recommended for user events that are the result of
 [RecommendationService.Recommend][]. This field enables accurate
 attribution of recommendation model performance.

 The value must be one of:

 * [RecommendResponse.attribution_token][] for events that are the result of
 [RecommendationService.Recommend][].
 * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1.SearchResponse.attribution_token] for events that are the result of
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search].

 This token enables us to accurately attribute page view or conversion
 completion back to the event and the particular predict response containing
 this clicked/purchased product. If user clicks on product K in the
 recommendation results, pass [RecommendResponse.attribution_token][] as a
 URL parameter to product K's page. When recording events on product K's
 page, log the [RecommendResponse.attribution_token][] to this field.

string attribution_token = 8;

Specified by:: getAttributionToken in interface UserEventOrBuilder
Returns:: The attributionToken.

getAttributionTokenBytes

public com.google.protobuf.ByteString getAttributionTokenBytes()

 Token to attribute an API response to user action(s) to trigger the event.

 Highly recommended for user events that are the result of
 [RecommendationService.Recommend][]. This field enables accurate
 attribution of recommendation model performance.

 The value must be one of:

 * [RecommendResponse.attribution_token][] for events that are the result of
 [RecommendationService.Recommend][].
 * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1.SearchResponse.attribution_token] for events that are the result of
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search].

 This token enables us to accurately attribute page view or conversion
 completion back to the event and the particular predict response containing
 this clicked/purchased product. If user clicks on product K in the
 recommendation results, pass [RecommendResponse.attribution_token][] as a
 URL parameter to product K's page. When recording events on product K's
 page, log the [RecommendResponse.attribution_token][] to this field.

string attribution_token = 8;

Specified by:: getAttributionTokenBytes in interface UserEventOrBuilder
Returns:: The bytes for attributionToken.

setAttributionToken

public UserEvent.Builder setAttributionToken(String value)

 Token to attribute an API response to user action(s) to trigger the event.

 Highly recommended for user events that are the result of
 [RecommendationService.Recommend][]. This field enables accurate
 attribution of recommendation model performance.

 The value must be one of:

 * [RecommendResponse.attribution_token][] for events that are the result of
 [RecommendationService.Recommend][].
 * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1.SearchResponse.attribution_token] for events that are the result of
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search].

 This token enables us to accurately attribute page view or conversion
 completion back to the event and the particular predict response containing
 this clicked/purchased product. If user clicks on product K in the
 recommendation results, pass [RecommendResponse.attribution_token][] as a
 URL parameter to product K's page. When recording events on product K's
 page, log the [RecommendResponse.attribution_token][] to this field.

string attribution_token = 8;

Parameters:: value - The attributionToken to set.
Returns:: This builder for chaining.

clearAttributionToken

public UserEvent.Builder clearAttributionToken()

 Token to attribute an API response to user action(s) to trigger the event.

 Highly recommended for user events that are the result of
 [RecommendationService.Recommend][]. This field enables accurate
 attribution of recommendation model performance.

 The value must be one of:

 * [RecommendResponse.attribution_token][] for events that are the result of
 [RecommendationService.Recommend][].
 * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1.SearchResponse.attribution_token] for events that are the result of
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search].

 This token enables us to accurately attribute page view or conversion
 completion back to the event and the particular predict response containing
 this clicked/purchased product. If user clicks on product K in the
 recommendation results, pass [RecommendResponse.attribution_token][] as a
 URL parameter to product K's page. When recording events on product K's
 page, log the [RecommendResponse.attribution_token][] to this field.

string attribution_token = 8;

Returns:: This builder for chaining.

setAttributionTokenBytes

public UserEvent.Builder setAttributionTokenBytes(com.google.protobuf.ByteString value)

 Token to attribute an API response to user action(s) to trigger the event.

 Highly recommended for user events that are the result of
 [RecommendationService.Recommend][]. This field enables accurate
 attribution of recommendation model performance.

 The value must be one of:

 * [RecommendResponse.attribution_token][] for events that are the result of
 [RecommendationService.Recommend][].
 * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1.SearchResponse.attribution_token] for events that are the result of
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search].

 This token enables us to accurately attribute page view or conversion
 completion back to the event and the particular predict response containing
 this clicked/purchased product. If user clicks on product K in the
 recommendation results, pass [RecommendResponse.attribution_token][] as a
 URL parameter to product K's page. When recording events on product K's
 page, log the [RecommendResponse.attribution_token][] to this field.

string attribution_token = 8;

Parameters:: value - The bytes for attributionToken to set.
Returns:: This builder for chaining.

getFilter

public String getFilter()

 The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the documents being filtered.

 One example is for `search` events, the associated
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] may contain
 a filter expression in
 [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter]
 conforming to https://google.aip.dev/160#filtering.

 Similarly, for `view-item-list` events that are generated from a
 [RecommendationService.RecommendRequest][], this field may be populated
 directly from [RecommendationService.RecommendRequest.filter][] conforming
 to https://google.aip.dev/160#filtering.

 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

string filter = 9;

Specified by:: getFilter in interface UserEventOrBuilder
Returns:: The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the documents being filtered.

 One example is for `search` events, the associated
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] may contain
 a filter expression in
 [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter]
 conforming to https://google.aip.dev/160#filtering.

 Similarly, for `view-item-list` events that are generated from a
 [RecommendationService.RecommendRequest][], this field may be populated
 directly from [RecommendationService.RecommendRequest.filter][] conforming
 to https://google.aip.dev/160#filtering.

 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

string filter = 9;

Specified by:: getFilterBytes in interface UserEventOrBuilder
Returns:: The bytes for filter.

setFilter

public UserEvent.Builder setFilter(String value)

 The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the documents being filtered.

 One example is for `search` events, the associated
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] may contain
 a filter expression in
 [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter]
 conforming to https://google.aip.dev/160#filtering.

 Similarly, for `view-item-list` events that are generated from a
 [RecommendationService.RecommendRequest][], this field may be populated
 directly from [RecommendationService.RecommendRequest.filter][] conforming
 to https://google.aip.dev/160#filtering.

 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

string filter = 9;

Parameters:: value - The filter to set.
Returns:: This builder for chaining.

clearFilter

public UserEvent.Builder clearFilter()

 The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the documents being filtered.

 One example is for `search` events, the associated
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] may contain
 a filter expression in
 [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter]
 conforming to https://google.aip.dev/160#filtering.

 Similarly, for `view-item-list` events that are generated from a
 [RecommendationService.RecommendRequest][], this field may be populated
 directly from [RecommendationService.RecommendRequest.filter][] conforming
 to https://google.aip.dev/160#filtering.

 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

string filter = 9;

Returns:: This builder for chaining.

setFilterBytes

public UserEvent.Builder setFilterBytes(com.google.protobuf.ByteString value)

 The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the documents being filtered.

 One example is for `search` events, the associated
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] may contain
 a filter expression in
 [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter]
 conforming to https://google.aip.dev/160#filtering.

 Similarly, for `view-item-list` events that are generated from a
 [RecommendationService.RecommendRequest][], this field may be populated
 directly from [RecommendationService.RecommendRequest.filter][] conforming
 to https://google.aip.dev/160#filtering.

 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

string filter = 9;

Parameters:: value - The bytes for filter to set.
Returns:: This builder for chaining.