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

Ressource: Branch

Ein Datenzweig, in dem Document gespeichert werden.

JSON-Darstellung
{
  "name": string,
  "displayName": string,
  "isDefault": boolean,
  "lastDocumentImportTime": string,
  "branchStats": {
    object (BranchStats)
  }
}
Felder
name

string

Nicht veränderbar. Vollständiger Ressourcenname des Zweigs, z. B. projects/*/locations/global/dataStores/dataStore/branches/branchId.

displayName

string

Nur Ausgabe. Für Menschen lesbarer Name des Zweigs, der in der Benutzeroberfläche angezeigt werden soll.

isDefault

boolean

Nur Ausgabe. Gibt an, ob dieser Zweig als Standardzweig des übergeordneten Datenspeichers festgelegt ist.

lastDocumentImportTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel des letzten Imports über DocumentService.ImportDocuments. Ein leerer Wert bedeutet, dass in diesen Zweig kein Import erfolgt ist.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

branchStats

object (BranchStats)

Nur Ausgabe. Statistiken, die einen Zweig beschreiben. Dieses Feld wird in der Ansicht [BranchView.BASIC][] nicht ausgefüllt.

BranchStats

Statistiken, die einen Zweig beschreiben.

JSON-Darstellung
{
  "documentCounts": {
    string: string,
    ...
  }
}
Felder
documentCounts

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

Die Anzahl der Dokumente in einem bestimmten Zweig.

Der Schlüssel ist eine Gruppe, die eine Reihe von Dokumenten darstellt, und der Wert ist die Anzahl der Dokumente in dieser Gruppe. Hinweis: Die Schlüssel in dieser Karte können sich im Laufe der Zeit ändern. Unterstützte Schlüssel: ['all'].

Methoden

batchGetDocumentsMetadata

Ruft Metadaten zur Aktualität des Index für Document ab.

get

Ruft einen Branch ab.

list

Listet alle Branch unter dem angegebenen übergeordneten DataStore auf.