Package com.google.cloud.discoveryengine.v1beta

Class UserEvent

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.UserEvent
All Implemented Interfaces:
UserEventOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class UserEvent extends com.google.protobuf.GeneratedMessage implements UserEventOrBuilder
 UserEvent captures all metadata information Discovery Engine API needs to
 know about how end users interact with your website.
Protobuf type google.cloud.discoveryengine.v1beta.UserEvent
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    UserEvent.Builder
    UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ATTRIBUTES_FIELD_NUMBER
     
    static final int
    ATTRIBUTION_TOKEN_FIELD_NUMBER
     
    static final int
    COMPLETION_INFO_FIELD_NUMBER
     
    static final int
    DATA_STORE_FIELD_NUMBER
     
    static final int
    DIRECT_USER_REQUEST_FIELD_NUMBER
     
    static final int
    DOCUMENTS_FIELD_NUMBER
     
    static final int
    ENGINE_FIELD_NUMBER
     
    static final int
    EVENT_TIME_FIELD_NUMBER
     
    static final int
    EVENT_TYPE_FIELD_NUMBER
     
    static final int
    FILTER_FIELD_NUMBER
     
    static final int
    MEDIA_INFO_FIELD_NUMBER
     
    static final int
    PAGE_INFO_FIELD_NUMBER
     
    static final int
    PANEL_FIELD_NUMBER
     
    static final int
    PANELS_FIELD_NUMBER
     
    static final int
    PROMOTION_IDS_FIELD_NUMBER
     
    static final int
    SEARCH_INFO_FIELD_NUMBER
     
    static final int
    SESSION_ID_FIELD_NUMBER
     
    static final int
    TAG_IDS_FIELD_NUMBER
     
    static final int
    TRANSACTION_INFO_FIELD_NUMBER
     
    static final int
    USER_INFO_FIELD_NUMBER
     
    static final int
    USER_PSEUDO_ID_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsAttributes(String key)
    Extra user event features to include in the recommendation model.
    boolean
    equals(Object obj)
     
    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.v1beta.CompletionService.CompleteQuery] details related to the event.
    CompletionInfoOrBuilder
    getCompletionInfoOrBuilder()
    [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] details related to the event.
    String
    getDataStore()
    The [DataStore][google.cloud.discoveryengine.v1beta.DataStore] resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
    com.google.protobuf.ByteString
    getDataStoreBytes()
    The [DataStore][google.cloud.discoveryengine.v1beta.DataStore] resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
    static UserEvent
    getDefaultInstance()
     
    UserEvent
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.v1beta.UserInfo.user_agent] can be populated from the HTTP request.
    DocumentInfo
    getDocuments(int index)
    List of [Document][google.cloud.discoveryengine.v1beta.Document]s associated with this user event.
    int
    getDocumentsCount()
    List of [Document][google.cloud.discoveryengine.v1beta.Document]s associated with this user event.
    List<DocumentInfo>
    getDocumentsList()
    List of [Document][google.cloud.discoveryengine.v1beta.Document]s associated with this user event.
    DocumentInfoOrBuilder
    getDocumentsOrBuilder(int index)
    List of [Document][google.cloud.discoveryengine.v1beta.Document]s associated with this user event.
    List<? extends DocumentInfoOrBuilder>
    getDocumentsOrBuilderList()
    List of [Document][google.cloud.discoveryengine.v1beta.Document]s associated with this user event.
    String
    getEngine()
    The [Engine][google.cloud.discoveryengine.v1beta.Engine] resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
    com.google.protobuf.ByteString
    getEngineBytes()
    The [Engine][google.cloud.discoveryengine.v1beta.Engine] resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
    com.google.protobuf.Timestamp
    getEventTime()
    Only required for [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents] method.
    com.google.protobuf.TimestampOrBuilder
    getEventTimeOrBuilder()
    Only required for [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.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.
    MediaInfoOrBuilder
    getMediaInfoOrBuilder()
    Media-specific info.
    PageInfo
    getPageInfo()
    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.
    PanelInfoOrBuilder
    getPanelOrBuilder()
    Panel metadata associated with this user event.
    PanelInfo
    getPanels(int index)
    Optional.
    int
    getPanelsCount()
    Optional.
    List<PanelInfo>
    getPanelsList()
    Optional.
    PanelInfoOrBuilder
    getPanelsOrBuilder(int index)
    Optional.
    List<? extends PanelInfoOrBuilder>
    getPanelsOrBuilderList()
    Optional.
    com.google.protobuf.Parser<UserEvent>
    getParserForType()
     
    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.v1beta.SearchService.Search] details related to the event.
    SearchInfoOrBuilder
    getSearchInfoOrBuilder()
    [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] details related to the event.
    int
    getSerializedSize()
     
    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.
    TransactionInfoOrBuilder
    getTransactionInfoOrBuilder()
    The transaction metadata (if any) associated with this user event.
    UserInfo
    getUserInfo()
    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.v1beta.CompletionService.CompleteQuery] details related to the event.
    boolean
    hasEventTime()
    Only required for [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents] method.
    int
    hashCode()
     
    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.v1beta.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.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static UserEvent.Builder
    newBuilder()
     
    static UserEvent.Builder
    newBuilder(UserEvent prototype)
     
    UserEvent.Builder
    newBuilderForType()
     
    protected UserEvent.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static UserEvent
    parseDelimitedFrom(InputStream input)
     
    static UserEvent
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UserEvent
    parseFrom(byte[] data)
     
    static UserEvent
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UserEvent
    parseFrom(com.google.protobuf.ByteString data)
     
    static UserEvent
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UserEvent
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static UserEvent
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UserEvent
    parseFrom(InputStream input)
     
    static UserEvent
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UserEvent
    parseFrom(ByteBuffer data)
     
    static UserEvent
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<UserEvent>
    parser()
     
    UserEvent.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • EVENT_TYPE_FIELD_NUMBER

      public static final int EVENT_TYPE_FIELD_NUMBER
      See Also:

    • USER_PSEUDO_ID_FIELD_NUMBER

      public static final int USER_PSEUDO_ID_FIELD_NUMBER
      See Also:

    • ENGINE_FIELD_NUMBER

      public static final int ENGINE_FIELD_NUMBER
      See Also:

    • DATA_STORE_FIELD_NUMBER

      public static final int DATA_STORE_FIELD_NUMBER
      See Also:

    • EVENT_TIME_FIELD_NUMBER

      public static final int EVENT_TIME_FIELD_NUMBER
      See Also:

    • USER_INFO_FIELD_NUMBER

      public static final int USER_INFO_FIELD_NUMBER
      See Also:

    • DIRECT_USER_REQUEST_FIELD_NUMBER

      public static final int DIRECT_USER_REQUEST_FIELD_NUMBER
      See Also:

    • SESSION_ID_FIELD_NUMBER

      public static final int SESSION_ID_FIELD_NUMBER
      See Also:

    • PAGE_INFO_FIELD_NUMBER

      public static final int PAGE_INFO_FIELD_NUMBER
      See Also:

    • ATTRIBUTION_TOKEN_FIELD_NUMBER

      public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER
      See Also:

    • FILTER_FIELD_NUMBER

      public static final int FILTER_FIELD_NUMBER
      See Also:

    • DOCUMENTS_FIELD_NUMBER

      public static final int DOCUMENTS_FIELD_NUMBER
      See Also:

    • PANEL_FIELD_NUMBER

      public static final int PANEL_FIELD_NUMBER
      See Also:

    • SEARCH_INFO_FIELD_NUMBER

      public static final int SEARCH_INFO_FIELD_NUMBER
      See Also:

    • COMPLETION_INFO_FIELD_NUMBER

      public static final int COMPLETION_INFO_FIELD_NUMBER
      See Also:

    • TRANSACTION_INFO_FIELD_NUMBER

      public static final int TRANSACTION_INFO_FIELD_NUMBER
      See Also:

    • TAG_IDS_FIELD_NUMBER

      public static final int TAG_IDS_FIELD_NUMBER
      See Also:

    • PROMOTION_IDS_FIELD_NUMBER

      public static final int PROMOTION_IDS_FIELD_NUMBER
      See Also:

    • ATTRIBUTES_FIELD_NUMBER

      public static final int ATTRIBUTES_FIELD_NUMBER
      See Also:

    • MEDIA_INFO_FIELD_NUMBER

      public static final int MEDIA_INFO_FIELD_NUMBER
      See Also:

    • PANELS_FIELD_NUMBER

      public static final int PANELS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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
 * `add-feedback`: Add a user feedback.

 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
 * `add-feedback`: Add a user feedback.

 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.

    • 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.

    • getEngine

      public String getEngine()
       The [Engine][google.cloud.discoveryengine.v1beta.Engine] resource name, in
 the form of
 `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.

 Optional. Only required for
 [Engine][google.cloud.discoveryengine.v1beta.Engine] produced user events.
 For example, user events from blended search.
      string engine = 19 [(.google.api.resource_reference) = { ... }
      Specified by:
      getEngine in interface UserEventOrBuilder
      Returns:
      The engine.

    • getEngineBytes

      public com.google.protobuf.ByteString getEngineBytes()
       The [Engine][google.cloud.discoveryengine.v1beta.Engine] resource name, in
 the form of
 `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.

 Optional. Only required for
 [Engine][google.cloud.discoveryengine.v1beta.Engine] produced user events.
 For example, user events from blended search.
      string engine = 19 [(.google.api.resource_reference) = { ... }
      Specified by:
      getEngineBytes in interface UserEventOrBuilder
      Returns:
      The bytes for engine.

    • getDataStore

      public String getDataStore()
       The [DataStore][google.cloud.discoveryengine.v1beta.DataStore] resource
 full name, of the form
 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.

 Optional. Only required for user events whose data store can't by
 determined by
 [UserEvent.engine][google.cloud.discoveryengine.v1beta.UserEvent.engine] or
 [UserEvent.documents][google.cloud.discoveryengine.v1beta.UserEvent.documents].
 If data store is set in the parent of write/import/collect user event
 requests, this field can be omitted.
      string data_store = 20 [(.google.api.resource_reference) = { ... }
      Specified by:
      getDataStore in interface UserEventOrBuilder
      Returns:
      The dataStore.

    • getDataStoreBytes

      public com.google.protobuf.ByteString getDataStoreBytes()
       The [DataStore][google.cloud.discoveryengine.v1beta.DataStore] resource
 full name, of the form
 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.

 Optional. Only required for user events whose data store can't by
 determined by
 [UserEvent.engine][google.cloud.discoveryengine.v1beta.UserEvent.engine] or
 [UserEvent.documents][google.cloud.discoveryengine.v1beta.UserEvent.documents].
 If data store is set in the parent of write/import/collect user event
 requests, this field can be omitted.
      string data_store = 20 [(.google.api.resource_reference) = { ... }
      Specified by:
      getDataStoreBytes in interface UserEventOrBuilder
      Returns:
      The bytes for dataStore.

    • hasEventTime

      public boolean hasEventTime()
       Only required for
 [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.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.v1beta.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.

    • getEventTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getEventTimeOrBuilder()
       Only required for
 [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.UserInfo user_info = 4;
      Specified by:
      getUserInfo in interface UserEventOrBuilder
      Returns:
      The userInfo.

    • getUserInfoOrBuilder

      public UserInfoOrBuilder getUserInfoOrBuilder()
       Information about the end user.
      .google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.UserEventService.CollectUserEvent].
      bool direct_user_request = 5;
      Specified by:
      getDirectUserRequest in interface UserEventOrBuilder
      Returns:
      The directUserRequest.

    • 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.v1beta.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.v1beta.UserEvent.user_pseudo_id]
 as prefix.
      string session_id = 6;
      Specified by:
      getSessionIdBytes in interface UserEventOrBuilder
      Returns:
      The bytes for sessionId.

    • 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.v1beta.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.v1beta.PageInfo page_info = 7;
      Specified by:
      getPageInfo in interface UserEventOrBuilder
      Returns:
      The pageInfo.

    • 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.v1beta.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][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
 This field enables accurate attribution of recommendation model
 performance.

 The value must be one of:

 * [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1beta.RecommendResponse.attribution_token] for events that are the result of
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
 * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] for events that are the result of
 [SearchService.Search][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
 This field enables accurate attribution of recommendation model
 performance.

 The value must be one of:

 * [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1beta.RecommendResponse.attribution_token] for events that are the result of
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
 * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] for events that are the result of
 [SearchService.Search][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.RecommendResponse.attribution_token]
 to this field.
      string attribution_token = 8;
      Specified by:
      getAttributionTokenBytes in interface UserEventOrBuilder
      Returns:
      The bytes for attributionToken.

    • 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.v1beta.SearchRequest] may
 contain a filter expression in
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
 conforming to https://google.aip.dev/160#filtering.

 Similarly, for `view-item-list` events that are generated from a
 [RecommendRequest][google.cloud.discoveryengine.v1beta.RecommendRequest],
 this field may be populated directly from
 [RecommendRequest.filter][google.cloud.discoveryengine.v1beta.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.v1beta.SearchRequest] may
 contain a filter expression in
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
 conforming to https://google.aip.dev/160#filtering.

 Similarly, for `view-item-list` events that are generated from a
 [RecommendRequest][google.cloud.discoveryengine.v1beta.RecommendRequest],
 this field may be populated directly from
 [RecommendRequest.filter][google.cloud.discoveryengine.v1beta.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.

    • getDocumentsList

      public List<DocumentInfo> getDocumentsList()
       List of [Document][google.cloud.discoveryengine.v1beta.Document]s
 associated with this user event.

 This field is optional except for the following event types:

 * `view-item`
 * `add-to-cart`
 * `purchase`
 * `media-play`
 * `media-complete`

 In a `search` event, this field represents the documents returned to the
 end user on the current page (the end user may have not finished browsing
 the whole page yet). When a new page is returned to the end user, after
 pagination/filtering/ordering even for the same query, a new `search` event
 with different
 [UserEvent.documents][google.cloud.discoveryengine.v1beta.UserEvent.documents]
 is desired.
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 10;
      Specified by:
      getDocumentsList in interface UserEventOrBuilder

    • getDocumentsOrBuilderList

      public List<? extends DocumentInfoOrBuilder> getDocumentsOrBuilderList()
       List of [Document][google.cloud.discoveryengine.v1beta.Document]s
 associated with this user event.

 This field is optional except for the following event types:

 * `view-item`
 * `add-to-cart`
 * `purchase`
 * `media-play`
 * `media-complete`

 In a `search` event, this field represents the documents returned to the
 end user on the current page (the end user may have not finished browsing
 the whole page yet). When a new page is returned to the end user, after
 pagination/filtering/ordering even for the same query, a new `search` event
 with different
 [UserEvent.documents][google.cloud.discoveryengine.v1beta.UserEvent.documents]
 is desired.
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 10;
      Specified by:
      getDocumentsOrBuilderList in interface UserEventOrBuilder

    • getDocumentsCount

      public int getDocumentsCount()
       List of [Document][google.cloud.discoveryengine.v1beta.Document]s
 associated with this user event.

 This field is optional except for the following event types:

 * `view-item`
 * `add-to-cart`
 * `purchase`
 * `media-play`
 * `media-complete`

 In a `search` event, this field represents the documents returned to the
 end user on the current page (the end user may have not finished browsing
 the whole page yet). When a new page is returned to the end user, after
 pagination/filtering/ordering even for the same query, a new `search` event
 with different
 [UserEvent.documents][google.cloud.discoveryengine.v1beta.UserEvent.documents]
 is desired.
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 10;
      Specified by:
      getDocumentsCount in interface UserEventOrBuilder

    • getDocuments

      public DocumentInfo getDocuments(int index)
       List of [Document][google.cloud.discoveryengine.v1beta.Document]s
 associated with this user event.

 This field is optional except for the following event types:

 * `view-item`
 * `add-to-cart`
 * `purchase`
 * `media-play`
 * `media-complete`

 In a `search` event, this field represents the documents returned to the
 end user on the current page (the end user may have not finished browsing
 the whole page yet). When a new page is returned to the end user, after
 pagination/filtering/ordering even for the same query, a new `search` event
 with different
 [UserEvent.documents][google.cloud.discoveryengine.v1beta.UserEvent.documents]
 is desired.
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 10;
      Specified by:
      getDocuments in interface UserEventOrBuilder

    • getDocumentsOrBuilder

      public DocumentInfoOrBuilder getDocumentsOrBuilder(int index)
       List of [Document][google.cloud.discoveryengine.v1beta.Document]s
 associated with this user event.

 This field is optional except for the following event types:

 * `view-item`
 * `add-to-cart`
 * `purchase`
 * `media-play`
 * `media-complete`

 In a `search` event, this field represents the documents returned to the
 end user on the current page (the end user may have not finished browsing
 the whole page yet). When a new page is returned to the end user, after
 pagination/filtering/ordering even for the same query, a new `search` event
 with different
 [UserEvent.documents][google.cloud.discoveryengine.v1beta.UserEvent.documents]
 is desired.
      repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 10;
      Specified by:
      getDocumentsOrBuilder in interface UserEventOrBuilder

    • hasPanel

      public boolean hasPanel()
       Panel metadata associated with this user event.
      .google.cloud.discoveryengine.v1beta.PanelInfo panel = 11;
      Specified by:
      hasPanel in interface UserEventOrBuilder
      Returns:
      Whether the panel field is set.

    • getPanel

      public PanelInfo getPanel()
       Panel metadata associated with this user event.
      .google.cloud.discoveryengine.v1beta.PanelInfo panel = 11;
      Specified by:
      getPanel in interface UserEventOrBuilder
      Returns:
      The panel.

    • getPanelOrBuilder

      public PanelInfoOrBuilder getPanelOrBuilder()
       Panel metadata associated with this user event.
      .google.cloud.discoveryengine.v1beta.PanelInfo panel = 11;
      Specified by:
      getPanelOrBuilder in interface UserEventOrBuilder

    • hasSearchInfo

      public boolean hasSearchInfo()
       [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 details related to the event.

 This field should be set for `search` event.
      .google.cloud.discoveryengine.v1beta.SearchInfo search_info = 12;
      Specified by:
      hasSearchInfo in interface UserEventOrBuilder
      Returns:
      Whether the searchInfo field is set.

    • getSearchInfo

      public SearchInfo getSearchInfo()
       [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 details related to the event.

 This field should be set for `search` event.
      .google.cloud.discoveryengine.v1beta.SearchInfo search_info = 12;
      Specified by:
      getSearchInfo in interface UserEventOrBuilder
      Returns:
      The searchInfo.

    • getSearchInfoOrBuilder

      public SearchInfoOrBuilder getSearchInfoOrBuilder()
       [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 details related to the event.

 This field should be set for `search` event.
      .google.cloud.discoveryengine.v1beta.SearchInfo search_info = 12;
      Specified by:
      getSearchInfoOrBuilder in interface UserEventOrBuilder

    • hasCompletionInfo

      public boolean hasCompletionInfo()
       [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery]
 details related to the event.

 This field should be set for `search` event when autocomplete function is
 enabled and the user clicks a suggestion for search.
      .google.cloud.discoveryengine.v1beta.CompletionInfo completion_info = 13;
      Specified by:
      hasCompletionInfo in interface UserEventOrBuilder
      Returns:
      Whether the completionInfo field is set.

    • getCompletionInfo

      public CompletionInfo getCompletionInfo()
       [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery]
 details related to the event.

 This field should be set for `search` event when autocomplete function is
 enabled and the user clicks a suggestion for search.
      .google.cloud.discoveryengine.v1beta.CompletionInfo completion_info = 13;
      Specified by:
      getCompletionInfo in interface UserEventOrBuilder
      Returns:
      The completionInfo.

    • getCompletionInfoOrBuilder

      public CompletionInfoOrBuilder getCompletionInfoOrBuilder()
       [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery]
 details related to the event.

 This field should be set for `search` event when autocomplete function is
 enabled and the user clicks a suggestion for search.
      .google.cloud.discoveryengine.v1beta.CompletionInfo completion_info = 13;
      Specified by:
      getCompletionInfoOrBuilder in interface UserEventOrBuilder

    • hasTransactionInfo

      public boolean hasTransactionInfo()
       The transaction metadata (if any) associated with this user event.
      .google.cloud.discoveryengine.v1beta.TransactionInfo transaction_info = 14;
      Specified by:
      hasTransactionInfo in interface UserEventOrBuilder
      Returns:
      Whether the transactionInfo field is set.

    • getTransactionInfo

      public TransactionInfo getTransactionInfo()
       The transaction metadata (if any) associated with this user event.
      .google.cloud.discoveryengine.v1beta.TransactionInfo transaction_info = 14;
      Specified by:
      getTransactionInfo in interface UserEventOrBuilder
      Returns:
      The transactionInfo.

    • getTransactionInfoOrBuilder

      public TransactionInfoOrBuilder getTransactionInfoOrBuilder()
       The transaction metadata (if any) associated with this user event.
      .google.cloud.discoveryengine.v1beta.TransactionInfo transaction_info = 14;
      Specified by:
      getTransactionInfoOrBuilder in interface UserEventOrBuilder

    • getTagIdsList

      public com.google.protobuf.ProtocolStringList getTagIdsList()
       A list of identifiers for the independent experiment groups this user event
 belongs to. This is used to distinguish between user events associated with
 different experiment setups.
      repeated string tag_ids = 15;
      Specified by:
      getTagIdsList in interface UserEventOrBuilder
      Returns:
      A list containing the tagIds.

    • getTagIdsCount

      public int getTagIdsCount()
       A list of identifiers for the independent experiment groups this user event
 belongs to. This is used to distinguish between user events associated with
 different experiment setups.
      repeated string tag_ids = 15;
      Specified by:
      getTagIdsCount in interface UserEventOrBuilder
      Returns:
      The count of tagIds.

    • getTagIds

      public String getTagIds(int index)
       A list of identifiers for the independent experiment groups this user event
 belongs to. This is used to distinguish between user events associated with
 different experiment setups.
      repeated string tag_ids = 15;
      Specified by:
      getTagIds in interface UserEventOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The tagIds at the given index.

    • getTagIdsBytes

      public com.google.protobuf.ByteString getTagIdsBytes(int index)
       A list of identifiers for the independent experiment groups this user event
 belongs to. This is used to distinguish between user events associated with
 different experiment setups.
      repeated string tag_ids = 15;
      Specified by:
      getTagIdsBytes in interface UserEventOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tagIds at the given index.

    • getPromotionIdsList

      public com.google.protobuf.ProtocolStringList getPromotionIdsList()
       The promotion IDs if this is an event associated with promotions.
 Currently, this field is restricted to at most one ID.
      repeated string promotion_ids = 16;
      Specified by:
      getPromotionIdsList in interface UserEventOrBuilder
      Returns:
      A list containing the promotionIds.

    • getPromotionIdsCount

      public int getPromotionIdsCount()
       The promotion IDs if this is an event associated with promotions.
 Currently, this field is restricted to at most one ID.
      repeated string promotion_ids = 16;
      Specified by:
      getPromotionIdsCount in interface UserEventOrBuilder
      Returns:
      The count of promotionIds.

    • getPromotionIds

      public String getPromotionIds(int index)
       The promotion IDs if this is an event associated with promotions.
 Currently, this field is restricted to at most one ID.
      repeated string promotion_ids = 16;
      Specified by:
      getPromotionIds in interface UserEventOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The promotionIds at the given index.

    • getPromotionIdsBytes

      public com.google.protobuf.ByteString getPromotionIdsBytes(int index)
       The promotion IDs if this is an event associated with promotions.
 Currently, this field is restricted to at most one ID.
      repeated string promotion_ids = 16;
      Specified by:
      getPromotionIdsBytes in interface UserEventOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the promotionIds at the given index.

    • getAttributesCount

      public int getAttributesCount()
      Description copied from interface: UserEventOrBuilder
       Extra user event features to include in the recommendation model.
 These attributes must NOT contain data that needs to be parsed or processed
 further, e.g. JSON or other encodings.

 If you provide custom attributes for ingested user events, also include
 them in the user events that you associate with prediction requests. Custom
 attribute formatting must be consistent between imported events and events
 provided with prediction requests. This lets the Discovery Engine API use
 those custom attributes when training models and serving predictions, which
 helps improve recommendation quality.

 This field needs to pass all below criteria, otherwise an
 `INVALID_ARGUMENT` error is returned:

 * The key must be a UTF-8 encoded string with a length limit of 5,000
 characters.
 * For text attributes, at most 400 values are allowed. Empty values are not
 allowed. Each value must be a UTF-8 encoded string with a length limit of
 256 characters.
 * For number attributes, at most 400 values are allowed.

 For product recommendations, an example of extra user information is
 `traffic_channel`, which is how a user arrives at the site. Users can
 arrive
 at the site by coming to the site directly, coming through Google
 search, or in other ways.
      map<string, .google.cloud.discoveryengine.v1beta.CustomAttribute> attributes = 17;
      Specified by:
      getAttributesCount in interface UserEventOrBuilder

    • containsAttributes

      public boolean containsAttributes(String key)
       Extra user event features to include in the recommendation model.
 These attributes must NOT contain data that needs to be parsed or processed
 further, e.g. JSON or other encodings.

 If you provide custom attributes for ingested user events, also include
 them in the user events that you associate with prediction requests. Custom
 attribute formatting must be consistent between imported events and events
 provided with prediction requests. This lets the Discovery Engine API use
 those custom attributes when training models and serving predictions, which
 helps improve recommendation quality.

 This field needs to pass all below criteria, otherwise an
 `INVALID_ARGUMENT` error is returned:

 * The key must be a UTF-8 encoded string with a length limit of 5,000
 characters.
 * For text attributes, at most 400 values are allowed. Empty values are not
 allowed. Each value must be a UTF-8 encoded string with a length limit of
 256 characters.
 * For number attributes, at most 400 values are allowed.

 For product recommendations, an example of extra user information is
 `traffic_channel`, which is how a user arrives at the site. Users can
 arrive
 at the site by coming to the site directly, coming through Google
 search, or in other ways.
      map<string, .google.cloud.discoveryengine.v1beta.CustomAttribute> attributes = 17;
      Specified by:
      containsAttributes in interface UserEventOrBuilder

    • getAttributes

      @Deprecated public Map<String,CustomAttribute> getAttributes()
      Deprecated.
      Use getAttributesMap() instead.
      Specified by:
      getAttributes in interface UserEventOrBuilder

    • getAttributesMap

      public Map<String,CustomAttribute> getAttributesMap()
       Extra user event features to include in the recommendation model.
 These attributes must NOT contain data that needs to be parsed or processed
 further, e.g. JSON or other encodings.

 If you provide custom attributes for ingested user events, also include
 them in the user events that you associate with prediction requests. Custom
 attribute formatting must be consistent between imported events and events
 provided with prediction requests. This lets the Discovery Engine API use
 those custom attributes when training models and serving predictions, which
 helps improve recommendation quality.

 This field needs to pass all below criteria, otherwise an
 `INVALID_ARGUMENT` error is returned:

 * The key must be a UTF-8 encoded string with a length limit of 5,000
 characters.
 * For text attributes, at most 400 values are allowed. Empty values are not
 allowed. Each value must be a UTF-8 encoded string with a length limit of
 256 characters.
 * For number attributes, at most 400 values are allowed.

 For product recommendations, an example of extra user information is
 `traffic_channel`, which is how a user arrives at the site. Users can
 arrive
 at the site by coming to the site directly, coming through Google
 search, or in other ways.
      map<string, .google.cloud.discoveryengine.v1beta.CustomAttribute> attributes = 17;
      Specified by:
      getAttributesMap in interface UserEventOrBuilder

    • getAttributesOrDefault

      public CustomAttribute getAttributesOrDefault(String key, CustomAttribute defaultValue)
       Extra user event features to include in the recommendation model.
 These attributes must NOT contain data that needs to be parsed or processed
 further, e.g. JSON or other encodings.

 If you provide custom attributes for ingested user events, also include
 them in the user events that you associate with prediction requests. Custom
 attribute formatting must be consistent between imported events and events
 provided with prediction requests. This lets the Discovery Engine API use
 those custom attributes when training models and serving predictions, which
 helps improve recommendation quality.

 This field needs to pass all below criteria, otherwise an
 `INVALID_ARGUMENT` error is returned:

 * The key must be a UTF-8 encoded string with a length limit of 5,000
 characters.
 * For text attributes, at most 400 values are allowed. Empty values are not
 allowed. Each value must be a UTF-8 encoded string with a length limit of
 256 characters.
 * For number attributes, at most 400 values are allowed.

 For product recommendations, an example of extra user information is
 `traffic_channel`, which is how a user arrives at the site. Users can
 arrive
 at the site by coming to the site directly, coming through Google
 search, or in other ways.
      map<string, .google.cloud.discoveryengine.v1beta.CustomAttribute> attributes = 17;
      Specified by:
      getAttributesOrDefault in interface UserEventOrBuilder

    • getAttributesOrThrow

      public CustomAttribute getAttributesOrThrow(String key)
       Extra user event features to include in the recommendation model.
 These attributes must NOT contain data that needs to be parsed or processed
 further, e.g. JSON or other encodings.

 If you provide custom attributes for ingested user events, also include
 them in the user events that you associate with prediction requests. Custom
 attribute formatting must be consistent between imported events and events
 provided with prediction requests. This lets the Discovery Engine API use
 those custom attributes when training models and serving predictions, which
 helps improve recommendation quality.

 This field needs to pass all below criteria, otherwise an
 `INVALID_ARGUMENT` error is returned:

 * The key must be a UTF-8 encoded string with a length limit of 5,000
 characters.
 * For text attributes, at most 400 values are allowed. Empty values are not
 allowed. Each value must be a UTF-8 encoded string with a length limit of
 256 characters.
 * For number attributes, at most 400 values are allowed.

 For product recommendations, an example of extra user information is
 `traffic_channel`, which is how a user arrives at the site. Users can
 arrive
 at the site by coming to the site directly, coming through Google
 search, or in other ways.
      map<string, .google.cloud.discoveryengine.v1beta.CustomAttribute> attributes = 17;
      Specified by:
      getAttributesOrThrow in interface UserEventOrBuilder

    • hasMediaInfo

      public boolean hasMediaInfo()
       Media-specific info.
      .google.cloud.discoveryengine.v1beta.MediaInfo media_info = 18;
      Specified by:
      hasMediaInfo in interface UserEventOrBuilder
      Returns:
      Whether the mediaInfo field is set.

    • getMediaInfo

      public MediaInfo getMediaInfo()
       Media-specific info.
      .google.cloud.discoveryengine.v1beta.MediaInfo media_info = 18;
      Specified by:
      getMediaInfo in interface UserEventOrBuilder
      Returns:
      The mediaInfo.

    • getMediaInfoOrBuilder

      public MediaInfoOrBuilder getMediaInfoOrBuilder()
       Media-specific info.
      .google.cloud.discoveryengine.v1beta.MediaInfo media_info = 18;
      Specified by:
      getMediaInfoOrBuilder in interface UserEventOrBuilder

    • getPanelsList

      public List<PanelInfo> getPanelsList()
       Optional. List of panels associated with this event.
 Used for page-level impression data.
      repeated .google.cloud.discoveryengine.v1beta.PanelInfo panels = 22 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPanelsList in interface UserEventOrBuilder

    • getPanelsOrBuilderList

      public List<? extends PanelInfoOrBuilder> getPanelsOrBuilderList()
       Optional. List of panels associated with this event.
 Used for page-level impression data.
      repeated .google.cloud.discoveryengine.v1beta.PanelInfo panels = 22 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPanelsOrBuilderList in interface UserEventOrBuilder

    • getPanelsCount

      public int getPanelsCount()
       Optional. List of panels associated with this event.
 Used for page-level impression data.
      repeated .google.cloud.discoveryengine.v1beta.PanelInfo panels = 22 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPanelsCount in interface UserEventOrBuilder

    • getPanels

      public PanelInfo getPanels(int index)
       Optional. List of panels associated with this event.
 Used for page-level impression data.
      repeated .google.cloud.discoveryengine.v1beta.PanelInfo panels = 22 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPanels in interface UserEventOrBuilder

    • getPanelsOrBuilder

      public PanelInfoOrBuilder getPanelsOrBuilder(int index)
       Optional. List of panels associated with this event.
 Used for page-level impression data.
      repeated .google.cloud.discoveryengine.v1beta.PanelInfo panels = 22 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPanelsOrBuilder in interface UserEventOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static UserEvent parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserEvent parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserEvent parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserEvent parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserEvent parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserEvent parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserEvent parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UserEvent parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UserEvent parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UserEvent parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UserEvent parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UserEvent parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public UserEvent.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static UserEvent.Builder newBuilder()

    • newBuilder

      public static UserEvent.Builder newBuilder(UserEvent prototype)

    • toBuilder

      public UserEvent.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected UserEvent.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static UserEvent getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<UserEvent> parser()

    • getParserForType

      public com.google.protobuf.Parser<UserEvent> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public UserEvent getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder