Struct google_api_proto::google::cloud::discoveryengine::v1::DocumentInfo

pub struct DocumentInfo {
    pub quantity: Option<i32>,
    pub promotion_ids: Vec<String>,
    pub joined: bool,
    pub document_descriptor: Option<DocumentDescriptor>,
}

Detailed document information associated with a user event.

Fields

quantity: Option<i32>

Quantity of the Document associated with the user event. Defaults to 1.

For example, this field is 2 if two quantities of the same Document are involved in a add-to-cart event.

Required for events of the following event types:

• add-to-cart
• purchase

promotion_ids: Vec<String>

The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

joined: bool

Output only. Whether the referenced Document can be found in the data store.

document_descriptor: Option<DocumentDescriptor>

A required descriptor of the associated [Document][google.cloud.discoveryengine.v1.Document].

• If [id][google.cloud.discoveryengine.v1.DocumentInfo.id] is specified, then the default values for {location}, {collection_id}, {data_store_id}, and {branch_id} are used when annotating with the stored Document.

• If [name][google.cloud.discoveryengine.v1.DocumentInfo.name] is specified, then the provided values (default values allowed) for {location}, {collection_id}, {data_store_id}, and {branch_id} are used when annotating with the stored Document.

Implementations

impl DocumentInfo

pub fn quantity(&self) -> i32

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

Trait Implementations

impl Clone for DocumentInfo

fn clone(&self) -> DocumentInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentInfo

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

Formats the value using the given formatter.

impl Default for DocumentInfo

fn default() -> Self

Returns the “default value” for a type.

impl Message for DocumentInfo

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 DocumentInfo

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