Package com.google.cloud.recommendationengine.v1beta1

Class ListUserEventsRequest

  • All Implemented Interfaces:
    ListUserEventsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListUserEventsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListUserEventsRequestOrBuilder
     Request message for ListUserEvents method.
    Protobuf type google.cloud.recommendationengine.v1beta1.ListUserEventsRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getParent

        public String getParent()
         Required. The parent eventStore resource name, such as
 `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListUserEventsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The parent eventStore resource name, such as
 `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListUserEventsRequestOrBuilder
        Returns:
        The bytes for parent.

      • getPageSize

        public int getPageSize()
         Optional. Maximum number of results to return per page. If zero, the
 service will choose a reasonable default.
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageSize in interface ListUserEventsRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public String getPageToken()
         Optional. The previous ListUserEventsResponse.next_page_token.
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageToken in interface ListUserEventsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Optional. The previous ListUserEventsResponse.next_page_token.
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageTokenBytes in interface ListUserEventsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • getFilter

        public String getFilter()
         Optional. Filtering expression to specify restrictions over
 returned events. This is a sequence of terms, where each term applies some
 kind of a restriction to the returned user events. Use this expression to
 restrict results to a specific time range, or filter events by eventType.
    eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems
    eventTime<"2012-04-23T18:25:43.511Z" eventType=search

   We expect only 3 types of fields:

    * eventTime: this can be specified a maximum of 2 times, once with a
      less than operator and once with a greater than operator. The
      eventTime restrict should result in one contiguous valid eventTime
      range.

    * eventType: only 1 eventType restriction can be specified.

    * eventsMissingCatalogItems: specififying this will restrict results
      to events for which catalog items were not found in the catalog. The
      default behavior is to return only those events for which catalog
      items were found.

   Some examples of valid filters expressions:

   * Example 1: eventTime > "2012-04-23T18:25:43.511Z"
             eventTime < "2012-04-23T18:30:43.511Z"
   * Example 2: eventTime > "2012-04-23T18:25:43.511Z"
             eventType = detail-page-view
   * Example 3: eventsMissingCatalogItems
             eventType = search eventTime < "2018-04-23T18:30:43.511Z"
   * Example 4: eventTime > "2012-04-23T18:25:43.511Z"
   * Example 5: eventType = search
   * Example 6: eventsMissingCatalogItems
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilter in interface ListUserEventsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Optional. Filtering expression to specify restrictions over
 returned events. This is a sequence of terms, where each term applies some
 kind of a restriction to the returned user events. Use this expression to
 restrict results to a specific time range, or filter events by eventType.
    eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems
    eventTime<"2012-04-23T18:25:43.511Z" eventType=search

   We expect only 3 types of fields:

    * eventTime: this can be specified a maximum of 2 times, once with a
      less than operator and once with a greater than operator. The
      eventTime restrict should result in one contiguous valid eventTime
      range.

    * eventType: only 1 eventType restriction can be specified.

    * eventsMissingCatalogItems: specififying this will restrict results
      to events for which catalog items were not found in the catalog. The
      default behavior is to return only those events for which catalog
      items were found.

   Some examples of valid filters expressions:

   * Example 1: eventTime > "2012-04-23T18:25:43.511Z"
             eventTime < "2012-04-23T18:30:43.511Z"
   * Example 2: eventTime > "2012-04-23T18:25:43.511Z"
             eventType = detail-page-view
   * Example 3: eventsMissingCatalogItems
             eventType = search eventTime < "2018-04-23T18:30:43.511Z"
   * Example 4: eventTime > "2012-04-23T18:25:43.511Z"
   * Example 5: eventType = search
   * Example 6: eventsMissingCatalogItems
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilterBytes in interface ListUserEventsRequestOrBuilder
        Returns:
        The bytes for filter.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 ListUserEventsRequest parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected ListUserEventsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ListUserEventsRequest> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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