Interface PurgeUserEventsRequestOrBuilder (0.42.0)

Version 0.42.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface PurgeUserEventsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String 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.

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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.

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for filter.

getForce()

public abstract boolean 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.

bool force = 3;

Returns
Type	Description
boolean	The force.

getParent()

public abstract String getParent()

Required. The resource name of the catalog under which the events are created. The format is projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The resource name of the catalog under which the events are created. The format is projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.