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

Recurso: Document

Document 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)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "structData": {
    object
  },
  "jsonData": string
  // End of mutually exclusive fields.
}
Campos
name

string

Inmutable. Es el nombre completo del recurso document. 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 con un límite de longitud 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 está en un almacén de datos CONTENT_REQUIRED.
parentDocumentId

string

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

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

object (Struct format)

Solo salida. Este campo es OUTPUT_ONLY. Contiene datos derivados que no están en el documento de entrada original.
aclInfo

object (AclInfo)

Es la información de control de acceso para el documento.
indexTime

string (Timestamp format)

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

Si este campo está propagado, significa que el documento se indexó. Si bien los documentos suelen permitir la búsqueda en cuestión de segundos luego de la indexación, a veces puede tardar hasta unas horas.

Si este campo no está propagado, 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 del índice del documento.

  • Si el documento se indexa correctamente, se propaga el campo indexTime.
  • De lo contrario, si el documento no se indexa debido a errores, se propaga el campo errorSamples.
  • De lo contrario, si el índice del documento está en curso, se propaga el campo pendingMessage.
Representación de datos. Se debe proporcionar struct_data o json_data. De lo contrario, se arroja un error INVALID_ARGUMENT. A continuación, se incluye una lista de campos mutuamente excluyentes. Se establecerá como máximo uno de los campos en una respuesta:
structData

object (Struct format)

Son los datos JSON estructurados para el 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.
Fin de los campos mutuamente excluyentes.

Métodos

create

 Crea un Document.

delete

 Borra un Document.

get

 Obtienes un Document.

import

 Importación masiva de varios Documents.

list

 Obtiene una lista de Documents.

patch

 Actualiza un Document.

purge

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