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

Recurso: ramificação

Uma ramificação 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 ramificação, como projects/*/locations/global/dataStores/dataStore/branches/branchId.

displayName

string

Apenas saída. Nome legível da ramificação a ser exibida na UI.

isDefault

boolean

Apenas saída. Indica se esta ramificação está definida como a ramificação padrão do repositório de dados pai.

lastDocumentImportTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora da última importação usando DocumentService.ImportDocuments. Um valor vazio significa que nenhuma importação foi feita para essa ramificação.

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

branchStats

object (BranchStats)

Apenas saída. Estatísticas que descrevem uma ramificação. Esse campo não é preenchido na visualização [BranchView.BASIC][].

BranchStats

Estatísticas que descrevem uma ramificação.

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

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

O número de documentos em uma determinada ramificação.

A chave é um grupo que representa um conjunto de documentos, e o valor é o número de documentos nesse grupo. Observação: as chaves neste mapa podem mudar com o tempo. Chaves compatíveis: ["all"].

Métodos

batchGetDocumentsMetadata

Recebe metadados de atualização do índice para Documents.

get

Recupera um Branch.

list

Lista todos os Branchs no DataStore pai especificado.