REST Resource: operations

משאב: פעולה

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

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

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
שדות
name

string

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

object

אובייקט QueryMetadata שמכיל נתונים ספציפיים לשירות המשויכים לפעולה.

אובייקט המכיל שדות מסוג שרירותי. שדה נוסף, "@type", מכיל URI שמזהה את הסוג. דוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }
done

boolean

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

object (Status)

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

object

אובייקט QueryResponse, יוחזר אם פעולת השאילתה הושלמה.

אובייקט המכיל שדות מסוג שרירותי. שדה נוסף, "@type", מכיל URI שמזהה את הסוג. דוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }

סטטוס

סוג Status מגדיר מודל שגיאות לוגית שמתאים לסביבות תכנות שונות, כולל API ל-REST וממשקי API של RPC. הוא נמצא בשימוש של gRPC. כל הודעת Status מכילה שלושה קטעי נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה.

מידע נוסף על מודל השגיאה הזה ועל אופן הפעולה שלו זמין במדריך לעיצוב API.

ייצוג JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
שדות
code

integer

קוד הסטטוס, שאמור להיות ערך enum של google.rpc.Code.
message

string

הודעת שגיאה שמוצגת למפתח, שאמורה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמש צריכה להיות מותאמת לשוק המקומי ולשלוח אותה בשדה google.rpc.Status.details. הטקסט צריך להתאים לשוק המקומי.
details[]

object

רשימה של הודעות עם פרטי השגיאה. יש קבוצה משותפת של סוגי הודעות שאפשר להשתמש בהם בממשקי API.

אובייקט המכיל שדות מסוג שרירותי. שדה נוסף, "@type", מכיל URI שמזהה את הסוג. דוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }

שיטות

cancel

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

delete

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

get

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

list

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

wait

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