Method: projects.locations.apps.retrieveToolSchema

אחזור הסכימה של הכלי הנתון. הסכימה מחושבת תוך כדי תנועה עבור המופע הנתון של הכלי.

בקשת HTTP

POST https://ces.googleapis.com/v1/{parent=projects/*/locations/*/apps/*}:retrieveToolSchema

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם המשאב של האפליקציה שאליה שייך הכלי או ערכת הכלים. פורמט: projects/{project}/locations/{location}/apps/{app}

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of mutually exclusive fields.
}
שדות
המזהה של הכלי שאליו רוצים לאחזר את הסכימה. יכול להיות שמדובר בכלי קבוע או בכלי מתוך ערכת כלים. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
tool

string

זה שינוי אופציונלי. השם של הכלי שאליו רוצים לאחזר את הסכימה. פורמט: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

זה שינוי אופציונלי. הכלי בערכת הכלים שאחריו רוצים לאחזר את הסכימה. רק כלי אחד צריך להתאים לפרדיקט מתוך ערכת הכלים. אחרת, תוחזר שגיאה.
סוף השדות הבלעדיים.

גוף התשובה

הודעת תגובה ל-ToolService.RetrieveToolSchema.

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

ייצוג ב-JSON 
{
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of mutually exclusive fields.
}
שדות
inputSchema

object (Schema)

הסכימה של פרמטרי הקלט של הכלי.
outputSchema

object (Schema)

הסכימה של פרמטרים של פלט הכלי.
המזהה של הכלי שאליו הסכימה מתייחסת. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
tool

string

השם של הכלי שאליו הסכימה מתייחסת. פורמט: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

כלי ערכת הכלים שהסכימה מיועדת לו.
סוף השדות הבלעדיים.

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • ces.tools.get

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