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

Recurso: documento

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

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. Nombre de recurso completo 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 1024 caracteres.
id

string

Inmutable. Identificador del documento.

El ID debe cumplir el estándar RFC-1034 y tener una longitud máxima de 128 caracteres.
schemaId

string

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

object (Content)

Los datos no estructurados vinculados a este documento. El contenido solo se puede definir y debe definirse si este documento está en un almacén de datos CONTENT_REQUIRED.
parentDocumentId

string

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

El ID debe cumplir el estándar RFC-1034 y tener una longitud máxima de 63 caracteres.
derivedStructData

object (Struct format)

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

object (AclInfo)

Información de control de acceso del documento.
indexTime

string (Timestamp format)

Solo de salida. La última vez que se indexó el documento. Si se define este campo, el documento podría devolverse en los resultados de búsqueda.

Este campo es OUTPUT_ONLY. Si este campo no se rellena, significa que el documento nunca se ha indexado.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "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 de salida. Estado de indexación del documento.

  • Si el documento se indexa correctamente, se rellena el campo indexTime.
  • De lo contrario, si el documento no se indexa debido a errores, se rellenará el campo errorSamples.
  • De lo contrario, si el índice del documento está en curso, se rellena el campo pendingMessage.
Campo de unión data. Representación de datos. Se debe proporcionar struct_data o json_data. De lo contrario, se producirá un error INVALID_ARGUMENT. data solo puede ser una de estas dos opciones:
structData

object (Struct format)

Los datos JSON estructurados del documento. Debe ajustarse al Schema registrado o se producirá un error INVALID_ARGUMENT.
jsonData

string

Representación de cadena JSON del documento. Debe ajustarse al Schema registrado o se producirá un error INVALID_ARGUMENT.

Métodos

create

 Crea un Document.

delete

 Elimina un Document.

get

 Obtiene un Document.

getProcessedDocument

 Obtiene la información de diseño analizada de un Document.

import

 Importación en bloque de varios Document.

list

 Obtiene una lista de Documents.

patch

 Actualiza un Document.

purge

 Elimina permanentemente todos los Documents seleccionados de una rama.