משאב זה מייצג פעולה ארוכת טווח שהיא תוצאה של קריאת API לרשת.
ייצוג JSON | |
---|---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
שדות | ||
---|---|---|
name | השם שהוקצה לשרת, שהוא ייחודי רק בתוך השירות שמחזיר אותו במקור. אם אתה משתמש בברירת מחדל HTTP מיפוי, | |
metadata | מטא נתונים ספציפיים לשירות המשויכים לפעולה. הוא מכיל בדרך כלל מידע על התקדמות ומטא נתונים נפוצים כגון זמן יצירה. ייתכן ששירותים מסוימים לא יספקו מטא נתונים כאלה. כל שיטה שמחזירה פעולה ארוכת טווח צריכה לתעד את סוג המטא נתונים, אם קיים. אובייקט המכיל שדות מסוג שרירותי. תחום נוסף | |
done | אם הערך הוא | |
שדה איחוד result . התוצאה המבצעת, אשר יכולה להיות גם error או תקף response . אם done == false , לא error ולא response מוגדרת. אם done == true , בדיוק אחד error או response מוגדרת. result יכולה להיות רק אחת מהפעולות הבאות: | ||
error | תוצאת השגיאה של הפעולה במקרה של כשל או ביטול. | |
response | התגובה הרגילה של הפעולה במקרה של הצלחה. אם השיטה המקורית חוזרת אין נתונים על הצלחה, כגון אובייקט המכיל שדות מסוג שרירותי. תחום נוסף |