1.0.0-beta25 (latest) 1.0.0-beta24

    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.

Request message for PurgeUserEvents method.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> PurgeUserEventsRequest

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[PurgeUserEventsRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeUserEventsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[PurgeUserEventsRequest](https://docs.cloud.google.com/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](https://docs.cloud.google.com/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)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.DiscoveryEngine.V1Beta](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)

## Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

## Constructors

### PurgeUserEventsRequest()

    public PurgeUserEventsRequest()

### PurgeUserEventsRequest(PurgeUserEventsRequest)

    public PurgeUserEventsRequest(PurgeUserEventsRequest other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeUserEventsRequest` |

## Properties

### Filter

    public string Filter { get; set; }

Required. The filter string to specify the events to be deleted with a
length limit of 5,000 characters. The eligible fields for filtering are:

- `eventType`: Double quoted \[UserEvent.event_type\]\[google.cloud.discoveryengine.v1beta.UserEvent.event_type\] string.
- `eventTime`: in ISO 8601 "zulu" format.
- `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor.
- `userId`: Double quoted string. Specifying this will delete all events associated with a user.

Note: This API only supports purging a max range of 30 days.

Examples:

- Deleting all events in a time range: `eventTime > "2012-04-23T18:25:43.511Z"
  eventTime < "2012-04-23T18:30:43.511Z"`
- Deleting specific eventType in a time range: `eventTime > "2012-04-23T18:25:43.511Z"
  eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"`
- Deleting all events for a specific visitor in a time range: `eventTime > "2012-04-23T18:25:43.511Z"
  eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"`
- Deleting the past 30 days of events inside a DataStore: `*`

The filtering fields are assumed to have an implicit AND.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Force

    public bool Force { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### Parent

    public string Parent { get; set; }

Required. The resource name of the catalog under which the events are
created. The format is
`projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ParentAsDataStoreName

    public DataStoreName ParentAsDataStoreName { get; set; }

[DataStoreName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.DataStoreName)-typed view over the [Parent](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeUserEventsRequest#Google_Cloud_DiscoveryEngine_V1Beta_PurgeUserEventsRequest_Parent) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.DataStoreName` |   |