public sealed class PurgeUserEventsRequest : IMessage<PurgeUserEventsRequest>, IEquatable<PurgeUserEventsRequest>, IDeepCloneable<PurgeUserEventsRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Recommendations AI v1beta1 API class PurgeUserEventsRequest.
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 visitor
visitorId = visitor1024
The filtering fields are assumed to have an implicit AND.
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.
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}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe \u003ccode\u003ePurgeUserEventsRequest\u003c/code\u003e class is part of the Recommendations AI v1beta1 API and is used to request the deletion of user events.\u003c/p\u003e\n"],["\u003cp\u003eThis class implements multiple interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and inherits from \u003ccode\u003eobject\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eFilter\u003c/code\u003e property allows specification of which events to delete based on criteria like \u003ccode\u003eeventType\u003c/code\u003e, \u003ccode\u003eeventTime\u003c/code\u003e, \u003ccode\u003evisitorId\u003c/code\u003e, or \u003ccode\u003euserId\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eForce\u003c/code\u003e property determines whether the purge is performed, or if only a sampling of events to be deleted is returned, with a default value of false.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eParent\u003c/code\u003e property is a required string representing the event store's resource name where the events are located and will be deleted from, or can be viewed as an \u003ccode\u003eEventStoreName\u003c/code\u003e type through the \u003ccode\u003eParentAsEventStoreName\u003c/code\u003e property.\u003c/p\u003e\n"]]],[],null,["# Recommendations AI v1beta1 API - Class PurgeUserEventsRequest (2.0.0-beta06)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.0-beta06 (latest)](/dotnet/docs/reference/Google.Cloud.RecommendationEngine.V1Beta1/latest/Google.Cloud.RecommendationEngine.V1Beta1.PurgeUserEventsRequest)\n- [2.0.0-beta05](/dotnet/docs/reference/Google.Cloud.RecommendationEngine.V1Beta1/2.0.0-beta05/Google.Cloud.RecommendationEngine.V1Beta1.PurgeUserEventsRequest)\n- [1.0.0-beta03](/dotnet/docs/reference/Google.Cloud.RecommendationEngine.V1Beta1/1.0.0-beta03/Google.Cloud.RecommendationEngine.V1Beta1.PurgeUserEventsRequest) \n\n public sealed class PurgeUserEventsRequest : IMessage\u003cPurgeUserEventsRequest\u003e, IEquatable\u003cPurgeUserEventsRequest\u003e, IDeepCloneable\u003cPurgeUserEventsRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Recommendations AI v1beta1 API class PurgeUserEventsRequest.\n\nRequest message for PurgeUserEvents method. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e PurgeUserEventsRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[PurgeUserEventsRequest](/dotnet/docs/reference/Google.Cloud.RecommendationEngine.V1Beta1/latest/Google.Cloud.RecommendationEngine.V1Beta1.PurgeUserEventsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[PurgeUserEventsRequest](/dotnet/docs/reference/Google.Cloud.RecommendationEngine.V1Beta1/latest/Google.Cloud.RecommendationEngine.V1Beta1.PurgeUserEventsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[PurgeUserEventsRequest](/dotnet/docs/reference/Google.Cloud.RecommendationEngine.V1Beta1/latest/Google.Cloud.RecommendationEngine.V1Beta1.PurgeUserEventsRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.RecommendationEngine.V1Beta1](/dotnet/docs/reference/Google.Cloud.RecommendationEngine.V1Beta1/latest/Google.Cloud.RecommendationEngine.V1Beta1)\n\nAssembly\n--------\n\nGoogle.Cloud.RecommendationEngine.V1Beta1.dll\n\nConstructors\n------------\n\n### PurgeUserEventsRequest()\n\n public PurgeUserEventsRequest()\n\n### PurgeUserEventsRequest(PurgeUserEventsRequest)\n\n public PurgeUserEventsRequest(PurgeUserEventsRequest other)\n\nProperties\n----------\n\n### Filter\n\n public string Filter { get; set; }\n\nRequired. The filter string to specify the events to be deleted. Empty\nstring filter is not allowed. This filter can also be used with\nListUserEvents API to list events that will be deleted. The eligible fields\nfor filtering are:\n\n- eventType - UserEvent.eventType field of type string.\n- eventTime - in ISO 8601 \"zulu\" format.\n- visitorId - field of type string. Specifying this will delete all events associated with a visitor.\n- 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 \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c\n \"2012-04-23T18:30:43.511Z\"` Example 2: Deleting specific eventType in time range. `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventType = \"detail-page-view\"` Example 3: Deleting all events for a specific visitor `visitorId = visitor1024` The filtering fields are assumed to have an implicit AND.\n\n### Force\n\n public bool Force { get; set; }\n\nOptional. The default value is false. Override this flag to true to\nactually perform the purge. If the field is not set to true, a sampling of\nevents to be deleted will be returned.\n\n### Parent\n\n public string Parent { get; set; }\n\nRequired. The resource name of the event_store under which the events are\ncreated. The format is\n`projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`\n\n### ParentAsEventStoreName\n\n public EventStoreName ParentAsEventStoreName { get; set; }\n\n[EventStoreName](/dotnet/docs/reference/Google.Cloud.RecommendationEngine.V1Beta1/latest/Google.Cloud.RecommendationEngine.V1Beta1.EventStoreName)-typed view over the [Parent](/dotnet/docs/reference/Google.Cloud.RecommendationEngine.V1Beta1/latest/Google.Cloud.RecommendationEngine.V1Beta1.PurgeUserEventsRequest#Google_Cloud_RecommendationEngine_V1Beta1_PurgeUserEventsRequest_Parent) resource name property."]]
