Package google.longrunning

אינדקס

תפעול

ניהול פעולות ממושכות באמצעות שירות API.

אם שיטה (method) של API בדרך כלל נמשכת זמן רב, אפשר לתכנן אותה כך שתחזיר Operation ללקוח, והלקוח יוכל להשתמש בממשק הזה כדי לקבל את התגובה האמיתית באופן אסינכרוני על ידי דגימת משאב הפעולה, או להעביר את משאב הפעולה ל-API אחר (כמו Pub/Sub API) כדי לקבל את התגובה. כל שירות API שמחזיר פעולות ממושכות צריך להטמיע את הממשק Operations כדי שהמפתחים יוכלו ליהנות מחוויית לקוח עקבית.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

מתחיל ביטול אסינכרוני של פעולה ממושכת. השרת עושה כל מאמץ לבטל את הפעולה, אבל אין ערובה לכך שהביטול יצליח. אם השרת לא תומך בשיטה הזו, הוא מחזיר google.rpc.Code.UNIMPLEMENTED. לקוחות יכולים להשתמש ב-Operations.GetOperation או בשיטות אחרות כדי לבדוק אם הביטול הצליח או אם הפעולה הושלמה למרות הביטול. אם הביטול מצליח, הפעולה לא נמחקת. במקום זאת, היא הופכת לפעולה עם ערך Operation.error עם google.rpc.Status.code של 1, שמתאים ל-Code.CANCELLED.

היקפי הרשאה

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
DeleteOperation

rpc DeleteOperation(DeleteOperationRequest) returns (Empty)

מחיקת פעולה ממושכת. השיטה הזו מציינת שהלקוח כבר לא מתעניין בתוצאת הפעולה. היא לא מבטלת את הפעולה. אם השרת לא תומך בשיטה הזו, הוא מחזיר google.rpc.Code.UNIMPLEMENTED.

היקפי הרשאה

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation)

אחזור המצב העדכני של פעולה ממושכת. לקוחות יכולים להשתמש בשיטה הזו כדי לדגום את תוצאת הפעולה במרווחי זמן לפי ההמלצות של שירות ה-API.

היקפי הרשאה

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • routeoptimization.operations.get

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

רשימת פעולות שתואמות למסנן שצוין בבקשה. אם השרת לא תומך בשיטה הזו, הוא מחזיר UNIMPLEMENTED.

היקפי הרשאה

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
WaitOperation

rpc WaitOperation(WaitOperationRequest) returns (Operation)

הפעולה ממתינה עד שהפעולה הממושכת שצוינה מסתיימת או עד שהיא מגיעה לזמן קצוב לתפוגה שצוין, ומחזירה את המצב העדכני ביותר. אם הפעולה כבר בוצעה, המצב האחרון מוחזר באופן מיידי. אם ערך הזמן הקצוב לתפוגה שצוין גדול יותר מערך ברירת המחדל של הזמן הקצוב לתפוגה של HTTP/RPC, המערכת משתמשת בערך ברירת המחדל של הזמן הקצוב לתפוגה של HTTP/RPC. אם השרת לא תומך בשיטה הזו, הוא מחזיר google.rpc.Code.UNIMPLEMENTED. שימו לב שהשיטה הזו מבוססת על מאמץ מקסימלי. יכול להיות שהיא תחזיר את המצב האחרון לפני פסק הזמן שצוין (כולל באופן מיידי), כלומר גם תגובה מיידית לא מבטיחה שהפעולה הסתיימה.

היקפי הרשאה

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

CancelOperationRequest

ההודעה עם הבקשה מ-Operations.CancelOperation.

שדות
name

string

שם משאב הפעולה שרוצים לבטל.

DeleteOperationRequest

ההודעה עם הבקשה מ-Operations.DeleteOperation.

שדות
name

string

שם משאב הפעולה שרוצים למחוק.

GetOperationRequest

ההודעה עם הבקשה מ-Operations.GetOperation.

שדות
name

string

השם של משאב הפעולה.

ListOperationsRequest

ההודעה עם הבקשה מ-Operations.ListOperations.

שדות
name

string

השם של משאב ההורה של הפעולה.
filter

