Package google.longrunning

אינדקס

תפעול

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

כאשר השלמה של שיטת 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

הטוקן הרגיל של דף הרשימה.

ListOperationsResponse

הודעת התגובה עבור Operations.ListOperations.

שדות
operations[]

Operation

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

string

האסימון הרגיל לדף הבא ברשימה.

פעולה

המשאב הזה מייצג פעולה ממושכת שמוחזרת מקריאה ל-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 הוא שם השיטה המקורית. לדוגמה, אם השם המקורי של ה-method הוא TakeSnapshot(), סוג התגובה שמתקבלת הוא TakeSnapshotResponse.

WaitOperationRequest

הודעת הבקשה עבור Operations.WaitOperation.

שדות
name

string

השם של משאב הפעולה שצריך להמתין עליו.
timeout

Duration

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