Package google.longrunning

সূচক

অপারেশন

একটি API পরিষেবার সাথে দীর্ঘ-চলমান ক্রিয়াকলাপগুলি পরিচালনা করে।

যখন একটি API পদ্ধতি সাধারণত সম্পূর্ণ হতে দীর্ঘ সময় নেয়, তখন এটি ক্লায়েন্টকে Operation ফেরত দেওয়ার জন্য ডিজাইন করা যেতে পারে এবং ক্লায়েন্ট এই ইন্টারফেসটি ব্যবহার করে অসিঙ্ক্রোনাসভাবে অপারেশন রিসোর্স পোলিং করে বাস্তব প্রতিক্রিয়া পেতে পারে, অথবা অপারেশন রিসোর্সটি অন্য এপিআইতে পাস করতে পারে ( যেমন Pub/Sub API) প্রতিক্রিয়া পেতে। যে কোনও API পরিষেবা যা দীর্ঘ-চলমান ক্রিয়াকলাপগুলিকে ফিরিয়ে দেয় Operations ইন্টারফেস প্রয়োগ করা উচিত যাতে বিকাশকারীদের একটি ধারাবাহিক ক্লায়েন্ট অভিজ্ঞতা থাকতে পারে।

অপারেশন বাতিল করুন

rpc CancelOperation( CancelOperationRequest ) returns ( Empty )

একটি দীর্ঘ-চলমান অপারেশনে অ্যাসিঙ্ক্রোনাস বাতিলকরণ শুরু করে। সার্ভার অপারেশন বাতিল করার জন্য সর্বোত্তম প্রচেষ্টা করে, কিন্তু সাফল্য নিশ্চিত করা হয় না। সার্ভার এই পদ্ধতি সমর্থন না করলে, এটি google.rpc.Code.UNIMPLEMENTED প্রদান করে। বাতিলকরণ সফল হয়েছে কিনা বা বাতিল হওয়া সত্ত্বেও অপারেশন সম্পন্ন হয়েছে কিনা তা পরীক্ষা করতে গ্রাহকরা Operations.GetOperation বা অন্যান্য পদ্ধতি ব্যবহার করতে পারেন। সফল বাতিলকরণে, অপারেশনটি মুছে ফেলা হয় না; পরিবর্তে, এটি Code.CANCELLED এর সাথে সম্পর্কিত 1 এর google.rpc.Status.code সহ একটি Operation.error মান সহ একটি অপারেশন হয়ে যায়।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগ প্রয়োজন:

  • https://www.googleapis.com/auth/cloud-platform
ডিলিট অপারেশন

rpc DeleteOperation( DeleteOperationRequest ) returns ( Empty )

একটি দীর্ঘ-চলমান অপারেশন মুছে দেয়। এই পদ্ধতিটি নির্দেশ করে যে ক্লায়েন্ট আর অপারেশন ফলাফলে আগ্রহী নয়। এটি অপারেশন বাতিল করে না। সার্ভার এই পদ্ধতি সমর্থন না করলে, এটি google.rpc.Code.UNIMPLEMENTED প্রদান করে।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগ প্রয়োজন:

  • https://www.googleapis.com/auth/cloud-platform
GetOperation

rpc GetOperation( GetOperationRequest ) returns ( Operation )

দীর্ঘস্থায়ী অপারেশনের সর্বশেষ অবস্থা পায়। ক্লায়েন্টরা API পরিষেবা দ্বারা সুপারিশকৃত বিরতিতে অপারেশন ফলাফল পোল করতে এই পদ্ধতি ব্যবহার করতে পারেন।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগ প্রয়োজন:

  • https://www.googleapis.com/auth/cloud-platform
আইএএম অনুমতি

name সম্পদে নিম্নলিখিত IAM অনুমতি প্রয়োজন:

  • routeoptimization.operations.get

আরও তথ্যের জন্য, IAM ডকুমেন্টেশন দেখুন।

লিস্ট অপারেশন

rpc ListOperations( ListOperationsRequest ) returns ( ListOperationsResponse )

অনুরোধে নির্দিষ্ট ফিল্টারের সাথে মেলে এমন ক্রিয়াকলাপগুলিকে তালিকাভুক্ত করে৷ যদি সার্ভার এই পদ্ধতিটি সমর্থন না করে, তাহলে এটি UNIMPLEMENTED ফেরত দেয়।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগ প্রয়োজন:

  • https://www.googleapis.com/auth/cloud-platform
ওয়েট অপারেশন

rpc WaitOperation( WaitOperationRequest ) returns ( Operation )

সুনির্দিষ্ট দীর্ঘ-চলমান ক্রিয়াকলাপটি সম্পন্ন না হওয়া পর্যন্ত বা সর্বাধিক একটি নির্দিষ্ট টাইমআউটে পৌঁছানো পর্যন্ত অপেক্ষা করুন, সর্বশেষ অবস্থায় ফিরে আসবে। অপারেশন ইতিমধ্যে সম্পন্ন হলে, সর্বশেষ অবস্থা অবিলম্বে ফিরে আসে। নির্দিষ্ট সময়সীমা ডিফল্ট HTTP/RPC টাইমআউটের চেয়ে বেশি হলে, HTTP/RPC টাইমআউট ব্যবহার করা হয়। যদি সার্ভার এই পদ্ধতি সমর্থন না করে, তাহলে এটি google.rpc.Code.UNIMPLEMENTED প্রদান করে। মনে রাখবেন যে এই পদ্ধতিটি সর্বোত্তম প্রচেষ্টার ভিত্তিতে। এটি নির্দিষ্ট টাইমআউটের আগে (তাৎক্ষণিক সহ) সর্বশেষ অবস্থা ফিরিয়ে দিতে পারে, যার অর্থ এমনকি একটি তাত্ক্ষণিক প্রতিক্রিয়াও অপারেশনটি সম্পন্ন হওয়ার গ্যারান্টি নয়।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগ প্রয়োজন:

  • https://www.googleapis.com/auth/cloud-platform

