REST Resource: projects.locations.dataStores.branches.documents

Recurso: Document

El documento captura toda la información de metadatos sin procesar de los elementos que se recomendarán o buscarán.

Representación JSON 
{
  "name": string,
  "id": string,
  "schemaId": string,
  "content": {
    object (Content)
  },
  "parentDocumentId": string,
  "derivedStructData": {
    object
  },
  "aclInfo": {
    object (AclInfo)
  },
  "indexTime": string,
  "indexStatus": {
    object (IndexStatus)
  },

  // Union field data can be only one of the following:
  "structData": {
    object
  },
  "jsonData": string
  // End of list of possible types for union field data.
}
Campos
name

string

Inmutable. Es el nombre completo del recurso del documento. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.
id

string

Inmutable. Es el identificador del documento.

El ID debe cumplir con el estándar RFC-1034 y tener un límite de 128 caracteres.
schemaId

string

Es el identificador del esquema ubicado en el mismo almacén de datos.
content

object (Content)

Son los datos no estructurados vinculados a este documento. El contenido solo se puede establecer y se debe establecer si este documento se encuentra en un almacén de datos CONTENT_REQUIRED.
parentDocumentId

string

Es el identificador del documento principal. Actualmente, admite como máximo una jerarquía de documentos de dos niveles.

El ID debe cumplir con el estándar RFC-1034 y tener un límite de 63 caracteres.
derivedStructData

object (Struct format)

Solo salida. Este campo es OUTPUT_ONLY. Contiene datos derivados que no se encuentran en el documento de entrada original.
aclInfo

object (AclInfo)

Es la información de control de acceso del documento.
indexTime

string (Timestamp format)

Solo salida. Fecha y hora en la que se indexó el documento por última vez.

Si este campo se propaga, significa que el documento se indexó. Si bien los documentos suelen estar disponibles para la búsqueda a los pocos segundos de la indexación, a veces pueden tardar algunas horas.

Si este campo no está completado, significa que el documento nunca se indexó.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
indexStatus

object (IndexStatus)

Solo salida. Es el estado de indexación del documento.

  • Si el documento se indexa correctamente, se propagará el campo indexTime.
  • De lo contrario, si el documento no se indexa debido a errores, se propagará el campo errorSamples.
  • De lo contrario, si la indexación del documento está en curso, se propagará el campo pendingMessage.
Campo de unión data. Representación de datos Se debe proporcionar struct_data o json_data. De lo contrario, se arrojará un error INVALID_ARGUMENT. data solo puede ser una de las siguientes opciones:
structData

object (Struct format)

Son los datos estructurados en formato JSON del documento. Debe cumplir con el Schema registrado o se arroja un error INVALID_ARGUMENT.
jsonData

string

Es la representación de la cadena JSON del documento. Debe cumplir con el Schema registrado o se arroja un error INVALID_ARGUMENT.

Métodos

create

 Crea un Document.

delete

 Borra un Document.

get

 Obtienes una Document.

import

 Importación masiva de varios Document.

list

 Obtiene una lista de Documents.

patch

 Actualiza un Document.

purge

 Borra de forma permanente todos los Documents seleccionados en una rama.