Struct google_recommendationengine1_beta1::api::ProjectLocationCatalogEventStoreUserEventListCall
source · pub struct ProjectLocationCatalogEventStoreUserEventListCall<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event.
A builder for the locations.catalogs.eventStores.userEvents.list method supported by a project resource.
It is not used directly, but through a ProjectMethods
instance.
§Example
Instantiate a resource method builder
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().locations_catalogs_event_stores_user_events_list("parent")
.page_token("ipsum")
.page_size(-50)
.filter("est")
.doit().await;
Implementations§
source§impl<'a, S> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
impl<'a, S> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
sourcepub async fn doit(
self
) -> Result<(Response<Body>, GoogleCloudRecommendationengineV1beta1ListUserEventsResponse)>
pub async fn doit( self ) -> Result<(Response<Body>, GoogleCloudRecommendationengineV1beta1ListUserEventsResponse)>
Perform the operation you have build so far.
sourcepub fn parent(
self,
new_value: &str
) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
pub fn parent( self, new_value: &str ) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
Required. The parent eventStore resource name, such as projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store
.
Sets the parent path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn page_token(
self,
new_value: &str
) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
pub fn page_token( self, new_value: &str ) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
Optional. The previous ListUserEventsResponse.next_page_token.
Sets the page token query property to the given value.
sourcepub fn page_size(
self,
new_value: i32
) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
pub fn page_size( self, new_value: i32 ) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.
Sets the page size query property to the given value.
sourcepub fn filter(
self,
new_value: &str
) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
pub fn filter( self, new_value: &str ) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
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
Sets the filter query property to the given value.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
sourcepub fn param<T>(
self,
name: T,
value: T
) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
pub fn param<T>( self, name: T, value: T ) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
§Additional Parameters
- $.xgafv (query-string) - V1 error format.
- access_token (query-string) - OAuth access token.
- alt (query-string) - Data format for response.
- callback (query-string) - JSONP
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
- upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
sourcepub fn add_scope<St>(
self,
scope: St
) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
pub fn add_scope<St>( self, scope: St ) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead of the default Scope
variant
Scope::CloudPlatform
.
The scope
will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
sourcepub fn add_scopes<I, St>(
self,
scopes: I
) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
pub fn add_scopes<I, St>( self, scopes: I ) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope()
for details.
sourcepub fn clear_scopes(
self
) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
pub fn clear_scopes( self ) -> ProjectLocationCatalogEventStoreUserEventListCall<'a, S>
Removes all scopes, and no default scope will be used either.
In this case, you have to specify your API-key using the key
parameter (see Self::param()
for details).