Struct UserInfo 

#[non_exhaustive]
pub struct UserInfo {
    pub user_id: String,
    pub user_agent: String,
    pub time_zone: String,
    /* private fields */
}

Available on crate features assistant-service or conversational-search-service or recommendation-service or search-service or serving-config-service or user-event-service only.

Information of an end user.

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.

user_id: String

Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don’t set for anonymous users.

Always use a hashed value for this ID.

Don’t set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality.

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

user_agent: String

User agent as included in the HTTP header.

The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.

time_zone: String

Optional. IANA time zone, e.g. Europe/Budapest.

Implementations

impl UserInfo

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of user_id.

Example

let x = UserInfo::new().set_user_id("example");

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

Sets the value of user_agent.

Example

let x = UserInfo::new().set_user_agent("example");

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

Sets the value of time_zone.

Example

let x = UserInfo::new().set_time_zone("example");

Trait Implementations

impl Clone for UserInfo

fn clone(&self) -> UserInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserInfo

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

Formats the value using the given formatter.

impl Default for UserInfo

fn default() -> UserInfo

Returns the “default value” for a type.

impl Message for UserInfo

fn typename() -> &'static str

The typename of this message.

impl PartialEq for UserInfo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for UserInfo