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

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

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

שיטות

get

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