অপারেশন রিকোয়েস্ট বাতিল করুন

Operations.CancelOperation জন্য অনুরোধ বার্তা।

ক্ষেত্র
name

string

অপারেশন রিসোর্সের নাম বাতিল করা হবে।

ডিলিট অপারেশন রিকোয়েস্ট

Operations.DeleteOperation জন্য অনুরোধ বার্তা।

ক্ষেত্র
name

string

অপারেশন রিসোর্সের নাম মুছে ফেলা হবে।

GetOperationRequest

Operations.GetOperation এর জন্য অনুরোধ বার্তা।

ক্ষেত্র
name

string

অপারেশন রিসোর্সের নাম।

ListOperations Request

Operations.ListOperations এর জন্য অনুরোধ বার্তা।

ক্ষেত্র
name

string

অপারেশনের মূল সম্পদের নাম।

filter

string

স্ট্যান্ডার্ড তালিকা ফিল্টার।

page_size

int32

আদর্শ তালিকা পৃষ্ঠার আকার।

page_token

string

স্ট্যান্ডার্ড লিস্ট পেজ টোকেন।

তালিকা অপারেশন প্রতিক্রিয়া

Operations.ListOperations এর জন্য প্রতিক্রিয়া বার্তা।

ক্ষেত্র
operations[]

Operation

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

next_page_token

string

আদর্শ তালিকা পরবর্তী পৃষ্ঠার টোকেন।

অপারেশন

এই সংস্থানটি একটি দীর্ঘ-চলমান ক্রিয়াকলাপের প্রতিনিধিত্ব করে যা একটি নেটওয়ার্ক API কলের ফলাফল।

ক্ষেত্র
name

string

সার্ভার দ্বারা নির্ধারিত নাম, যা শুধুমাত্র একই পরিষেবার মধ্যে অনন্য যা মূলত এটিকে ফেরত দেয়। আপনি যদি ডিফল্ট HTTP ম্যাপিং ব্যবহার করেন, তাহলে name operations/{unique_id} দিয়ে শেষ হওয়া একটি সংস্থান নাম হওয়া উচিত।

metadata

Any

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

done

bool

যদি মানটি false হয়, তাহলে এর অর্থ অপারেশন এখনও চলছে। true হলে, অপারেশন সম্পন্ন হয়, এবং হয় error বা response পাওয়া যায়।

ইউনিয়ন ক্ষেত্রের result । অপারেশন ফলাফল, যা একটি error বা একটি বৈধ response হতে পারে। যদি done == false , কোন error বা response সেট করা হয় না। যদি done == true , ঠিক একটি error বা response সেট করা যেতে পারে। কিছু পরিষেবা ফলাফল নাও দিতে পারে। result শুধুমাত্র নিম্নলিখিত একটি হতে পারে:
error

Status

ব্যর্থতা বা বাতিলের ক্ষেত্রে অপারেশনের ত্রুটির ফলাফল।

response

Any

অপারেশনের স্বাভাবিক, সফল প্রতিক্রিয়া। যদি মূল পদ্ধতিটি সফলতার কোনো ডেটা না দেয়, যেমন Delete , তাহলে প্রতিক্রিয়া হল google.protobuf.Empty । যদি মূল পদ্ধতিটি মানক হয় Get / Create / Update , তাহলে রিসোর্স রিসোর্স হওয়া উচিত। অন্যান্য পদ্ধতির জন্য, প্রতিক্রিয়াটিতে XxxResponse টাইপ হওয়া উচিত, যেখানে Xxx হল মূল পদ্ধতির নাম। উদাহরণস্বরূপ, যদি মূল পদ্ধতির নাম হয় TakeSnapshot() , তাহলে অনুমিত প্রতিক্রিয়ার ধরনটি হল TakeSnapshotResponse ।

অপেক্ষা করুন অপারেশন অনুরোধ

Operations.WaitOperation জন্য অনুরোধ বার্তা। অপেক্ষা করুন অপারেশন।

ক্ষেত্র
name

string

অপেক্ষা করার জন্য অপারেশন রিসোর্সের নাম।

timeout

Duration

সময় শেষ হওয়ার আগে অপেক্ষা করার সর্বোচ্চ সময়কাল। যদি ফাঁকা রাখা হয়, তাহলে অপেক্ষা করা হবে অন্তর্নিহিত HTTP/RPC প্রোটোকল দ্বারা অনুমোদিত সময়। যদি RPC প্রসঙ্গের সময়সীমাও নির্দিষ্ট করা থাকে, তাহলে সংক্ষিপ্তটি ব্যবহার করা হবে।