REST Resource: customers.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

অপারেশনের সাথে যুক্ত পরিষেবা-নির্দিষ্ট মেটাডেটা। এতে সাধারণত প্রোগ্রেস সংক্রান্ত তথ্য এবং সাধারণ মেটাডেটা যেমন, তৈরি করার সময় থাকে। কিছু পরিষেবা এই ধরনের মেটাডেটা নাও দিতে পারে। দীর্ঘ সময় ধরে চলা অপারেশন রিটার্ন করে এমন যেকোনও পদ্ধতিতে মেটাডেটার ধরন উল্লেখ করা উচিত, যদি থাকে।
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।
মিউচুয়ালি এক্সক্লুসিভ ফিল্ডের শেষ।

স্ট্যাটাস

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-এর ব্যবহারের জন্য মেসেজের ধরনের একটি সাধারণ সেট আছে।

পদ্ধতি

get

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