import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../../types/input"; import * as outputs from "../../types/output"; /** * 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; readonly branchId: pulumi.Output; readonly collectionId: pulumi.Output; /** * The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. */ readonly content: pulumi.Output; readonly dataStoreId: pulumi.Output; /** * This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */ readonly derivedStructData: pulumi.Output<{ [key: string]: string; }>; /** * Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ readonly documentId: pulumi.Output; /** * The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */ readonly jsonData: pulumi.Output; readonly location: pulumi.Output; /** * Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ readonly name: pulumi.Output; /** * The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */ readonly parentDocumentId: pulumi.Output; readonly project: pulumi.Output; /** * The identifier of the schema located in the same data store. */ readonly schemaId: pulumi.Output; /** * The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */ readonly structData: pulumi.Output<{ [key: string]: string; }>; /** * 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 { branchId: pulumi.Input; collectionId: pulumi.Input; /** * The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. */ content?: pulumi.Input; dataStoreId: pulumi.Input; /** * Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ documentId: pulumi.Input; /** * Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */ id?: pulumi.Input; /** * The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */ jsonData?: pulumi.Input; location?: pulumi.Input; /** * Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: pulumi.Input; /** * The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */ parentDocumentId?: pulumi.Input; project?: pulumi.Input; /** * The identifier of the schema located in the same data store. */ schemaId?: pulumi.Input; /** * The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */ structData?: pulumi.Input<{ [key: string]: pulumi.Input; }>; }