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