Operation
משאב זה מייצג פעולה ארוכת טווח שהיא תוצאה של קריאת 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/some/unique/name . |
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" } . |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2019-12-03 (שעון UTC).
[null,null,["עדכון אחרון: 2019-12-03 (שעון UTC)."],[],[]]