GoogleApi.RecommendationEngine.V1beta1.Model.GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest (google_api_recommendation_engine v0.4.5) View Source

Request message for PurgeUserEvents method.

Attributes

  • filter (type: String.t, default: nil) - Required. The filter string to specify the events to be deleted. Empty string filter is not allowed. The eligible fields for filtering are: eventType: UserEvent.eventType field of type string. eventTime: in ISO 8601 "zulu" format. visitorId: field of type string. Specifying this will delete all events associated with a visitor. userId: field of type 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.
  • force (type: boolean(), default: nil) - Optional. The default value is false. Override this flag to true to actually perform the purge. If the field is not set to true, a sampling of events to be deleted will be returned.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() ::
  %GoogleApi.RecommendationEngine.V1beta1.Model.GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest{
    filter: String.t() | nil,
    force: boolean() | nil
  }

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.