این منبع یک عملیات طولانی مدت را نشان می دهد که نتیجه تماس API شبکه است.
نمایندگی JSON | |
---|---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
زمینه های | ||
---|---|---|
name | نام اختصاص داده شده به سرور، که فقط در سرویسی که در ابتدا آن را برمی گرداند منحصر به فرد است. اگر شما استفاده از پیش فرض HTTP نقشه برداری، | |
metadata | فراداده خاص سرویس مرتبط با عملیات. معمولاً حاوی اطلاعات پیشرفت و ابرداده های رایج مانند زمان ایجاد است. برخی از خدمات ممکن است چنین متادیتا را ارائه ندهند. هر روشی که عملیات طولانیمدت را برمیگرداند، در صورت وجود، باید نوع ابرداده را مستند کند. یک شی حاوی فیلدهایی از نوع دلخواه. یک قسمت دیگر | |
done | اگر مقدار است | |
اتحادیه درست result . نتیجه این عملیات، که می تواند هر error و یا معتبر response . اگر done == false ، نه error و نه response تنظیم شده است. اگر done == true ، دقیقا یکی از error و یا response تنظیم شده است. result می تواند تنها یکی از موارد زیر: | ||
error | نتیجه خطای عملیات در صورت خرابی یا لغو. | |
response | پاسخ طبیعی عملیات در صورت موفقیت. اگر از روش های اصلی هیچ اطلاعاتی در موفقیت، مانند گرداند یک شی حاوی فیلدهایی از نوع دلخواه. یک قسمت دیگر |