המשאב הזה מייצג פעולה ממושכת שהיא תוצאה של קריאה ל-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 |
התגובה הרגילה והמוצלחת של הפעולה. אם השיטה המקורית לא מחזירה נתוני הצלחה, כמו אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף |