GetDocumentResult class - contentwarehouse library

Constructors

GetDocumentResult({required GoogleCloudDocumentaiV1DocumentResponse cloudAiDocument, required String contentCategory, required String createTime, required String creator, required String displayName, required String displayUri, required String dispositionTime, required String documentSchemaName, required String inlineRawDocument, required bool legalHold, required String name, required String plainText, required List<GoogleCloudContentwarehouseV1PropertyResponse> properties, required String rawDocumentFileType, required String rawDocumentPath, required String referenceId, required bool textExtractionDisabled, required bool textExtractionEnabled, required String title, required String updateTime, required String updater}): Creates a new GetDocumentResult. cloudAiDocument Document AI format to save the structured content, including OCR. contentCategory Indicates the category (image, audio, video etc.) of the original content. createTime The time when the document is created. creator The user who creates the document. displayName 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. displayUri Uri to display the document, for example, in the UI. dispositionTime If linked to a Collection with RetentionPolicy, the date when the document becomes mutable. documentSchemaName The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. inlineRawDocument Raw document content. legalHold Indicates if the document has a legal hold on it. name The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document. plainText Other document format, such as PPTX, XLXS properties List of values that are user supplied metadata. rawDocumentFileType 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. rawDocumentPath Raw document file in Cloud Storage path. referenceId The reference ID set by customers. Must be unique per project and location. textExtractionDisabled If true, text extraction will not be performed. textExtractionEnabled If true, text extraction will be performed. title Title that describes the document. This can be the top heading or text that describes the document. updateTime The time when the document is last updated. updater The user who lastly updates the document.
const
GetDocumentResult.fromMap(Map<String, dynamic> map): factory

Properties

cloudAiDocument → GoogleCloudDocumentaiV1DocumentResponse: Document AI format to save the structured content, including OCR.
final
contentCategory → String: Indicates the category (image, audio, video etc.) of the original content.
final
createTime → String: The time when the document is created.
final
creator → String: The user who creates the document.
final
displayName → String: 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.
final
displayUri → String: Uri to display the document, for example, in the UI.
final
dispositionTime → String: If linked to a Collection with RetentionPolicy, the date when the document becomes mutable.
final
documentSchemaName → String: The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
final
hashCode → int: The hash code for this object.
no setterinherited
inlineRawDocument → String: Raw document content.
final
legalHold → bool: Indicates if the document has a legal hold on it.
final
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.
final
plainText → String: Other document format, such as PPTX, XLXS
final
properties → List<GoogleCloudContentwarehouseV1PropertyResponse>: List of values that are user supplied metadata.
final
rawDocumentFileType → String: 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.
final
rawDocumentPath → String: Raw document file in Cloud Storage path.
final
referenceId → String: The reference ID set by customers. Must be unique per project and location.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
textExtractionDisabled → bool: If true, text extraction will not be performed.
final
textExtractionEnabled → bool: If true, text extraction will be performed.
final
title → String: Title that describes the document. This can be the top heading or text that describes the document.
final
updater → String: The user who lastly updates the document.
final
updateTime → String: The time when the document is last updated.
final

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited