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

Recurso: Document

O documento captura todas as informações de metadados brutos dos 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)
  },

  // 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 completo do recurso do documento. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

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

string

Imutável. O identificador do documento.

O ID precisa estar em conformidade com o padrão RFC-1034 e ter 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 este documento. O conteúdo só pode ser definido e precisa ser definido se este documento estiver em um repositório de dados CONTENT_REQUIRED.
parentDocumentId

string

O identificador do documento principal. Atualmente, é compatível com no máximo dois níveis de hierarquia de documentos.

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

object (Struct format)

Apenas saída. Este 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 do documento.
indexTime

string (Timestamp format)

Apenas saída. A última vez que o documento foi indexado. Se esse campo estiver definido, o documento poderá ser retornado nos resultados da pesquisa.

Este campo é OUTPUT_ONLY. Se esse campo não for 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 de indexação 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.
Campo de união data. Representação de dados. É necessário fornecer struct_data ou json_data. Caso contrário, um erro INVALID_ARGUMENT será gerado. data pode ser apenas um dos seguintes:
structData

object (Struct format)

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

string

A representação de string JSON do documento. Ele precisa estar de acordo com o Schema registrado ou um erro INVALID_ARGUMENT será gerado.

Métodos

create

 Cria uma 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 uma ramificação.