REST Resource: operations

রিসোর্স: অপারেশন

এই রিসোর্সটি দীর্ঘ সময় ধরে চলা অপারেশনকে দেখায় যা নেটওয়ার্ক API কলের ফলাফল।

JSON উপস্থাপনা 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
}
ফিল্ড
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 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

সমস্যার বিবরণ সহ মেসেজের তালিকা। API-এর ব্যবহারের জন্য মেসেজের ধরনের একটি সাধারণ সেট আছে।

এমন একটি অবজেক্ট যাতে ইচ্ছামতো ধরনের ফিল্ড আছে। একটি অতিরিক্ত ফিল্ড "@type"-এ ধরন শনাক্তকারী URI থাকে। উদাহরণ: { "id": 1234, "@type": "types.example.com/standard/id" }।

পদ্ধতি

cancel

 দীর্ঘ সময় ধরে চলা অপারেশনে অ্যাসিঙ্ক্রোনাস বাতিলকরণ শুরু করে।

delete

 দীর্ঘ সময় ধরে চলা অপারেশন মুছে দেয়।

get

 দীর্ঘ সময় ধরে চলা অপারেশনের লেটেস্ট স্ট্যাটাস পায়।

list

 অনুরোধে নির্দিষ্ট করা ফিল্টারের সাথে মেলে এমন অপারেশন তালিকাভুক্ত করে।