REST Resource: sdfdownloadtasks.operations

منبع: عملیات

این منبع نشان‌دهنده عملیاتی طولانی‌مدت است که نتیجه فراخوانی میانای برنامه‌سازی کاربردی شبکه است.

نمایش JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of mutually exclusive fields.
}
فیلدها
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 دردسترس است.
نتیجه عملیات که می‌تواند error یا response معتبر باشد. اگر done == false، نه error و نه response تنظیم نشده است. اگر done == true، دقیقاً یکی از error یا response می‌تواند تنظیم شود. ممکن است برخی‌از سرویس‌ها نتیجه را ارائه ندهند. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
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 و میاناهای برنامه‌سازی کاربردی RPC، مناسب است. gRPC از آن استفاده می‌کند. هر پیام Status حاوی سه بخش داده است: کد خطا، پیام خطا، و جزئیات خطا.

می‌توانید درباره این مدل خطا و نحوه کار با آن در راهنمای طراحی میانای برنامه‌سازی کاربردی بیشتر بدانید.

نمایش JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
فیلدها
code

integer

رمز وضعیت که باید مقدار شمارشی google.rpc.Code باشد.
message

string

پیام خطای توسعه‌دهنده که باید به زبان انگلیسی باشد. هر پیام خطای سَمت کاربر باید بومی‌سازی شود و در فیلد google.rpc.Status.details ارسال شود، یا توسط کارخواه بومی‌سازی شود.
details[]

object

فهرستی از پیام‌ها که جزئیات خطا را دربردارند. مجموعه مشترکی از انواع پیام برای استفاده میاناهای برنامه‌سازی کاربردی وجود دارد.

شیء حاوی فیلدهایی از نوع دلخواه. فیلد اضافی "@type" حاوی URI است که نوع را مشخص می‌کند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }.

روش‌ها

get

 جدیدترین وضعیت عملیات تکلیف بارگیری SDF ناهمگام را دریافت می‌کند.