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

Ressource : Branch

Branche de données qui stocke les Document.

Représentation JSON
{
  "name": string,
  "displayName": string,
  "isDefault": boolean,
  "lastDocumentImportTime": string,
  "branchStats": {
    object (BranchStats)
  }
}
Champs
name

string

Immuable. Nom complet de la ressource de la branche, par exemple projects/*/locations/global/dataStores/dataStore/branches/branchId.

displayName

string

Uniquement en sortie. Nom de la branche lisible par l'utilisateur à afficher dans l'UI.

isDefault

boolean

Uniquement en sortie. Indique si cette branche est définie comme branche par défaut de son data store parent.

lastDocumentImportTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière importation via DocumentService.ImportDocuments. Une valeur vide signifie qu'aucune importation n'a été effectuée dans cette branche.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

branchStats

object (BranchStats)

Uniquement en sortie. Statistiques décrivant une branche. Ce champ n'est pas renseigné dans la vue [BranchView.BASIC][].

BranchStats

Statistiques décrivant une branche.

Représentation JSON
{
  "documentCounts": {
    string: string,
    ...
  }
}
Champs
documentCounts

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

Nombre de documents dans une branche donnée.

La clé est un groupe représentant un ensemble de documents, et la valeur correspond au nombre de documents dans ce groupe. Remarque : Les clés de ce mappage peuvent changer au fil du temps. Clés acceptées : ['all'].

Méthodes

batchGetDocumentsMetadata

Obtient les métadonnées de fraîcheur de l'index pour les Document.

get

Récupère un Branch.

list

Liste tous les Branch sous le DataStore parent spécifié.