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

Recurso: documento

O documento capta todas as informações de metadados não processados dos itens a recomendar ou pesquisar.

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

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

Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
id

string

Imutável. O identificador do documento.

O ID deve estar em conformidade com a norma RFC-1034 com um limite de 128 carateres.
schemaId

string

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

object (Content)

Os dados não estruturados associados a este documento. O conteúdo só pode ser definido e tem de ser definido se este documento estiver num arquivo de dados CONTENT_REQUIRED.
parentDocumentId

string

O identificador do documento principal. Atualmente, suporta uma hierarquia de documentos de, no máximo, dois níveis.

O ID deve estar em conformidade com a norma RFC-1034 com um limite de comprimento de 63 carateres.
derivedStructData

object (Struct format)

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

object (AclInfo)

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

string (Timestamp format)

Apenas saída. A última vez que o documento foi indexado. Se este campo estiver definido, o documento pode ser devolvido nos resultados da pesquisa.

Este campo é OUTPUT_ONLY. Se este campo não estiver preenchido, significa que o documento nunca foi indexado.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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 estado do índice do documento.

  • Se o documento for indexado com êxito, o campo indexTime é preenchido.
  • Caso contrário, se o documento não for indexado devido a erros, o campo errorSamples é preenchido.
  • Caso contrário, se o índice do documento estiver em curso, o campo pendingMessage é preenchido.
Campo de união data. Representação de dados. Deve ser fornecida uma das propriedades struct_data ou json_data. Caso contrário, é gerado um erro INVALID_ARGUMENT. data só pode ser uma das seguintes opções:
structData

object (Struct format)

Os dados JSON estruturados para o documento. Deve estar em conformidade com o Schema registado ou é gerado um erro INVALID_ARGUMENT.
jsonData

string

A representação de string JSON do documento. Deve estar em conformidade com o Schema registado ou é gerado um erro INVALID_ARGUMENT.

Métodos

create

 Cria um Document.

delete

 Elimina um Document.

get

 Obtém um Document.

import

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

list

 Obtém uma lista de Documents.

patch

 Atualiza um Document.

purge

 Elimina permanentemente todos os Documents selecionados num ramo.