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

Branch を取得します。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。取得するブランチの名前。形式: projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id。

「default_branch」は特別な branchId として使用できます。これは、ドキュメントに設定されているデフォルト ブランチを返します。

クエリ パラメータ

パラメータ
view

enum (BranchView)

返された Branch に適用するビュー。指定しない場合のデフォルトは [Branch.BranchView.BASIC][] です。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には Branch のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • discoveryengine.branches.get

詳細については、IAM のドキュメントをご覧ください。