Struct CollectUserEventRequest 

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

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 catalog name, such as projects/1234/locations/global/catalogs/default_catalog.

user_event: String

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

uri: 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 3rd party requests.

ets: i64

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

raw_json: String

An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only.

conversion_rule: Option<ConversionRule>

The rule that can convert the raw_json to a user event. It is needed only when the raw_json is set.

Implementations

impl CollectUserEventRequest

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 = 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: Into<String>>(self, v: T) -> Self

Sets the value of uri.

Example

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

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

Sets the value of ets.

Example

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

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

Sets the value of raw_json.

Example

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

pub fn set_conversion_rule<T: Into<Option<ConversionRule>>>(self, v: T) -> Self

Sets the value of conversion_rule.

Note that all the setters affecting conversion_rule are mutually exclusive.

Example

use google_cloud_retail_v2::model::collect_user_event_request::ConversionRule;
let x = CollectUserEventRequest::new().set_conversion_rule(Some(ConversionRule::PrebuiltRule("example".to_string())));

pub fn prebuilt_rule(&self) -> Option<&String>

The value of conversion_rule if it holds a PrebuiltRule, None if the field is not set or holds a different branch.

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

Sets the value of conversion_rule to hold a PrebuiltRule.

Note that all the setters affecting conversion_rule are mutually exclusive.

Example

let x = CollectUserEventRequest::new().set_prebuilt_rule("example");
assert!(x.prebuilt_rule().is_some());

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