Struct PurgeUserEventsRequest 

#[non_exhaustive]
pub struct PurgeUserEventsRequest {
    pub parent: String,
    pub filter: String,
    pub force: bool,
    /* private fields */
}

Available on crate feature user-event-service only.

Request message for PurgeUserEvents method.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

parent: String

Required. The resource name of the catalog under which the events are created. The format is projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

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:

• 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.

Note: This API only supports purging a max range of 30 days.

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 a time range: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
• Deleting all events for a specific visitor in a time range: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
• Deleting the past 30 days of events inside a DataStore: *

The filtering fields are assumed to have an implicit AND.

force: bool

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.

Implementations

impl PurgeUserEventsRequest

pub fn new() -> Self

pub fn set_parent<T: Into<String>>(self, v: T) -> Self

Sets the value of parent.

Example

let x = PurgeUserEventsRequest::new().set_parent("example");

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

Example

let x = PurgeUserEventsRequest::new().set_filter("example");

pub fn set_force<T: Into<bool>>(self, v: T) -> Self

Sets the value of force.

Example

let x = PurgeUserEventsRequest::new().set_force(true);

Trait Implementations

impl Clone for PurgeUserEventsRequest

fn clone(&self) -> PurgeUserEventsRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PurgeUserEventsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PurgeUserEventsRequest

fn default() -> PurgeUserEventsRequest

Returns the “default value” for a type.

impl Message for PurgeUserEventsRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for PurgeUserEventsRequest

fn eq(&self, other: &PurgeUserEventsRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PurgeUserEventsRequest