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