Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class PurgeUserEventsRequest.
Request message for PurgeUserEvents method.
Generated from protobuf message google.cloud.discoveryengine.v1.PurgeUserEventsRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__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. The eligible fields for filtering are: * * |
↳ force |
bool
The |
getParent
Required. The resource name of the catalog under which the events are
created. The format is
projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The resource name of the catalog under which the events are
created. The format is
projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.
| 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. The eligible fields for filtering are:
eventType: Double quoted UserEvent.event_type string.eventTime: in ISO 8601 "zulu" format.userPseudoId: 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:
eventType = "search" - Deleting all events for a specific visitor:
userPseudoId = "visitor1024" - Deleting all events inside a DataStore:
*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 with a length limit of 5,000 characters. The eligible fields for filtering are:
eventType: Double quoted UserEvent.event_type string.eventTime: in ISO 8601 "zulu" format.userPseudoId: 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:
eventType = "search" - Deleting all events for a specific visitor:
userPseudoId = "visitor1024" - Deleting all events inside a DataStore:
*The filtering fields are assumed to have an implicit AND.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getForce
The force field is currently not supported. Purge user event requests
will permanently delete all purgeable events. Once the development is
complete:
If force is set to false, the method will return the expected
purge count without deleting any user events. This field will default to
false if not included in the request.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setForce
The force field is currently not supported. Purge user event requests
will permanently delete all purgeable events. Once the development is
complete:
If force is set to false, the method will return the expected
purge count without deleting any user events. This field will default to
false if not included in the request.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|