Class GoogleCloudDiscoveryengineV1PurgeUserEventsRequest

Request message for PurgeUserEvents method.

Inheritance
object
GoogleCloudDiscoveryengineV1PurgeUserEventsRequest
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1.Data
Assembly: Google.Apis.DiscoveryEngine.v1.dll
Syntax
public class GoogleCloudDiscoveryengineV1PurgeUserEventsRequest : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Filter

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 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. 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: eventType = "search" * Deleting all events for a specific visitor: userPseudoId = "visitor1024" * Deleting all events inside a DataStore: * The filtering fields are assumed to have an implicit AND.

Declaration
[JsonProperty("filter")]
public virtual string Filter { get; set; }
Property Value
Type Description
string

Force

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.

Declaration
[JsonProperty("force")]
public virtual bool? Force { get; set; }
Property Value
Type Description
bool?

Implements