Interface ListUserEventsRequestOrBuilder (0.44.0)

public interface ListUserEventsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract 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];

Returns
TypeDescription
String

The filter.

getFilterBytes()

public abstract 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];

Returns
TypeDescription
ByteString

The bytes for filter.

getPageSize()

public abstract 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];

Returns
TypeDescription
int

The pageSize.

getPageToken()

public abstract String getPageToken()

Optional. The previous ListUserEventsResponse.next_page_token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Optional. The previous ListUserEventsResponse.next_page_token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public abstract 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) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public abstract 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) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.