ListOperationsResponse

הודעת התשובה לגבי Operations.ListOperations.

ייצוג JSON 
{
  "operations": [
    {
      object (Operation)
    }
  ],
  "nextPageToken": string
}
שדות
operations[]

object (Operation)

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

string

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

פעולה

משאב זה מייצג פעולה ממושכת, שהיא תוצאה של קריאה ל-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

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

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@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

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

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

סטטוס

הסוג Status מגדיר מודל שגיאה לוגית שמתאים לסביבות תכנות שונות, כולל ממשקי REST API ו-RPC API. הוא משמש את 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" }