DocumentArgs class

The set of arguments for Document. The set of arguments for Document.

Constructors

DocumentArgs({Input<GoogleCloudDocumentaiV1Document>? cloudAiDocument, Input<GoogleCloudContentwarehouseV1CloudAIDocumentOption>? cloudAiDocumentOption, Input<DocumentContentCategory>? contentCategory, Input<String>? createMask, Input<String>? creator, required Input<String> displayName, Input<String>? displayUri, Input<String>? documentSchemaName, Input<String>? inlineRawDocument, Input<String>? location, Input<String>? name, Input<String>? plainText, Input<GoogleIamV1Policy>? policy, Input<String>? project, Input<List<GoogleCloudContentwarehouseV1Property>>? properties, Input<DocumentRawDocumentFileType>? rawDocumentFileType, Input<String>? rawDocumentPath, Input<String>? referenceId, Input<GoogleCloudContentwarehouseV1RequestMetadata>? requestMetadata, Input<bool>? textExtractionDisabled, Input<bool>? textExtractionEnabled, Input<String>? title, Input<String>? updater})
Creates a new DocumentArgs. cloudAiDocument Document AI format to save the structured content, including OCR. cloudAiDocumentOption Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options. contentCategory Indicates the category (image, audio, video etc.) of the original content. createMask Field mask for creating Document fields. If mask path is empty, it means all fields are masked. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. 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. documentSchemaName The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. inlineRawDocument Raw document content. location Optional. 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 policy Default document policy during creation. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document. Conditions defined in the policy will be ignored. project Optional. 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. requestMetadata The meta information collected about the end user, used to enforce access control for the service. 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. updater The user who lastly updates the document.
const
DocumentArgs.fromMap(Map<String, dynamic> map)
factory

Properties

cloudAiDocument → Input<GoogleCloudDocumentaiV1Document>?
Document AI format to save the structured content, including OCR.
final
cloudAiDocumentOption → Input<GoogleCloudContentwarehouseV1CloudAIDocumentOption>?
Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.
final
contentCategory → Input<DocumentContentCategory>?
Indicates the category (image, audio, video etc.) of the original content.
final
createMask → Input<String>?
Field mask for creating Document fields. If mask path is empty, it means all fields are masked. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
final
creator → Input<String>?
The user who creates the document.
final
displayName → Input<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 → Input<String>?
Uri to display the document, for example, in the UI.
final
documentSchemaName → Input<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 → Input<String>?
Raw document content.
final
location → Input<String>?
final
name → Input<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 → Input<String>?
Other document format, such as PPTX, XLXS
final
policy → Input<GoogleIamV1Policy>?
Default document policy during creation. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document. Conditions defined in the policy will be ignored.
final
project → Input<String>?
final
properties → Input<List<GoogleCloudContentwarehouseV1Property>>?
List of values that are user supplied metadata.
final
rawDocumentFileType → Input<DocumentRawDocumentFileType>?
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 → Input<String>?
Raw document file in Cloud Storage path.
final
referenceId → Input<String>?
The reference ID set by customers. Must be unique per project and location.
final
requestMetadata → Input<GoogleCloudContentwarehouseV1RequestMetadata>?
The meta information collected about the end user, used to enforce access control for the service.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
textExtractionDisabled → Input<bool>?
If true, text extraction will not be performed.
final
textExtractionEnabled → Input<bool>?
If true, text extraction will be performed.
final
title → Input<String>?
Title that describes the document. This can be the top heading or text that describes the document.
final
updater → Input<String>?
The user who lastly updates the document.
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