REST Resource: tunedModels.operations

מקור מידע: פעולה

משאב זה מייצג פעולה ממושכת, שהיא תוצאה של קריאה ל-API של רשת.

ייצוג JSON
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
שדות
name

string

השם שהוקצה על ידי השרת, והוא ייחודי רק במסגרת אותו שירות שמחזיר אותו במקור. אם משתמשים במיפוי ה-HTTP שמוגדר כברירת מחדל, name צריך להיות שם משאב שמסתיים ב-operations/{unique_id}.

metadata

object

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

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI שמזהה את הסוג. דוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }

done

boolean

אם הערך הוא false, פירוש הדבר שהפעולה עדיין מתבצעת. אם הערך הוא true, הפעולה תסתיים ו-error או response זמינים.

שדה איחוד result. תוצאת הפעולה, שיכולה להיות error או response חוקית. אם done == false, לא הוגדרו error וגם response. אם done == true, אפשר להגדיר בדיוק אחד מהערכים error או response. יכול להיות ששירותים מסוימים לא יספקו את התוצאה. הערך של result יכול להיות רק אחת מהאפשרויות הבאות:
error

object (Status)

תוצאת השגיאה של הפעולה במקרה של כשל או ביטול.

response

object

התגובה הרגילה המוצלחת של הפעולה. אם השיטה המקורית לא מחזירה נתונים לגבי הצלחה, למשל Delete, התגובה תהיה google.protobuf.Empty. אם השיטה המקורית היא Get/Create/Update, התגובה צריכה להיות מקור המידע. בשיטות אחרות, התשובה צריכה להיות מסוג XxxResponse, כאשר Xxx הוא שם השיטה המקורי. לדוגמה, אם שם השיטה המקורי הוא TakeSnapshot(), סוג התגובה המשוער הוא TakeSnapshotResponse.

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI שמזהה את הסוג. דוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }

שיטות

cancel

הפעלת ביטול אסינכרוני בפעולה ממושכת.

get

הפונקציה מקבלת את המצב העדכני של פעולה ממושכת.

list

בתיבת הדו-שיח הזו מפורטים הפעולות שתואמות למסנן שצוין בבקשה.