Class PurgeUserEventsRequest

Request message for PurgeUserEvents method.

Inheritance
System.Object
PurgeUserEventsRequest
Implements
System.IEquatable<PurgeUserEventsRequest>
Google.Protobuf.IBufferMessage
Inherited Members
System.Object.ToString()
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Cloud.Retail.V2
Assembly: Google.Cloud.Retail.V2.dll
Syntax
public sealed class PurgeUserEventsRequest : IMessage<PurgeUserEventsRequest>, IEquatable<PurgeUserEventsRequest>, IDeepCloneable<PurgeUserEventsRequest>, IBufferMessage, IMessage

Constructors

PurgeUserEventsRequest()

Declaration
public PurgeUserEventsRequest()

PurgeUserEventsRequest(PurgeUserEventsRequest)

Declaration
public PurgeUserEventsRequest(PurgeUserEventsRequest other)
Parameters
Type Name Description
PurgeUserEventsRequest other

Properties

Filter

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

  • eventType: Double quoted [UserEvent.event_type][google.cloud.retail.v2.UserEvent.event_type] string.
  • eventTime: in ISO 8601 "zulu" format.
  • visitorId: 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 > &quot;2012-04-23T18:25:43.511Z&quot; eventTime &lt; &quot;2012-04-23T18:30:43.511Z&quot;
  • Deleting specific eventType in time range: eventTime > &quot;2012-04-23T18:25:43.511Z&quot; eventType = &quot;detail-page-view&quot;
  • Deleting all events for a specific visitor: visitorId = &quot;visitor1024&quot;

The filtering fields are assumed to have an implicit AND.

Declaration
public string Filter { get; set; }
Property Value
Type Description
System.String

Force

Actually perform the purge. If force is set to false, the method will return the expected purge count without deleting any user events.

Declaration
public bool Force { get; set; }
Property Value
Type Description
System.Boolean

Parent

Required. The resource name of the catalog under which the events are created. The format is "projects/${projectId}/locations/global/catalogs/${catalogId}"

Declaration
public string Parent { get; set; }
Property Value
Type Description
System.String