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