Struct googapis::google::cloud::recommendationengine::v1beta1::ListUserEventsRequest [−][src]
pub struct ListUserEventsRequest {
pub parent: String,
pub page_size: i32,
pub page_token: String,
pub filter: String,
}
Expand description
Request message for ListUserEvents method.
Fields
parent: String
Required. The parent eventStore resource name, such as
projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store
.
page_size: i32
Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.
page_token: String
Optional. The previous ListUserEventsResponse.next_page_token.
filter: 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
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for ListUserEventsRequest
impl Send for ListUserEventsRequest
impl Sync for ListUserEventsRequest
impl Unpin for ListUserEventsRequest
impl UnwindSafe for ListUserEventsRequest
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more