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.