REST Resource: curators.reports.operations

• সম্পদ: অপারেশন
  • JSON উপস্থাপনা
• অবস্থা
  • JSON উপস্থাপনা
• পদ্ধতি

সম্পদ: অপারেশন

এই রিসোর্সটি একটি দীর্ঘস্থায়ী অপারেশনকে নির্দেশ করে, যা একটি নেটওয়ার্ক এপিআই কলের ফলাফল।

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 (error) অথবা একটি বৈধ response (valid 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 মেসেজে তিনটি ডেটা থাকে: এরর কোড, এরর মেসেজ এবং এররের বিস্তারিত বিবরণ।

এই এরর মডেল এবং এটি নিয়ে কীভাবে কাজ করতে হয়, সে সম্পর্কে আরও জানতে আপনি এপিআই ডিজাইন গাইড দেখতে পারেন।

JSON উপস্থাপনা
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] }

ক্ষেত্র
code	integer স্ট্যাটাস কোডটি google.rpc.Code এর একটি enum ভ্যালু হওয়া উচিত।
message	string ডেভেলপারদের জন্য একটি ত্রুটির বার্তা, যা ইংরেজিতে হওয়া উচিত। ব্যবহারকারীদের জন্য যেকোনো ত্রুটির বার্তা স্থানীয়করণ করে google.rpc.Status.details ফিল্ডে পাঠাতে হবে, অথবা ক্লায়েন্ট দ্বারা স্থানীয়করণ করতে হবে।
details[]	object ত্রুটির বিবরণ বহনকারী বার্তাগুলির একটি তালিকা। এপিআই (API) ব্যবহারের জন্য কিছু সাধারণ বার্তা প্রকার রয়েছে। একটি অবজেক্ট যাতে যেকোনো ধরনের ফিল্ড থাকে। "@type" নামে একটি অতিরিক্ত ফিল্ড থাকে, যা ধরনটি শনাক্তকারী একটি URI ধারণ করে। উদাহরণ: { "id": 1234, "@type": "types.example.com/standard/id" } ।

পদ্ধতি
get	দীর্ঘদিন ধরে চলমান কোনো কার্যক্রমের সর্বশেষ অবস্থা জানায়।