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