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

השדה הזה יכיל אובייקט DevicesLongRunningOperationMetadata אם הפעולה נוצרה על ידי claimAsync, unclaimAsync או updateMetadataAsync.

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

השדה הזה לא יוגדר תמיד אם הפעולה נוצרה על ידי claimAsync, unclaimAsync או updateMetadataAsync. במקרה כזה, פרטי השגיאות של כל מכשיר מוגדרים בresponse.perDeviceStatus.result.status.
response

object

השדה הזה יכיל אובייקט DevicesLongRunningOperationResponse אם הפעולה נוצרה על ידי claimAsync, unclaimAsync או updateMetadataAsync.

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

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

string

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

object

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

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

שיטות

get

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