import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../../types/input"; import * as outputs from "../../types/output"; import * as enums from "../../types/enums"; /** * Creates a document. */ export declare class Document extends pulumi.CustomResource { /** * Get an existing Document resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): Document; /** * Returns true if the given object is an instance of Document. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Document; /** * Document AI format to save the structured content, including OCR. */ readonly cloudAiDocument: pulumi.Output; /** * Indicates the category (image, audio, video etc.) of the original content. */ readonly contentCategory: pulumi.Output; /** * The time when the document is created. */ readonly createTime: pulumi.Output; /** * The user who creates the document. */ readonly creator: pulumi.Output; /** * 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. */ readonly displayName: pulumi.Output; /** * Uri to display the document, for example, in the UI. */ readonly displayUri: pulumi.Output; /** * If linked to a Collection with RetentionPolicy, the date when the document becomes mutable. */ readonly dispositionTime: pulumi.Output; /** * The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. */ readonly documentSchemaName: pulumi.Output; /** * Raw document content. */ readonly inlineRawDocument: pulumi.Output; /** * Indicates if the document has a legal hold on it. */ readonly legalHold: pulumi.Output; readonly location: pulumi.Output; /** * The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document. */ readonly name: pulumi.Output; /** * Other document format, such as PPTX, XLXS */ readonly plainText: pulumi.Output; readonly project: pulumi.Output; /** * List of values that are user supplied metadata. */ readonly properties: pulumi.Output; /** * 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. */ readonly rawDocumentFileType: pulumi.Output; /** * Raw document file in Cloud Storage path. */ readonly rawDocumentPath: pulumi.Output; /** * The reference ID set by customers. Must be unique per project and location. */ readonly referenceId: pulumi.Output; /** * If true, text extraction will not be performed. */ readonly textExtractionDisabled: pulumi.Output; /** * If true, text extraction will be performed. */ readonly textExtractionEnabled: pulumi.Output; /** * Title that describes the document. This can be the top heading or text that describes the document. */ readonly title: pulumi.Output; /** * The time when the document is last updated. */ readonly updateTime: pulumi.Output; /** * The user who lastly updates the document. */ readonly updater: pulumi.Output; /** * Create a Document resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: DocumentArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Document resource. */ export interface DocumentArgs { /** * Document AI format to save the structured content, including OCR. */ cloudAiDocument?: pulumi.Input; /** * 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. */ cloudAiDocumentOption?: pulumi.Input; /** * Indicates the category (image, audio, video etc.) of the original content. */ contentCategory?: pulumi.Input; /** * 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. */ createMask?: pulumi.Input; /** * The user who creates the document. */ creator?: pulumi.Input; /** * 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. */ displayName: pulumi.Input; /** * Uri to display the document, for example, in the UI. */ displayUri?: pulumi.Input; /** * The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. */ documentSchemaName?: pulumi.Input; /** * Raw document content. */ inlineRawDocument?: pulumi.Input; location?: pulumi.Input; /** * The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document. */ name?: pulumi.Input; /** * Other document format, such as PPTX, XLXS */ plainText?: pulumi.Input; /** * 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. */ policy?: pulumi.Input; project?: pulumi.Input; /** * List of values that are user supplied metadata. */ properties?: pulumi.Input[]>; /** * 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. */ rawDocumentFileType?: pulumi.Input; /** * Raw document file in Cloud Storage path. */ rawDocumentPath?: pulumi.Input; /** * The reference ID set by customers. Must be unique per project and location. */ referenceId?: pulumi.Input; /** * The meta information collected about the end user, used to enforce access control for the service. */ requestMetadata?: pulumi.Input; /** * If true, text extraction will not be performed. */ textExtractionDisabled?: pulumi.Input; /** * If true, text extraction will be performed. */ textExtractionEnabled?: pulumi.Input; /** * Title that describes the document. This can be the top heading or text that describes the document. */ title?: pulumi.Input; /** * The user who lastly updates the document. */ updater?: pulumi.Input; }