Method: projects.locations.collections.dataStores.branches.get

Récupère un Branch.

Requête HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*}

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de la branche à récupérer. Format : projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id.

"default_branch" peut être utilisé comme branchId spécial. Il renvoie la branche par défaut définie pour le document.

Paramètres de requête

Paramètres
view

enum (BranchView)

Vue à appliquer à l'Branch renvoyé. Si aucune valeur n'est spécifiée, la valeur par défaut est [Branch.BranchView.BASIC][].

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Branch.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource name :

  • discoveryengine.branches.get

Pour en savoir plus, consultez la documentation IAM.