אינדקס
Operations
(ממשק)CancelOperationRequest
(הודעה)DeleteOperationRequest
(הודעה)GetOperationRequest
(הודעה)ListOperationsRequest
(הודעה)ListOperationsResponse
(הודעה)Operation
(הודעה)WaitOperationRequest
(הודעה)
תפעול
ניהול פעולות ממושכות באמצעות שירות API.
כשהשלמת השיטה של ה-API נמשכת זמן רב בדרך כלל, אפשר לתכנן אותה כך שתחזיר ללקוח את הערך Operation
. הלקוח יכול להשתמש בממשק הזה כדי לקבל את התגובה האמיתית באופן אסינכררוני על ידי דגימה של משאב הפעולה, או להעביר את משאב הפעולה ל-API אחר (כמו Pub/Sub API) כדי לקבל את התגובה. כל שירות API שמחזיר פעולות ממושכות צריך להטמיע את הממשק Operations
כדי למפתחים תהיה חוויית לקוח עקבית.
CancelOperation |
---|
הפונקציה מתחילה ביטול אסינכרוני של פעולה ממושכת. השרת עושה כמיטב יכולתו כדי לבטל את הפעולה, אבל אי אפשר להבטיח שהיא תבוטל. אם השרת לא תומך בשיטה הזו, הוא מחזיר את הערך
|
DeleteOperation |
---|
מחיקה של פעולה ממושכת. השיטה הזו מציינת שהלקוח כבר לא מעוניין בתוצאת הפעולה. היא לא מבטלת את הפעולה. אם השרת לא תומך בשיטה הזו, הוא מחזיר את הערך
|
GetOperation |
---|
אחזור המצב העדכני של פעולה ממושכת. לקוחות יכולים להשתמש בשיטה הזו כדי לדגום את תוצאת הפעולה במרווחי זמן כפי שמומלץ על ידי שירות ה-API.
|
ListOperations |
---|
הצגת רשימה של פעולות שתואמות למסנן שצוין בבקשה. אם השרת לא תומך בשיטה הזו, הוא מחזיר את הערך
|
WaitOperation |
---|
הפונקציה ממתינה עד שהפעולה הממושכת שצוינה מסתיימת או עד שהיא מגיעה לזמן קצוב לתפוגה, ומחזירה את המצב העדכני. אם הפעולה כבר בוצעה, המצב האחרון מוחזר באופן מיידי. אם זמן הקצאת הזמן שצוין גדול מזמן הקצאת הזמן שמוגדר כברירת מחדל ל-HTTP/RPC, המערכת תשתמש בזמן הקצאת הזמן של HTTP/RPC. אם השרת לא תומך בשיטה הזו, הוא מחזיר את הערך
|
CancelOperationRequest
הודעת הבקשה עבור Operations.CancelOperation
.
שדות | |
---|---|
name |
השם של משאב הפעולה שרוצים לבטל. |
DeleteOperationRequest
הודעת הבקשה עבור Operations.DeleteOperation
.
שדות | |
---|---|
name |
השם של משאב הפעולה שרוצים למחוק. |
GetOperationRequest
הודעת הבקשה עבור Operations.GetOperation
.
שדות | |
---|---|
name |
השם של משאב הפעולה. |
ListOperationsRequest
הודעת הבקשה עבור Operations.ListOperations
.
שדות | |
---|---|
name |
השם של משאב ההורה של הפעולה. |
filter |
מסנן הרשימה הרגיל. |
page_ |
גודל הדף הרגיל של הרשימה. |
page_ |
הטוקן הרגיל של דף הרשימה. |
ListOperationsResponse
הודעת התגובה עבור Operations.ListOperations
.
שדות | |
---|---|
operations[] |
רשימה של פעולות שתואמות למסנן שצוין בבקשה. |
next_ |
האסימון הרגיל לדף הבא ברשימה. |
פעולה
המשאב הזה מייצג פעולה ממושכת שמוחזרת מקריאה ל-API ברשת.
שדות | |
---|---|
name |
השם שהוקצה על ידי השרת, שהוא ייחודי רק באותו שירות שמחזיר אותו במקור. אם משתמשים במיפוי ברירת המחדל של HTTP, השדה |
metadata |
מטא-נתונים ספציפיים לשירות שמשויכים לפעולה. בדרך כלל הוא מכיל מידע על ההתקדמות ומטא-נתונים נפוצים כמו זמן היצירה. יכול להיות שחלק מהשירותים לא יספק מטא-נתונים כאלה. כל שיטה שמחזירה פעולה ממושכת צריכה לתעד את סוג המטא-נתונים, אם יש כאלה. |
done |
אם הערך הוא |
שדה האיחוד result . תוצאת הפעולה, שיכולה להיות error או response תקין. אם done == false , לא מתבצעת הגדרה של error או של response . אם done == true , אפשר להגדיר רק אחת מ-error או מ-response . יכול להיות שחלק מהשירותים לא יספק את התוצאה. הערך של result יכול להיות רק אחת מהאפשרויות הבאות: |
|
error |
תוצאת השגיאה של הפעולה במקרה של כשל או ביטול. |
response |
התגובה הרגילה והמוצלחת של הפעולה. אם השיטה המקורית לא מחזירה נתונים על הצלחה, כמו |
WaitOperationRequest
הודעת הבקשה עבור Operations.WaitOperation
.
שדות | |
---|---|
name |
השם של משאב הפעולה שעליו צריך להמתין. |
timeout |
משך הזמן המקסימלי להמתנה לפני סיום הזמן הקצוב לתפוגה. אם השדה הזה יישאר ריק, משך ההמתנה יהיה לכל היותר הזמן המותרת על ידי פרוטוקול HTTP/RPC הבסיסי. אם יצוין גם מועד יעד להקשר של ה-RPC, המערכת תשתמש במועד הקצר יותר. |