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 API এবং RPC API সহ বিভিন্ন প্রোগ্রামিং পরিবেশের জন্য উপযুক্ত। এটি gRPC দ্বারা ব্যবহৃত হয়। প্রতিটি Status বার্তায় তিনটি টুকরো ডেটা থাকে: ত্রুটি কোড, ত্রুটি বার্তা এবং ত্রুটির বিবরণ।

আপনি API ডিজাইন গাইডে এই ত্রুটি মডেল এবং এটির সাথে কীভাবে কাজ করবেন সে সম্পর্কে আরও জানতে পারেন।

JSON প্রতিনিধিত্ব
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
ক্ষেত্র
code

integer

স্ট্যাটাস কোড, যা google.rpc.Code এর একটি enum মান হওয়া উচিত।

message

string

একটি বিকাশকারী-মুখী ত্রুটি বার্তা, যা ইংরেজিতে হওয়া উচিত। যেকোন ব্যবহারকারী-মুখী ত্রুটি বার্তা স্থানীয়করণ করা উচিত এবং google.rpc.Status.details ক্ষেত্রে পাঠানো উচিত, অথবা ক্লায়েন্ট দ্বারা স্থানীয়করণ করা উচিত।

details[]

object

ত্রুটির বিবরণ বহন করে এমন বার্তাগুলির একটি তালিকা৷ APIs ব্যবহার করার জন্য বার্তা প্রকারের একটি সাধারণ সেট আছে।

একটি নির্বিচারী ধরনের ক্ষেত্র ধারণকারী একটি বস্তু. একটি অতিরিক্ত ক্ষেত্র "@type" এ টাইপ সনাক্তকারী একটি URI রয়েছে৷ উদাহরণ: { "id": 1234, "@type": "types.example.com/standard/id" } ।

পদ্ধতি

get

 দীর্ঘস্থায়ী অপারেশনের সর্বশেষ অবস্থা পায়।