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 שהוחזר. אם לא מציינים ערך, ברירת המחדל היא BranchView.BRANCH_VIEW_BASIC.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Branch.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • discoveryengine.branches.get

מידע נוסף מופיע במאמרי העזרה בנושא IAM.