Package google.longrunning

אינדקס

• Operation (מֶסֶר)

פעולה

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

שדות
name	string השם שהוקצה על ידי השרת, והוא ייחודי רק במסגרת אותו שירות שמחזיר אותו במקור. אם משתמשים במיפוי ה-HTTP שמוגדר כברירת מחדל, name צריך להיות שם משאב שמסתיים ב-operations/{unique_id}.
metadata	Any מטא-נתונים ספציפיים לשירות שמשויכים לפעולה. בדרך כלל הנתונים כוללים מידע על ההתקדמות ומטא-נתונים נפוצים, כמו שעת היצירה. ייתכן ששירותים מסוימים לא יספקו מטא-נתונים כאלה. כל שיטה שמחזירה פעולה ממושכת צריכה לתעד את סוג המטא-נתונים, אם קיים.
done	bool אם הערך הוא false, פירוש הדבר שהפעולה עדיין מתבצעת. אם הערך הוא true, הפעולה תסתיים ו-error או response זמינים.
שדה איחוד result. תוצאת הפעולה, שיכולה להיות error או response חוקית. אם done == false, לא הוגדרו error וגם response. אם done == true, אפשר להגדיר בדיוק אחד מהערכים error או response. יכול להיות ששירותים מסוימים לא יספקו את התוצאה. הערך של result יכול להיות רק אחת מהאפשרויות הבאות:
error	Status תוצאת השגיאה של הפעולה במקרה של כשל או ביטול.
response	Any התגובה הרגילה המוצלחת של הפעולה. אם השיטה המקורית לא מחזירה נתונים לגבי הצלחה, למשל Delete, התגובה תהיה google.protobuf.Empty. אם השיטה המקורית היא Get/Create/Update, התגובה צריכה להיות מקור המידע. בשיטות אחרות, התשובה צריכה להיות מסוג XxxResponse, כאשר Xxx הוא שם השיטה המקורי. לדוגמה, אם שם השיטה המקורי הוא TakeSnapshot(), סוג התגובה המשוער הוא TakeSnapshotResponse.