Struct WriteUserEventRequest 

#[non_exhaustive]
pub struct WriteUserEventRequest {
    pub parent: String,
    pub user_event: Option<UserEvent>,
    pub write_async: bool,
    /* private fields */
}

Request message for WriteUserEvent 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 resource name, such as projects/1234/locations/global/catalogs/default_catalog.

user_event: Option<UserEvent>

Required. User event to write.

write_async: bool

If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write. Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs.

Implementations

impl WriteUserEventRequest

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 = WriteUserEventRequest::new().set_parent("example");

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

where T: Into<UserEvent>,

Sets the value of user_event.

Example

use google_cloud_retail_v2::model::UserEvent;
let x = WriteUserEventRequest::new().set_user_event(UserEvent::default()/* use setters */);

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

where T: Into<UserEvent>,

Sets or clears the value of user_event.

Example

use google_cloud_retail_v2::model::UserEvent;
let x = WriteUserEventRequest::new().set_or_clear_user_event(Some(UserEvent::default()/* use setters */));
let x = WriteUserEventRequest::new().set_or_clear_user_event(None::<UserEvent>);

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

Sets the value of write_async.

Example

let x = WriteUserEventRequest::new().set_write_async(true);

Trait Implementations

impl Clone for WriteUserEventRequest

fn clone(&self) -> WriteUserEventRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WriteUserEventRequest

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

Formats the value using the given formatter.

impl Default for WriteUserEventRequest

fn default() -> WriteUserEventRequest

Returns the “default value” for a type.

impl Message for WriteUserEventRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for WriteUserEventRequest

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