Struct PurgeUserEventsRequest 

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

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/${projectId}/locations/global/catalogs/${catalogId}

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:

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

force: bool

Actually perform the purge. If force is set to false, the method will return the expected purge count without deleting any user events.

Implementations

impl PurgeUserEventsRequest

pub fn new() -> Self

Creates a new default instance.

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