Struct CollectUserEventRequest 

#[non_exhaustive]
pub struct CollectUserEventRequest {
    pub parent: String,
    pub user_event: String,
    pub uri: Option<String>,
    pub ets: Option<i64>,
    /* private fields */
}

Available on crate feature user-event-service only.

Request message for CollectUserEvent 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 parent resource name. If the collect user event action is applied in DataStore level, the format is: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: projects/{project}/locations/{location}.

user_event: String

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

uri: Option<String>

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.

ets: Option<i64>

The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

Implementations

impl CollectUserEventRequest

pub fn new() -> Self

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

Sets the value of parent.

Example

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

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

Sets the value of user_event.

Example

let x = CollectUserEventRequest::new().set_user_event("example");

pub fn set_uri<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of uri.

Example

let x = CollectUserEventRequest::new().set_uri("example");

pub fn set_or_clear_uri<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of uri.

Example

let x = CollectUserEventRequest::new().set_or_clear_uri(Some("example"));
let x = CollectUserEventRequest::new().set_or_clear_uri(None::<String>);

pub fn set_ets<T>(self, v: T) -> Self

where T: Into<i64>,

Sets the value of ets.

Example

let x = CollectUserEventRequest::new().set_ets(42);

pub fn set_or_clear_ets<T>(self, v: Option<T>) -> Self

where T: Into<i64>,

Sets or clears the value of ets.

Example

let x = CollectUserEventRequest::new().set_or_clear_ets(Some(42));
let x = CollectUserEventRequest::new().set_or_clear_ets(None::<i32>);

Trait Implementations

impl Clone for CollectUserEventRequest

fn clone(&self) -> CollectUserEventRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectUserEventRequest

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

Formats the value using the given formatter.

impl Default for CollectUserEventRequest

fn default() -> CollectUserEventRequest

Returns the “default value” for a type.

impl Message for CollectUserEventRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CollectUserEventRequest

fn eq(&self, other: &CollectUserEventRequest) -> 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 CollectUserEventRequest