DocumentArgs

data class DocumentArgs(val branchId: Output<String>? = null, val collectionId: Output<String>? = null, val dataStoreId: Output<String>? = null, val documentId: Output<String>? = null, val id: Output<String>? = null, val jsonData: Output<String>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val parentDocumentId: Output<String>? = null, val project: Output<String>? = null, val schemaId: Output<String>? = null, val structData: Output<Map<String, String>>? = null) : ConvertibleToJava<DocumentArgs>

Creates a Document.

Constructors

Link copied to clipboard
fun DocumentArgs(branchId: Output<String>? = null, collectionId: Output<String>? = null, dataStoreId: Output<String>? = null, documentId: Output<String>? = null, id: Output<String>? = null, jsonData: Output<String>? = null, location: Output<String>? = null, name: Output<String>? = null, parentDocumentId: Output<String>? = null, project: Output<String>? = null, schemaId: Output<String>? = null, structData: Output<Map<String, String>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): DocumentArgs

Properties

Link copied to clipboard
val branchId: Output<String>? = null
Link copied to clipboard
val collectionId: Output<String>? = null
Link copied to clipboard
val dataStoreId: Output<String>? = null
Link copied to clipboard
val documentId: Output<String>? = null

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 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Link copied to clipboard
val id: Output<String>? = null

Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.

Link copied to clipboard
val jsonData: Output<String>? = null

The JSON string representation of the document. It should conform to the registered Schema.schema or an INVALID_ARGUMENT error is thrown.

Link copied to clipboard
val location: Output<String>? = null
Link copied to clipboard
val name: Output<String>? = null

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.

Link copied to clipboard
val parentDocumentId: Output<String>? = null

The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to RFC-1034 standard with a length limit of 63 characters.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val schemaId: Output<String>? = null

The identifier of the schema located in the same data store.

Link copied to clipboard
val structData: Output<Map<String, String>>? = null

The structured JSON data for the document. It should conform to the registered Schema.schema or an INVALID_ARGUMENT error is thrown.