string

מסנן הרשימה הרגיל.
page_size

int32

גודל הדף הרגיל ברשימה.
page_token

string

טוקן הדף של רשימת ברירת המחדל.
return_partial_success

bool

כשהערך הוא true, פעולות שאפשר להגיע אליהן מוחזרות כרגיל, ופעולות שלא ניתן להגיע אליהן מוחזרות בשדה [ListOperationsResponse.unreachable].

הערך הזה יכול להיות true רק כשקוראים נתונים מכמה אוספים, למשל כשparent מוגדר ל-"projects/example/locations/-".

השדה הזה לא נתמך כברירת מחדל, ואם הוא מוגדר, תופיע השגיאה UNIMPLEMENTED, אלא אם צוין אחרת במפורש במסמכי התיעוד הספציפיים לשירות או למוצר.

ListOperationsResponse

הודעת התגובה ל-Operations.ListOperations.

שדות
operations[]

Operation

רשימת פעולות שתואמות למסנן שצוין בבקשה.
next_page_token

string

טוקן רגיל של הדף הבא ברשימה.
unreachable[]

string

רשימה לא ממוינת. משאבים שלא ניתן להגיע אליהם. השדה הזה מאוכלס כשהבקשה מגדירה ListOperationsRequest.return_partial_success וקוראת באוספים, למשל כשמנסים לפרט את כל המשאבים בכל המיקומים הנתמכים.

פעולה

המשאב הזה מייצג פעולה ממושכת שמוחזרת מקריאות ל-API ברשת.

שדות
name

string

השם שהוקצה על ידי השרת, שהוא ייחודי רק בתוך אותו שירות שהחזיר אותו במקור. אם משתמשים במיפוי HTTP שמוגדר כברירת מחדל, name צריך להיות שם משאב שמסתיים ב-operations/{unique_id}.
metadata

Any

מטא-נתונים שספציפיים לשירות ומשויכים לפעולה. הוא בדרך כלל מכיל מידע על ההתקדמות ומטא-נתונים נפוצים כמו זמן היצירה. יכול להיות שחלק מהשירותים לא יספקו מטא-נתונים כאלה. כל שיטה שמחזירה פעולה ממושכת צריכה לכלול תיעוד של סוג המטא-נתונים, אם יש כאלה.
done

bool

אם הערך הוא false, המשמעות היא שהפעולה עדיין מתבצעת. אם הערך הוא true, הפעולה הושלמה ואפשר להשתמש בערך error או response.
שדה איחוד result. תוצאת הפעולה, שיכולה להיות error או response חוקי. אם done == false, אף אחד מהערכים error או response לא מוגדר. אם done == true, אפשר להגדיר בדיוק אחד מהערכים error או response. יכול להיות שחלק מהשירותים לא יספקו את התוצאה. הערך result יכול להיות רק אחד מהבאים:
error

Status

תוצאת השגיאה של הפעולה במקרה של כשל או ביטול.
response

Any

התגובה הרגילה והמוצלחת של הפעולה. אם השיטה המקורית לא מחזירה נתונים במקרה של הצלחה, כמו Delete, התגובה היא google.protobuf.Empty. אם השיטה המקורית היא סטנדרטית Get/Create/Update, התגובה צריכה להיות המשאב. בשיטות אחרות, התשובה צריכה להיות מהסוג XxxResponse, כאשר Xxx הוא שם השיטה המקורי. לדוגמה, אם שם השיטה המקורי הוא TakeSnapshot(), סוג התגובה שמוסק הוא TakeSnapshotResponse.

WaitOperationRequest

ההודעה עם הבקשה מ-Operations.WaitOperation.

שדות
name

string

השם של משאב הפעולה שממתינים לסיום שלו.
timeout

Duration

משך הזמן המקסימלי להמתנה לפני סיום הזמן הקצוב לתפוגה. אם משאירים את השדה ריק, ההמתנה תהיה לכל היותר הזמן שמותר לפי פרוטוקול ה-HTTP/RPC הבסיסי. אם מציינים גם תאריך יעד להקשר של RPC, המערכת תשתמש בתאריך הקצר יותר.