REST Resource: projects.locations.operations

משאב: פעולה

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

ייצוג ב-JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of mutually exclusive fields.
}
שדות
name

string

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

object

{

‫createTime: השעה שבה נוצרה הפעולה.

‫endTime: השעה שבה הסתיימה ההרצה של הפעולה.

target: נתיב המשאב שמוגדר על ידי השרת עבור היעד של הפעולה.

‫verb: שם הפועל שהפעולה מבצעת.

‫statusDetail: סטטוס הפעולה שקריא לאנשים, אם יש.

‫cancelRequested: מציין אם המשתמש ביקש לבטל את הפעולה. לפעולות שבוטלו בהצלחה יש ערך Operation.error עם google.rpc.Status.code של 1, שמתאים ל-Code.CANCELLED.

‫apiVersion: גרסת ה-API ששימשה להפעלת הפעולה.

}
done

boolean

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

object (Status)

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

object

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

Methods

cancel

 מתחיל ביטול אסינכרוני של פעולה ממושכת.

delete

 מחיקת פעולה ממושכת.

get

 מקבל את המצב העדכני של פעולה ממושכת.

list

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