Package google.longrunning

সূচক

অপারেশনস

একটি API পরিষেবার মাধ্যমে দীর্ঘমেয়াদী কার্যক্রম পরিচালনা করে।

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

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

rpc CancelOperation( CancelOperationRequest ) returns ( Empty )

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

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

নিম্নলিখিত 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
IAM অনুমতি

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

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

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

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

ক্ষেত্র
name

string

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

filter

string

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

page_size

int32

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

page_token

string

স্ট্যান্ডার্ড তালিকা পৃষ্ঠা টোকেন।

return_partial_success

bool

যখন true তে সেট করা হয়, তখন যে ক্রিয়াকলাপগুলি পৌঁছানো যায় সেগুলি স্বাভাবিক হিসাবে ফেরত পাঠানো হয় এবং যেগুলি পৌঁছানো যায় না সেগুলি [ListOperationsResponse.unreachable] ক্ষেত্রে ফেরত পাঠানো হয়।

এটি কেবল তখনই true হতে পারে যখন বিভিন্ন সংগ্রহ জুড়ে পড়া হয়, যেমন যখন parent "projects/example/locations/-" তে সেট করা থাকে।

এই ক্ষেত্রটি ডিফল্টভাবে সমর্থিত নয় এবং পরিষেবা বা পণ্য নির্দিষ্ট ডকুমেন্টেশনে স্পষ্টভাবে অন্যথায় নথিভুক্ত না করা হলে সেট করা হলে একটি UNIMPLEMENTED ত্রুটি দেখা দেবে।

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

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

ক্ষেত্র
operations[]

Operation

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

next_page_token

string

স্ট্যান্ডার্ড তালিকা পরবর্তী পৃষ্ঠার টোকেন।

unreachable[]

string

অক্রমিক তালিকা। অপ্রাপ্য সম্পদ। অনুরোধটি ListOperationsRequest.return_partial_success সেট করলে পূর্ণ হয় এবং সংগ্রহ জুড়ে পড়ে, উদাহরণস্বরূপ, সমস্ত সমর্থিত অবস্থান জুড়ে সমস্ত সম্পদ তালিকাভুক্ত করার চেষ্টা করার সময়।

অপারেশন

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

ক্ষেত্র
name

string

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

metadata

Any

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

done

bool

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

Union ফিল্ড 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 প্রসঙ্গ সময়সীমাও নির্দিষ্ট করা থাকে, তাহলে সংক্ষিপ্ত সময়কাল ব্যবহার করা হবে।