public sealed class PurgeUserEventsRequest : IMessage<PurgeUserEventsRequest>, IEquatable<PurgeUserEventsRequest>, IDeepCloneable<PurgeUserEventsRequest>, IBufferMessage, IMessageReference documentation and code samples for the Recommendations AI v1beta1 API class PurgeUserEventsRequest.
Request message for PurgeUserEvents method.
Implements
IMessagePurgeUserEventsRequest, IEquatablePurgeUserEventsRequest, IDeepCloneablePurgeUserEventsRequest, IBufferMessage, IMessageNamespace
Google.Cloud.RecommendationEngine.V1Beta1Assembly
Google.Cloud.RecommendationEngine.V1Beta1.dll
Constructors
PurgeUserEventsRequest()
public PurgeUserEventsRequest()PurgeUserEventsRequest(PurgeUserEventsRequest)
public PurgeUserEventsRequest(PurgeUserEventsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
PurgeUserEventsRequest |
Properties
Filter
public string Filter { get; set; }Required. The filter string to specify the events to be deleted. Empty string filter is not allowed. This filter can also be used with ListUserEvents API to list events that will be deleted. The eligible fields for filtering are:
- eventType - UserEvent.eventType field of type string.
- eventTime - in ISO 8601 "zulu" format.
- visitorId - field of type string. Specifying this will delete all events associated with a visitor.
- userId - field of type string. Specifying this will delete all events
associated with a user.
Example 1: Deleting all events in a time range.
eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"Example 2: Deleting specific eventType in time range.eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"Example 3: Deleting all events for a specific visitorvisitorId = visitor1024The filtering fields are assumed to have an implicit AND.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Force
public bool Force { get; set; }Optional. The default value is false. Override this flag to true to actually perform the purge. If the field is not set to true, a sampling of events to be deleted will be returned.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Parent
public string Parent { get; set; }Required. The resource name of the event_store under which the events are
created. The format is
projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}
| Property Value | |
|---|---|
| Type | Description |
string |
|
ParentAsEventStoreName
public EventStoreName ParentAsEventStoreName { get; set; }EventStoreName-typed view over the Parent resource name property.
| Property Value | |
|---|---|
| Type | Description |
EventStoreName |
|