pulumi-google-native-kotlin/com.pulumi.googlenative.contentwarehouse.v1.kotlin.outputs/GetDocumentResult

GetDocumentResult

data class GetDocumentResult(val cloudAiDocument: GoogleCloudDocumentaiV1DocumentResponse, val contentCategory: String, val createTime: String, val creator: String, val displayName: String, val displayUri: String, val dispositionTime: String, val documentSchemaName: String, val inlineRawDocument: String, val name: String, val plainText: String, val properties: List<GoogleCloudContentwarehouseV1PropertyResponse>, val rawDocumentFileType: String, val rawDocumentPath: String, val referenceId: String, val textExtractionDisabled: Boolean, val textExtractionEnabled: Boolean, val title: String, val updateTime: String, val updater: String)

Constructors

GetDocumentResult

fun GetDocumentResult(cloudAiDocument: GoogleCloudDocumentaiV1DocumentResponse, contentCategory: String, createTime: String, creator: String, displayName: String, displayUri: String, dispositionTime: String, documentSchemaName: String, inlineRawDocument: String, name: String, plainText: String, properties: List<GoogleCloudContentwarehouseV1PropertyResponse>, rawDocumentFileType: String, rawDocumentPath: String, referenceId: String, textExtractionDisabled: Boolean, textExtractionEnabled: Boolean, title: String, updateTime: String, updater: String)

Types

Companion

object Companion

Properties

cloudAiDocument

val cloudAiDocument: GoogleCloudDocumentaiV1DocumentResponse

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

contentCategory

val contentCategory: String

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

createTime

val createTime: String

The time when the document is created.

creator

val creator: String

The user who creates the document.

displayName

val 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.

displayUri

val displayUri: String

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

dispositionTime

val dispositionTime: String

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

documentSchemaName

val documentSchemaName: String

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

inlineRawDocument

val inlineRawDocument: String

Raw document content.

name

val 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.

plainText

val plainText: String

Other document format, such as PPTX, XLXS

properties

val properties: List<GoogleCloudContentwarehouseV1PropertyResponse>

List of values that are user supplied metadata.

rawDocumentFileType

val 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.

rawDocumentPath

val rawDocumentPath: String

Raw document file in Cloud Storage path.

referenceId

val referenceId: String

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

textExtractionDisabled

val textExtractionDisabled: Boolean

If true, text extraction will not be performed.

textExtractionEnabled

val textExtractionEnabled: Boolean

If true, text extraction will be performed.