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

Obtiene un Branch.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. Nombre de la sucursal que se debe obtener. Formato: projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id.

"default_branch" se puede usar como un branchId especial. Devuelve la rama predeterminada que se ha definido para el documento.

Los parámetros de consulta

Parámetros
view

enum (BranchView)

La vista que se va a aplicar al Branch devuelto. Si no se especifica, el valor predeterminado es [Branch.BranchView.BASIC][].

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si la solicitud se hace correctamente, en el cuerpo de la respuesta se incluye una instancia de Branch.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • discoveryengine.branches.get

Para obtener más información, consulta la documentación de gestión de identidades y accesos.