Struct google_api_proto::google::cloud::discoveryengine::v1alpha::Document

pub struct Document {
    pub name: String,
    pub id: String,
    pub schema_id: String,
    pub content: Option<Content>,
    pub parent_document_id: String,
    pub derived_struct_data: Option<Struct>,
    pub acl_info: Option<AclInfo>,
    pub index_time: Option<Timestamp>,
    pub index_status: Option<IndexStatus>,
    pub data: Option<Data>,
}

Document captures all raw metadata information of items to be recommended or searched.

Fields

name: String

Immutable. The full resource name of the document. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

id: String

Immutable. The identifier of the document.

Id should conform to RFC-1034 standard with a length limit of 63 characters.

schema_id: String

The identifier of the schema located in the same data store.

content: Option<Content>

The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.

parent_document_id: String

The identifier of the parent document. Currently supports at most two level document hierarchy.

Id should conform to RFC-1034 standard with a length limit of 63 characters.

derived_struct_data: Option<Struct>

Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

acl_info: Option<AclInfo>

Access control information for the document.

index_time: Option<Timestamp>

Output only. The last time the document was indexed. If this field is set, the document could be returned in search results.

This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.

index_status: Option<IndexStatus>

Output only. The index status of the document.

• If document is indexed successfully, the index_time field is populated.
• Otherwise, if document is not indexed due to errors, the error_samples field is populated.
• Otherwise, index_status is unset.

data: Option<Data>

Data representation. One of [struct_data][google.cloud.discoveryengine.v1alpha.Document.struct_data] or [json_data][google.cloud.discoveryengine.v1alpha.Document.json_data] should be provided otherwise an INVALID_ARGUMENT error is thrown.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.

impl Message for Document

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 Document

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