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

Recurso: Document

O documento captura todas as informações de metadados brutos de itens a serem recomendados ou pesquisados.

Representação 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

Imutável. O nome completo do recurso do documento. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

Esse campo precisa ser uma string codificada em UTF-8 com um limite de 1024 caracteres.
id

string

Imutável. O identificador do documento.

O ID precisa estar em conformidade com o padrão RFC-1034, com um limite de 128 caracteres.
schemaId

string

O identificador do esquema localizado no mesmo repositório de dados.
content

object (Content)

Os dados não estruturados vinculados a esse documento. O conteúdo só pode ser definido e precisa ser definido se esse documento estiver em um repositório de dados CONTENT_REQUIRED.
parentDocumentId

string

O identificador do documento pai. Atualmente, oferece suporte a no máximo dois níveis de hierarquia de documentos.

O ID precisa estar em conformidade com o padrão RFC-1034, com um limite de 63 caracteres.
derivedStructData

object (Struct format)

Apenas saída. Esse campo é OUTPUT_ONLY. Ele contém dados derivados que não estão no documento de entrada original.
aclInfo

object (AclInfo)

Informações de controle de acesso para o documento.
indexTime

string (Timestamp format)

Apenas saída. A hora em que o documento foi indexado pela última vez.

Se esse campo estiver preenchido, significa que o documento foi indexado. Os documentos geralmente estão disponíveis para pesquisa alguns segundos após a indexação, mas às vezes isso pode levar algumas horas.

Se esse campo não estiver preenchido, significa que o documento nunca foi indexado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
indexStatus

object (IndexStatus)

Apenas saída. O status do índice do documento.

  • Se o documento for indexado, o campo indexTime será preenchido.
  • Caso contrário, se o documento não for indexado devido a erros, o campo errorSamples será preenchido.
  • Caso contrário, se o índice do documento estiver em andamento, o campo pendingMessage será preenchido.
Representação de dados. Um de struct_data ou json_data precisa ser fornecido. Caso contrário, um erro INVALID_ARGUMENT será gerado. A seguir, há uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
structData

object (Struct format)

Os dados JSON estruturados do documento. Ele precisa estar em conformidade com o Schema registrado ou um erro INVALID_ARGUMENT será gerado.
jsonData

string

A representação de string JSON do documento. Ele precisa estar em conformidade com o Schema registrado ou um erro INVALID_ARGUMENT será gerado.
Fim dos campos mutuamente exclusivos.

Métodos

create

 Cria um Document.

delete

 Exclui um Document.

get

 Recebe um Document.

import

 Importação em massa de vários Documents.

list

 Recebe uma lista de Documents.

patch

 Atualiza um Document.

purge

 Exclui permanentemente todos os Documents selecionados em um branch.