Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::PurgeUserEventsRequest.
Request message for PurgeUserEvents method.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#filter
def filter() -> ::String
Returns
-
(::String) — 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 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.
#filter=
def filter=(value) -> ::String
Parameter
-
value (::String) — 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 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.
Returns
-
(::String) — 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 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.
#force
def force() -> ::Boolean
Returns
-
(::Boolean) — Actually perform the purge.
If
forceis set to false, the method will return the expected purge count without deleting any user events.
#force=
def force=(value) -> ::Boolean
Parameter
-
value (::Boolean) — Actually perform the purge.
If
forceis set to false, the method will return the expected purge count without deleting any user events.
Returns
-
(::Boolean) — Actually perform the purge.
If
forceis set to false, the method will return the expected purge count without deleting any user events.
#parent
def parent() -> ::String
Returns
-
(::String) — Required. The resource name of the catalog under which the events are
created. The format is
projects/${projectId}/locations/global/catalogs/${catalogId}
#parent=
def parent=(value) -> ::String
Parameter
-
value (::String) — Required. The resource name of the catalog under which the events are
created. The format is
projects/${projectId}/locations/global/catalogs/${catalogId}
Returns
-
(::String) — Required. The resource name of the catalog under which the events are
created. The format is
projects/${projectId}/locations/global/catalogs/${catalogId}