Recommendations AI V1beta1 API - Class Google::Cloud::RecommendationEngine::V1beta1::ListUserEventsRequest (v0.8.2)

Reference documentation and code samples for the Recommendations AI V1beta1 API class Google::Cloud::RecommendationEngine::V1beta1::ListUserEventsRequest.

Request message for ListUserEvents method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) —

    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

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) —

    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
Returns
  • (::String) —

    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

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.
Returns
  • (::Integer) — Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.

#page_token

def page_token() -> ::String
Returns
  • (::String) — Optional. The previous ListUserEventsResponse.next_page_token.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — Optional. The previous ListUserEventsResponse.next_page_token.
Returns
  • (::String) — Optional. The previous ListUserEventsResponse.next_page_token.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent eventStore resource name, such as projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent eventStore resource name, such as projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store.
Returns
  • (::String) — Required. The parent eventStore resource name, such as projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store.