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