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

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• IAM Permissions

Retrieves a Branch.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name	string Required. The name of the branch to retrieve. Format: projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id. "default_branch" can be used as a special branchId, it returns the default branch that has been set for the document.

Query parameters

Parameters
view	enum (BranchView) The view to apply to the returned Branch. Defaults to [Branch.BranchView.BASIC][] if unspecified.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Branch.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

• discoveryengine.branches.get

For more information, see the IAM documentation.