משאב: פעולה
המשאב הזה מייצג פעולה ממושכת שמוחזרת מקריאות ל-API ברשת.
| ייצוג ב-JSON |
|---|
{
"name": string,
"metadata": {
"@type": string,
field1: ...,
...
},
"done": boolean,
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"error": {
object ( |
| שדות | |
|---|---|
name |
השם שהוקצה על ידי השרת, שהוא ייחודי רק בתוך אותו שירות שמחזיר אותו במקור. אם משתמשים במיפוי ברירת המחדל של HTTP, הערך של |
metadata |
מטא-נתונים ספציפיים לשירות שמשויכים לפעולה. בדרך כלל הוא מכיל מידע על ההתקדמות ומטא-נתונים נפוצים כמו זמן היצירה. יכול להיות ששירותים מסוימים לא יספקו מטא-נתונים כאלה. כל שיטה שמחזירה פעולה ממושכת צריכה לתעד את סוג המטא-נתונים, אם יש כאלה. אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף, |
done |
אם הערך הוא |
תוצאת הפעולה, שיכולה להיות error או response תקין. אם done == false, לא מוגדרים error וגם response. אם done == true, אפשר להגדיר רק אחד מהשדות error או response. יכול להיות שחלק מהשירותים לא יספקו את התוצאה. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: |
|
error |
תוצאת השגיאה של הפעולה במקרה של כישלון או ביטול. |
response |
התגובה הרגילה והמוצלחת של הפעולה. אם ה-method המקורית לא מחזירה נתונים כשהיא מצליחה, כמו אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף, |
| סוף השדות שמוציאים זה את זה. | |
Methods |
|
|---|---|
|
התחלת ביטול אסינכרוני של פעולה ממושכת. |
|
מחיקה של פעולה ממושכת. |
|
אחזור המצב האחרון של פעולה ממושכת. |
|
הצגת רשימה של פעולות שתואמות למסנן שצוין בבקשה. |