Method: projects.databases.operations.cancel

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

בקשת HTTP

POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*/operations/*}:cancel

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
name

string

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

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הביצוע יהיה תקין, גוף התגובה יהיה ריק.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

מידע נוסף זמין בסקירה הכללית על אימות.