Reference documentation and code samples for the Google Cloud Retail V2 Client class PurgeUserEventsRequest.
Request message for PurgeUserEvents method.
Generated from protobuf message google.cloud.retail.v2.PurgeUserEventsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the catalog under which the events are created. The format is |
↳ filter |
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: * |
↳ force |
bool
Actually perform the purge. If |
getParent
Required. The resource name of the catalog under which the events are
created. The format is
projects/${projectId}/locations/global/catalogs/${catalogId}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The resource name of the catalog under which the events are
created. The format is
projects/${projectId}/locations/global/catalogs/${catalogId}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
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.
Generated from protobuf field string filter = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
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.
Generated from protobuf field string filter = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getForce
Actually perform the purge.
If force is set to false, the method will return the expected purge count
without deleting any user events.
Generated from protobuf field bool force = 3;
| Returns | |
|---|---|
| Type | Description |
bool | |
setForce
Actually perform the purge.
If force is set to false, the method will return the expected purge count
without deleting any user events.
Generated from protobuf field bool force = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |