Struct google_api_proto::google::cloud::contentwarehouse::v1::Document

pub struct Document {

    pub name: String,
    pub reference_id: String,
    pub display_name: String,
    pub title: String,
    pub display_uri: String,
    pub document_schema_name: String,
    pub structured_content_uri: String,
    pub properties: Vec<Property>,
    pub update_time: Option<Timestamp>,
    pub create_time: Option<Timestamp>,
    pub raw_document_file_type: i32,
    pub async_enabled: bool,
    pub content_category: i32,
    pub text_extraction_disabled: bool,
    pub text_extraction_enabled: bool,
    pub creator: String,
    pub updater: String,
    pub disposition_time: Option<Timestamp>,
    pub legal_hold: bool,
    pub structured_content: Option<StructuredContent>,
    pub raw_document: Option<RawDocument>,
}

Defines the structure for content warehouse document proto.

Fields

name: String

The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

The name is ignored when creating a document.

reference_id: String

The reference ID set by customers. Must be unique per project and location.

display_name: String

Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the ‘title’ field as ‘title’ is optional and stores the top heading in the document.

title: String

Title that describes the document. This can be the top heading or text that describes the document.

display_uri: String

Uri to display the document, for example, in the UI.

document_schema_name: String

The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

structured_content_uri: String

👎Deprecated

A path linked to structured content file.

properties: Vec<Property>

List of values that are user supplied metadata.

update_time: Option<Timestamp>

Output only. The time when the document is last updated.

create_time: Option<Timestamp>

Output only. The time when the document is created.

raw_document_file_type: i32

This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.

async_enabled: bool

👎Deprecated

If true, makes the document visible to asynchronous policies and rules.

content_category: i32

Indicates the category (image, audio, video etc.) of the original content.

text_extraction_disabled: bool

👎Deprecated

If true, text extraction will not be performed.

text_extraction_enabled: bool

If true, text extraction will be performed.

creator: String

The user who creates the document.

updater: String

The user who lastly updates the document.

disposition_time: Option<Timestamp>

Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable.

legal_hold: bool

Output only. Indicates if the document has a legal hold on it.

structured_content: Option<StructuredContent>

raw_document: Option<RawDocument>

Raw document file.

Implementations

impl Document

pub fn raw_document_file_type(&self) -> RawDocumentFileType

Returns the enum value of raw_document_file_type, or the default if the field is set to an invalid enum value.

pub fn set_raw_document_file_type(&mut self, value: RawDocumentFileType)

Sets raw_document_file_type to the provided enum value.

pub fn content_category(&self) -> ContentCategory

Returns the enum value of content_category, or the default if the field is set to an invalid enum value.

pub fn set_content_category(&mut self, value: ContentCategory)

Sets content_category to the provided enum value.

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, 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