| Modifier and Type | Method and Description |
|---|---|
UserEvent.Builder |
UserEvent.Builder.addAllDocuments(Iterable<? extends DocumentInfo> values)
List of [Document][google.cloud.discoveryengine.v1beta.Document]s
associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.addAllPromotionIds(Iterable<String> values)
The promotion IDs if this is an event associated with promotions.
|
UserEvent.Builder |
UserEvent.Builder.addAllTagIds(Iterable<String> values)
A list of identifiers for the independent experiment groups this user event
belongs to.
|
UserEvent.Builder |
UserEvent.Builder.addDocuments(DocumentInfo.Builder builderForValue)
List of [Document][google.cloud.discoveryengine.v1beta.Document]s
associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.addDocuments(DocumentInfo value)
List of [Document][google.cloud.discoveryengine.v1beta.Document]s
associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.addDocuments(int index,
DocumentInfo.Builder builderForValue)
List of [Document][google.cloud.discoveryengine.v1beta.Document]s
associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.addDocuments(int index,
DocumentInfo value)
List of [Document][google.cloud.discoveryengine.v1beta.Document]s
associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.addPromotionIds(String value)
The promotion IDs if this is an event associated with promotions.
|
UserEvent.Builder |
UserEvent.Builder.addPromotionIdsBytes(com.google.protobuf.ByteString value)
The promotion IDs if this is an event associated with promotions.
|
UserEvent.Builder |
UserEvent.Builder.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
UserEvent.Builder |
UserEvent.Builder.addTagIds(String value)
A list of identifiers for the independent experiment groups this user event
belongs to.
|
UserEvent.Builder |
UserEvent.Builder.addTagIdsBytes(com.google.protobuf.ByteString value)
A list of identifiers for the independent experiment groups this user event
belongs to.
|
UserEvent.Builder |
ImportUserEventsRequest.InlineSource.Builder.addUserEventsBuilder()
Required.
|
UserEvent.Builder |
ImportUserEventsRequest.InlineSource.Builder.addUserEventsBuilder(int index)
Required.
|
UserEvent.Builder |
UserEvent.Builder.clear() |
UserEvent.Builder |
UserEvent.Builder.clearAttributes() |
UserEvent.Builder |
UserEvent.Builder.clearAttributionToken()
Token to attribute an API response to user action(s) to trigger the event.
|
UserEvent.Builder |
UserEvent.Builder.clearCompletionInfo()
[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery]
details related to the event.
|
UserEvent.Builder |
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.v1beta.UserInfo.user_agent]
can be populated from the HTTP request.
|
UserEvent.Builder |
UserEvent.Builder.clearDocuments()
List of [Document][google.cloud.discoveryengine.v1beta.Document]s
associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.clearEventTime()
Only required for
[UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents]
method.
|
UserEvent.Builder |
UserEvent.Builder.clearEventType()
Required.
|
UserEvent.Builder |
UserEvent.Builder.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
UserEvent.Builder |
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 |
UserEvent.Builder.clearMediaInfo()
Media-specific info.
|
UserEvent.Builder |
UserEvent.Builder.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
UserEvent.Builder |
UserEvent.Builder.clearPageInfo()
Page metadata such as categories and other critical information for certain
event types such as `view-category-page`.
|
UserEvent.Builder |
UserEvent.Builder.clearPanel()
Panel metadata associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.clearPromotionIds()
The promotion IDs if this is an event associated with promotions.
|
UserEvent.Builder |
UserEvent.Builder.clearSearchInfo()
[SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
details related to the event.
|
UserEvent.Builder |
UserEvent.Builder.clearSessionId()
A unique identifier for tracking a visitor session with a length limit of
128 bytes.
|
UserEvent.Builder |
UserEvent.Builder.clearTagIds()
A list of identifiers for the independent experiment groups this user event
belongs to.
|
UserEvent.Builder |
UserEvent.Builder.clearTransactionInfo()
The transaction metadata (if any) associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.clearUserInfo()
Information about the end user.
|
UserEvent.Builder |
UserEvent.Builder.clearUserPseudoId()
Required.
|
UserEvent.Builder |
UserEvent.Builder.clone() |
UserEvent.Builder |
RecommendRequest.Builder.getUserEventBuilder()
Required.
|
UserEvent.Builder |
WriteUserEventRequest.Builder.getUserEventBuilder()
Required.
|
UserEvent.Builder |
ImportUserEventsRequest.InlineSource.Builder.getUserEventsBuilder(int index)
Required.
|
UserEvent.Builder |
UserEvent.Builder.mergeCompletionInfo(CompletionInfo value)
[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery]
details related to the event.
|
UserEvent.Builder |
UserEvent.Builder.mergeEventTime(com.google.protobuf.Timestamp value)
Only required for
[UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents]
method.
|
UserEvent.Builder |
UserEvent.Builder.mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
UserEvent.Builder |
UserEvent.Builder.mergeFrom(com.google.protobuf.Message other) |
UserEvent.Builder |
UserEvent.Builder.mergeFrom(UserEvent other) |
UserEvent.Builder |
UserEvent.Builder.mergeMediaInfo(MediaInfo value)
Media-specific info.
|
UserEvent.Builder |
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 |
UserEvent.Builder.mergePanel(PanelInfo value)
Panel metadata associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.mergeSearchInfo(SearchInfo value)
[SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
details related to the event.
|
UserEvent.Builder |
UserEvent.Builder.mergeTransactionInfo(TransactionInfo value)
The transaction metadata (if any) associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
UserEvent.Builder |
UserEvent.Builder.mergeUserInfo(UserInfo value)
Information about the end user.
|
static UserEvent.Builder |
UserEvent.newBuilder() |
static UserEvent.Builder |
UserEvent.newBuilder(UserEvent prototype) |
UserEvent.Builder |
UserEvent.newBuilderForType() |
protected UserEvent.Builder |
UserEvent.newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
UserEvent.Builder |
UserEvent.Builder.putAllAttributes(Map<String,CustomAttribute> values)
Extra user event features to include in the recommendation model.
|
UserEvent.Builder |
UserEvent.Builder.putAttributes(String key,
CustomAttribute value)
Extra user event features to include in the recommendation model.
|
UserEvent.Builder |
UserEvent.Builder.removeAttributes(String key)
Extra user event features to include in the recommendation model.
|
UserEvent.Builder |
UserEvent.Builder.removeDocuments(int index)
List of [Document][google.cloud.discoveryengine.v1beta.Document]s
associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.setAttributionToken(String value)
Token to attribute an API response to user action(s) to trigger the event.
|
UserEvent.Builder |
UserEvent.Builder.setAttributionTokenBytes(com.google.protobuf.ByteString value)
Token to attribute an API response to user action(s) to trigger the event.
|
UserEvent.Builder |
UserEvent.Builder.setCompletionInfo(CompletionInfo.Builder builderForValue)
[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery]
details related to the event.
|
UserEvent.Builder |
UserEvent.Builder.setCompletionInfo(CompletionInfo value)
[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery]
details related to the event.
|
UserEvent.Builder |
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.v1beta.UserInfo.user_agent]
can be populated from the HTTP request.
|
UserEvent.Builder |
UserEvent.Builder.setDocuments(int index,
DocumentInfo.Builder builderForValue)
List of [Document][google.cloud.discoveryengine.v1beta.Document]s
associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.setDocuments(int index,
DocumentInfo value)
List of [Document][google.cloud.discoveryengine.v1beta.Document]s
associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.setEventTime(com.google.protobuf.Timestamp.Builder builderForValue)
Only required for
[UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents]
method.
|
UserEvent.Builder |
UserEvent.Builder.setEventTime(com.google.protobuf.Timestamp value)
Only required for
[UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents]
method.
|
UserEvent.Builder |
UserEvent.Builder.setEventType(String value)
Required.
|
UserEvent.Builder |
UserEvent.Builder.setEventTypeBytes(com.google.protobuf.ByteString value)
Required.
|
UserEvent.Builder |
UserEvent.Builder.setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
UserEvent.Builder |
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 |
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 |
UserEvent.Builder.setMediaInfo(MediaInfo.Builder builderForValue)
Media-specific info.
|
UserEvent.Builder |
UserEvent.Builder.setMediaInfo(MediaInfo value)
Media-specific info.
|
UserEvent.Builder |
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 |
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 |
UserEvent.Builder.setPanel(PanelInfo.Builder builderForValue)
Panel metadata associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.setPanel(PanelInfo value)
Panel metadata associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.setPromotionIds(int index,
String value)
The promotion IDs if this is an event associated with promotions.
|
UserEvent.Builder |
UserEvent.Builder.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
UserEvent.Builder |
UserEvent.Builder.setSearchInfo(SearchInfo.Builder builderForValue)
[SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
details related to the event.
|
UserEvent.Builder |
UserEvent.Builder.setSearchInfo(SearchInfo value)
[SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
details related to the event.
|
UserEvent.Builder |
UserEvent.Builder.setSessionId(String value)
A unique identifier for tracking a visitor session with a length limit of
128 bytes.
|
UserEvent.Builder |
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 |
UserEvent.Builder.setTagIds(int index,
String value)
A list of identifiers for the independent experiment groups this user event
belongs to.
|
UserEvent.Builder |
UserEvent.Builder.setTransactionInfo(TransactionInfo.Builder builderForValue)
The transaction metadata (if any) associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.setTransactionInfo(TransactionInfo value)
The transaction metadata (if any) associated with this user event.
|
UserEvent.Builder |
UserEvent.Builder.setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
UserEvent.Builder |
UserEvent.Builder.setUserInfo(UserInfo.Builder builderForValue)
Information about the end user.
|
UserEvent.Builder |
UserEvent.Builder.setUserInfo(UserInfo value)
Information about the end user.
|
UserEvent.Builder |
UserEvent.Builder.setUserPseudoId(String value)
Required.
|
UserEvent.Builder |
UserEvent.Builder.setUserPseudoIdBytes(com.google.protobuf.ByteString value)
Required.
|
UserEvent.Builder |
UserEvent.toBuilder() |
| Modifier and Type | Method and Description |
|---|---|
List<UserEvent.Builder> |
ImportUserEventsRequest.InlineSource.Builder.getUserEventsBuilderList()
Required.
|
| Modifier and Type | Method and Description |
|---|---|
ImportUserEventsRequest.InlineSource.Builder |
ImportUserEventsRequest.InlineSource.Builder.addUserEvents(int index,
UserEvent.Builder builderForValue)
Required.
|
ImportUserEventsRequest.InlineSource.Builder |
ImportUserEventsRequest.InlineSource.Builder.addUserEvents(UserEvent.Builder builderForValue)
Required.
|
RecommendRequest.Builder |
RecommendRequest.Builder.setUserEvent(UserEvent.Builder builderForValue)
Required.
|
WriteUserEventRequest.Builder |
WriteUserEventRequest.Builder.setUserEvent(UserEvent.Builder builderForValue)
Required.
|
ImportUserEventsRequest.InlineSource.Builder |
ImportUserEventsRequest.InlineSource.Builder.setUserEvents(int index,
UserEvent.Builder builderForValue)
Required.
|
Copyright © 2024 Google LLC. All rights reserved.