Method: projects.locations.dataStores.branches.get

Recupera um Branch.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do branch a ser recuperado. Formato: projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id.

"default_branch" pode ser usado como um branchId especial. Ele retorna a ramificação padrão definida para o documento.

Parâmetros de consulta

Parâmetros
view

enum (BranchView)

A visualização a ser aplicada ao Branch retornado. O padrão é [Branch.BranchView.BASIC][] se não for especificado.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Branch.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • discoveryengine.branches.get

Para mais informações, consulte a documentação do IAM.