מקור מידע: פעולה
משאב זה מייצג פעולה ממושכת, שהיא תוצאה של קריאה ל-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 |
התגובה הרגילה של הפעולה במקרה של הצלחה. אם השיטה המקורית לא מחזירה נתונים לגבי הצלחה, למשל אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף |
סטטוס
הסוג Status
מגדיר מודל שגיאה לוגית שמתאים לסביבות תכנות שונות, כולל ממשקי REST API ו-RPC API. הוא משמש את gRPC. כל הודעת Status
מכילה שלושה קטעי נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה.
מידע נוסף על מודל השגיאה הזה והסבר על השימוש בו זמין במדריך לעיצוב API.
ייצוג JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
שדות | |
---|---|
code |
קוד הסטטוס, שצריך להיות ערך 'טיפוסים בני מנייה (enum)' |
message |
הודעת שגיאה למפתחים, שאמורה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמש צריכה להיות מותאמת לשוק המקומי ולשלוח אותה בשדה |
details[] |
רשימת ההודעות עם פרטי השגיאה. יש קבוצה משותפת של סוגי הודעות שבהם אפשר להשתמש בממשקי API. אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף |
שיטות |
|
---|---|
|
קבלת המצב העדכני ביותר של פעולה אסינכרונית של הורדת SDF. |