Reference documentation and code samples for the Recommendations AI V1beta1 API class Google::Cloud::RecommendationEngine::V1beta1::PurgeUserEventsRequest.
Request message for PurgeUserEvents method.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#filter
deffilter()->::String
Returns
(::String) —
Required. The filter string to specify the events to be deleted. Empty
string filter is not allowed. This filter can also be used with
ListUserEvents API to list events that will be deleted. 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.
Example 1: Deleting all events in a time range.
eventTime > "2012-04-23T18:25:43.511Z" eventTime <
"2012-04-23T18:30:43.511Z"
Example 2: Deleting specific eventType in time range.
eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"
Example 3: Deleting all events for a specific visitor
visitorId = visitor1024
The filtering fields are assumed to have an implicit AND.
#filter=
deffilter=(value)->::String
Parameter
value (::String) —
Required. The filter string to specify the events to be deleted. Empty
string filter is not allowed. This filter can also be used with
ListUserEvents API to list events that will be deleted. 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.
Example 1: Deleting all events in a time range.
eventTime > "2012-04-23T18:25:43.511Z" eventTime <
"2012-04-23T18:30:43.511Z"
Example 2: Deleting specific eventType in time range.
eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"
Example 3: Deleting all events for a specific visitor
visitorId = visitor1024
The filtering fields are assumed to have an implicit AND.
Returns
(::String) —
Required. The filter string to specify the events to be deleted. Empty
string filter is not allowed. This filter can also be used with
ListUserEvents API to list events that will be deleted. 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.
Example 1: Deleting all events in a time range.
eventTime > "2012-04-23T18:25:43.511Z" eventTime <
"2012-04-23T18:30:43.511Z"
Example 2: Deleting specific eventType in time range.
eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"
Example 3: Deleting all events for a specific visitor
visitorId = visitor1024
The filtering fields are assumed to have an implicit AND.
#force
defforce()->::Boolean
Returns
(::Boolean) — 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.
#force=
defforce=(value)->::Boolean
Parameter
value (::Boolean) — 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.
Returns
(::Boolean) — 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.
#parent
defparent()->::String
Returns
(::String) — Required. The resource name of the event_store under which the events are
created. The format is
projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}
#parent=
defparent=(value)->::String
Parameter
value (::String) — Required. The resource name of the event_store under which the events are
created. The format is
projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}
Returns
(::String) — Required. The resource name of the event_store under which the events are
created. The format is
projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Recommendations AI V1beta1 API - Class Google::Cloud::RecommendationEngine::V1beta1::PurgeUserEventsRequest (v0.13.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.0 (latest)](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/latest/Google-Cloud-RecommendationEngine-V1beta1-PurgeUserEventsRequest)\n- [0.12.1](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.12.1/Google-Cloud-RecommendationEngine-V1beta1-PurgeUserEventsRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.11.0/Google-Cloud-RecommendationEngine-V1beta1-PurgeUserEventsRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.10.0/Google-Cloud-RecommendationEngine-V1beta1-PurgeUserEventsRequest)\n- [0.9.2](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.9.2/Google-Cloud-RecommendationEngine-V1beta1-PurgeUserEventsRequest)\n- [0.8.2](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.8.2/Google-Cloud-RecommendationEngine-V1beta1-PurgeUserEventsRequest)\n- [0.7.0](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.7.0/Google-Cloud-RecommendationEngine-V1beta1-PurgeUserEventsRequest)\n- [0.6.1](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.6.1/Google-Cloud-RecommendationEngine-V1beta1-PurgeUserEventsRequest)\n- [0.5.0](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.5.0/Google-Cloud-RecommendationEngine-V1beta1-PurgeUserEventsRequest)\n- [0.4.1](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.4.1/Google-Cloud-RecommendationEngine-V1beta1-PurgeUserEventsRequest)\n- [0.3.7](/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/0.3.7/Google-Cloud-RecommendationEngine-V1beta1-PurgeUserEventsRequest) \nReference documentation and code samples for the Recommendations AI V1beta1 API class Google::Cloud::RecommendationEngine::V1beta1::PurgeUserEventsRequest.\n\nRequest message for PurgeUserEvents method. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #filter\n\n def filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The filter string to specify the events to be deleted. Empty\n string filter is not allowed. This filter can also be used with\n ListUserEvents API to list events that will be deleted. The eligible fields\n for filtering are:\n\n - eventType - UserEvent.eventType field of type string.\n - eventTime - in ISO 8601 \"zulu\" format.\n - visitorId - field of type string. Specifying this will delete all events associated with a visitor.\n - userId - field of type string. Specifying this will delete all events associated with a user. Example 1: Deleting all events in a time range. `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c\n \"2012-04-23T18:30:43.511Z\"` Example 2: Deleting specific eventType in time range. `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventType = \"detail-page-view\"` Example 3: Deleting all events for a specific visitor `visitorId = visitor1024` The filtering fields are assumed to have an implicit AND.\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) ---\n\n Required. The filter string to specify the events to be deleted. Empty\n string filter is not allowed. This filter can also be used with\n ListUserEvents API to list events that will be deleted. The eligible fields\n for filtering are:\n - eventType - UserEvent.eventType field of type string.\n - eventTime - in ISO 8601 \"zulu\" format.\n - visitorId - field of type string. Specifying this will delete all events associated with a visitor.\n - userId - field of type string. Specifying this will delete all events associated with a user. Example 1: Deleting all events in a time range. `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c\n\"2012-04-23T18:30:43.511Z\"` Example 2: Deleting specific eventType in time range. `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventType = \"detail-page-view\"` Example 3: Deleting all events for a specific visitor `visitorId = visitor1024` The filtering fields are assumed to have an implicit AND. \n**Returns**\n\n- (::String) --- Required. The filter string to specify the events to be deleted. Empty\n string filter is not allowed. This filter can also be used with\n ListUserEvents API to list events that will be deleted. The eligible fields\n for filtering are:\n\n - eventType - UserEvent.eventType field of type string.\n - eventTime - in ISO 8601 \"zulu\" format.\n - visitorId - field of type string. Specifying this will delete all events associated with a visitor.\n - userId - field of type string. Specifying this will delete all events associated with a user. Example 1: Deleting all events in a time range. `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c\n \"2012-04-23T18:30:43.511Z\"` Example 2: Deleting specific eventType in time range. `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventType = \"detail-page-view\"` Example 3: Deleting all events for a specific visitor `visitorId = visitor1024` The filtering fields are assumed to have an implicit AND.\n\n### #force\n\n def force() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- 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.\n\n### #force=\n\n def force=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- 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. \n**Returns**\n\n- (::Boolean) --- 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.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The resource name of the event_store under which the events are created. The format is `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The resource name of the event_store under which the events are created. The format is `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}` \n**Returns**\n\n- (::String) --- Required. The resource name of the event_store under which the events are created. The format is `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`"]]
