public sealed class PurgeUserEventsRequest : IMessage<PurgeUserEventsRequest>, IEquatable<PurgeUserEventsRequest>, IDeepCloneable<PurgeUserEventsRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Discovery Engine v1beta API class PurgeUserEventsRequest.
The force field is currently not supported. Purge user event requests
will permanently delete all purgeable events. Once the development is
complete:
If force is set to false, the method will return the expected
purge count without deleting any user events. This field will default to
false if not included in the request.
Required. The resource name of the catalog under which the events are
created. The format is
projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.
[[["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\u003eThis document provides reference information for the \u003ccode\u003ePurgeUserEventsRequest\u003c/code\u003e class within the Google Cloud Discovery Engine v1beta API, specifically in the .NET context.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePurgeUserEventsRequest\u003c/code\u003e class is used to request the deletion of user events and is part of the \u003ccode\u003eGoogle.Cloud.DiscoveryEngine.V1Beta\u003c/code\u003e namespace.\u003c/p\u003e\n"],["\u003cp\u003eIt supports filtering user events for deletion based on criteria like \u003ccode\u003eeventType\u003c/code\u003e, \u003ccode\u003eeventTime\u003c/code\u003e, \u003ccode\u003euserPseudoId\u003c/code\u003e, or \u003ccode\u003euserId\u003c/code\u003e, and is limited to 5000 characters.\u003c/p\u003e\n"],["\u003cp\u003eThe class includes properties such as \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForce\u003c/code\u003e, \u003ccode\u003eParent\u003c/code\u003e, and \u003ccode\u003eParentAsDataStoreName\u003c/code\u003e to configure the purge request.\u003c/p\u003e\n"],["\u003cp\u003eThe current \u003ccode\u003eforce\u003c/code\u003e field is not supported and all events will be permanently purged.\u003c/p\u003e\n"]]],[],null,["# Discovery Engine v1beta API - Class PurgeUserEventsRequest (1.0.0-beta19)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.0-beta19 (latest)](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeUserEventsRequest)\n- [1.0.0-beta18](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/1.0.0-beta18/Google.Cloud.DiscoveryEngine.V1Beta.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 Discovery Engine v1beta 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.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeUserEventsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[PurgeUserEventsRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeUserEventsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[PurgeUserEventsRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.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.DiscoveryEngine.V1Beta](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)\n\nAssembly\n--------\n\nGoogle.Cloud.DiscoveryEngine.V1Beta.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 with a\nlength limit of 5,000 characters. The eligible fields for filtering are:\n\n- `eventType`: Double quoted \\[UserEvent.event_type\\]\\[google.cloud.discoveryengine.v1beta.UserEvent.event_type\\] string.\n- `eventTime`: in ISO 8601 \"zulu\" format.\n- `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor.\n- `userId`: Double quoted string. Specifying this will delete all events associated with a user.\n\nExamples:\n\n- Deleting all events in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\"\n eventTime \u003c \"2012-04-23T18:30:43.511Z\"`\n- Deleting specific eventType: `eventType = \"search\"`\n- Deleting all events for a specific visitor: `userPseudoId = \"visitor1024\"`\n- Deleting all events inside a DataStore: `*`\n\nThe filtering fields are assumed to have an implicit AND.\n\n### Force\n\n public bool Force { get; set; }\n\nThe `force` field is currently not supported. Purge user event requests\nwill permanently delete all purgeable events. Once the development is\ncomplete:\nIf `force` is set to false, the method will return the expected\npurge count without deleting any user events. This field will default to\nfalse if not included in the request.\n\n### Parent\n\n public string Parent { get; set; }\n\nRequired. The resource name of the catalog under which the events are\ncreated. The format is\n`projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.\n\n### ParentAsDataStoreName\n\n public DataStoreName ParentAsDataStoreName { get; set; }\n\n[DataStoreName](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.DataStoreName)-typed view over the [Parent](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeUserEventsRequest#Google_Cloud_DiscoveryEngine_V1Beta_PurgeUserEventsRequest_Parent) resource name property."]]
