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

Recurso: Branch

Um ramo de dados que armazena Documents.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "isDefault": boolean,
  "lastDocumentImportTime": string,
  "branchStats": {
    object (BranchStats)
  }
}
Campos
name

string

Imutável. Nome completo do recurso da filial, como projects/*/locations/global/dataStores/dataStore/branches/branchId.
displayName

string

Apenas saída. Nome legível da ramificação a apresentar na IU.
isDefault

boolean

Apenas saída. Indica se este ramo está definido como o ramo predefinido da respetiva loja de dados principal.
lastDocumentImportTime

string (Timestamp format)

Apenas saída. Data/hora da última importação através de DocumentService.ImportDocuments. Um valor vazio significa que não foi feita nenhuma importação para este ramo.

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".
branchStats

object (BranchStats)

Apenas saída. Estatísticas que descrevem um ramo. Este campo não é preenchido na vista [BranchView.BASIC][].

BranchStats

Estatísticas que descrevem um ramo.

Representação JSON 
{
  "documentCounts": {
    string: string,
    ...
  }
}
Campos
documentCounts

map (key: string, value: string (int64 format))

O número de documentos num determinado ramo.

A chave é um grupo que representa um conjunto de documentos e o valor é o número de documentos nesse grupo. Nota: as chaves neste mapa podem mudar ao longo do tempo. Chaves suportadas: ['all'].

Métodos

batchGetDocumentsMetadata

 Obtém metadados de atualidade do índice para Documents.

get

 Recupera um Branch.

list

 Apresenta todos os Branchs no DataStore principal especificado.