pulumi-google-native-kotlin/com.pulumi.googlenative.contentwarehouse.v1.kotlin/DocumentArgs

DocumentArgs

data class DocumentArgs(val cloudAiDocument: Output<GoogleCloudDocumentaiV1DocumentArgs>? = null, val cloudAiDocumentOption: Output<GoogleCloudContentwarehouseV1CloudAIDocumentOptionArgs>? = null, val contentCategory: Output<DocumentContentCategory>? = null, val createMask: Output<String>? = null, val creator: Output<String>? = null, val displayName: Output<String>? = null, val displayUri: Output<String>? = null, val documentSchemaName: Output<String>? = null, val inlineRawDocument: Output<String>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val plainText: Output<String>? = null, val policy: Output<GoogleIamV1PolicyArgs>? = null, val project: Output<String>? = null, val properties: Output<List<GoogleCloudContentwarehouseV1PropertyArgs>>? = null, val rawDocumentFileType: Output<DocumentRawDocumentFileType>? = null, val rawDocumentPath: Output<String>? = null, val referenceId: Output<String>? = null, val requestMetadata: Output<GoogleCloudContentwarehouseV1RequestMetadataArgs>? = null, val textExtractionDisabled: Output<Boolean>? = null, val textExtractionEnabled: Output<Boolean>? = null, val title: Output<String>? = null, val updater: Output<String>? = null) : ConvertibleToJava<DocumentArgs>

Creates a document.

Constructors

DocumentArgs

constructor(cloudAiDocument: Output<GoogleCloudDocumentaiV1DocumentArgs>? = null, cloudAiDocumentOption: Output<GoogleCloudContentwarehouseV1CloudAIDocumentOptionArgs>? = null, contentCategory: Output<DocumentContentCategory>? = null, createMask: Output<String>? = null, creator: Output<String>? = null, displayName: Output<String>? = null, displayUri: Output<String>? = null, documentSchemaName: Output<String>? = null, inlineRawDocument: Output<String>? = null, location: Output<String>? = null, name: Output<String>? = null, plainText: Output<String>? = null, policy: Output<GoogleIamV1PolicyArgs>? = null, project: Output<String>? = null, properties: Output<List<GoogleCloudContentwarehouseV1PropertyArgs>>? = null, rawDocumentFileType: Output<DocumentRawDocumentFileType>? = null, rawDocumentPath: Output<String>? = null, referenceId: Output<String>? = null, requestMetadata: Output<GoogleCloudContentwarehouseV1RequestMetadataArgs>? = null, textExtractionDisabled: Output<Boolean>? = null, textExtractionEnabled: Output<Boolean>? = null, title: Output<String>? = null, updater: Output<String>? = null)

Properties

cloudAiDocument

val cloudAiDocument: Output<GoogleCloudDocumentaiV1DocumentArgs>? = null

Document AI format to save the structured content, including OCR.

cloudAiDocumentOption

val cloudAiDocumentOption: Output<GoogleCloudContentwarehouseV1CloudAIDocumentOptionArgs>? = null

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

val contentCategory: Output<DocumentContentCategory>? = null

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

createMask

val createMask: Output<String>? = null

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

val creator: Output<String>? = null

The user who creates the document.

displayName

val displayName: Output<String>? = null

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

val displayUri: Output<String>? = null

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

documentSchemaName

val documentSchemaName: Output<String>? = null

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

inlineRawDocument

val inlineRawDocument: Output<String>? = null

Raw document content.

location

val location: Output<String>? = null

name

val name: Output<String>? = null

The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.

plainText

val plainText: Output<String>? = null

Other document format, such as PPTX, XLXS

policy

val policy: Output<GoogleIamV1PolicyArgs>? = null

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

val project: Output<String>? = null

properties

val properties: Output<List<GoogleCloudContentwarehouseV1PropertyArgs>>? = null

List of values that are user supplied metadata.

rawDocumentFileType

val rawDocumentFileType: Output<DocumentRawDocumentFileType>? = null

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

val rawDocumentPath: Output<String>? = null

Raw document file in Cloud Storage path.

referenceId

val referenceId: Output<String>? = null

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

requestMetadata

val requestMetadata: Output<GoogleCloudContentwarehouseV1RequestMetadataArgs>? = null

The meta information collected about the end user, used to enforce access control for the service.

textExtractionDisabled

val textExtractionDisabled: Output<Boolean>? = null

If true, text extraction will not be performed.