Retail v2 API - Class PurgeUserEventsRequest (2.11.0) 

public sealed class PurgeUserEventsRequest : IMessage<PurgeUserEventsRequest>, IEquatable<PurgeUserEventsRequest>, IDeepCloneable<PurgeUserEventsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class PurgeUserEventsRequest.

Request message for PurgeUserEvents method.

Inheritance

object > PurgeUserEventsRequest

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

PurgeUserEventsRequest()

public PurgeUserEventsRequest()

PurgeUserEventsRequest(PurgeUserEventsRequest)

public PurgeUserEventsRequest(PurgeUserEventsRequest other)
Parameter
Name Description
other 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. 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 > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
  • Deleting specific eventType in time range: eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"
  • Deleting all events for a specific visitor: visitorId = "visitor1024"

The filtering fields are assumed to have an implicit AND.

Property Value
Type Description
string

Force

public bool Force { get; set; }

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

Property Value
Type Description
bool

Parent

public string Parent { get; set; }

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

Property Value
Type Description
string

ParentAsCatalogName

public CatalogName ParentAsCatalogName { get; set; }

CatalogName-typed view over the Parent resource name property.

Property Value
Type Description
CatalogName