Struct PanelInfo 

#[non_exhaustive]
pub struct PanelInfo {
    pub panel_id: String,
    pub display_name: String,
    pub panel_position: Option<i32>,
    pub total_panels: Option<i32>,
    pub documents: Vec<DocumentInfo>,
    /* private fields */
}

Available on crate features recommendation-service or user-event-service only.

Detailed panel information associated with a user event.

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.

panel_id: String

Required. The panel ID.

display_name: String

The display name of the panel.

panel_position: Option<i32>

The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.

total_panels: Option<i32>

The total number of panels, including this one, shown to the user. Must be set if panel_position is set.

documents: Vec<DocumentInfo>

Optional. The document IDs associated with this panel.

Implementations

impl PanelInfo

pub fn new() -> Self

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

Sets the value of panel_id.

Example

let x = PanelInfo::new().set_panel_id("example");

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

Sets the value of display_name.

Example

let x = PanelInfo::new().set_display_name("example");

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

where T: Into<i32>,

Sets the value of panel_position.

Example

let x = PanelInfo::new().set_panel_position(42);

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

where T: Into<i32>,

Sets or clears the value of panel_position.

Example

let x = PanelInfo::new().set_or_clear_panel_position(Some(42));
let x = PanelInfo::new().set_or_clear_panel_position(None::<i32>);

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

where T: Into<i32>,

Sets the value of total_panels.

Example

let x = PanelInfo::new().set_total_panels(42);

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

where T: Into<i32>,

Sets or clears the value of total_panels.

Example

let x = PanelInfo::new().set_or_clear_total_panels(Some(42));
let x = PanelInfo::new().set_or_clear_total_panels(None::<i32>);

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

where T: IntoIterator<Item = V>, V: Into<DocumentInfo>,

Sets the value of documents.

Example

use google_cloud_discoveryengine_v1::model::DocumentInfo;
let x = PanelInfo::new()
    .set_documents([
        DocumentInfo::default()/* use setters */,
        DocumentInfo::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for PanelInfo

fn clone(&self) -> PanelInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PanelInfo

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

Formats the value using the given formatter.

impl Default for PanelInfo

fn default() -> PanelInfo

Returns the “default value” for a type.

impl Message for PanelInfo

fn typename() -> &'static str

The typename of this message.

impl PartialEq for PanelInfo

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