Struct google_api_proto::google::cloud::discoveryengine::v1::PanelInfo

pub struct PanelInfo {
    pub panel_id: String,
    pub display_name: String,
    pub panel_position: Option<i32>,
    pub total_panels: Option<i32>,
}

Detailed panel information associated with a user event.

Fields

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][google.cloud.discoveryengine.v1.PanelInfo.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][google.cloud.discoveryengine.v1.PanelInfo.panel_position] is set.

Implementations

impl PanelInfo

pub fn panel_position(&self) -> i32

Returns the value of panel_position, or the default value if panel_position is unset.

pub fn total_panels(&self) -> i32

Returns the value of total_panels, or the default value if total_panels is unset.

Trait Implementations

impl Clone for PanelInfo

fn clone(&self) -> PanelInfo

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for PanelInfo

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PanelInfo

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PanelInfo