Reference documentation and code samples for the Google Cloud Recommendation Engine V1beta1 Client class PurgeUserEventsRequest.
Request message for PurgeUserEvents method.
Generated from protobuf message google.cloud.recommendationengine.v1beta1.PurgeUserEventsRequest
Namespace
Google \ Cloud \ RecommendationEngine \ V1beta1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the event_store under which the events are created. The format is |
↳ filter |
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. |
↳ force |
bool
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. |
getParent
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 | |
---|---|
Type | Description |
string |
setParent
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}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
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 visitorvisitorId = visitor1024
The filtering fields are assumed to have an implicit AND.
Returns | |
---|---|
Type | Description |
string |
setFilter
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 visitorvisitorId = visitor1024
The filtering fields are assumed to have an implicit AND.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getForce
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 | |
---|---|
Type | Description |
bool |
setForce
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.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the event_store under which the events are
created. The format is
|
filter |
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:
|
force |
bool
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 | |
---|---|
Type | Description |
Google\Cloud\RecommendationEngine\V1beta1\PurgeUserEventsRequest |