Package google.longrunning

সূচী

অপারেশন

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

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

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

rpc CancelOperation( CancelOperationRequest ) returns ( Empty )

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

অনুমোদনের পরিধি

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

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

rpc DeleteOperation( DeleteOperationRequest ) returns ( Empty )

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

অনুমোদনের পরিধি

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

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

rpc GetOperation( GetOperationRequest ) returns ( Operation )

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

অনুমোদনের পরিধি

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

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

name রিসোর্সটিতে নিম্নলিখিত IAM পারমিশন প্রয়োজন:

  • routeoptimization.operations.get

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

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

rpc ListOperations( ListOperationsRequest ) returns ( ListOperationsResponse )

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

অনুমোদনের পরিধি

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

  • https://www.googleapis.com/auth/cloud-platform
অপেক্ষা অপারেশন

rpc WaitOperation( WaitOperationRequest ) returns ( Operation )

(বর্তমানে অসমর্থিত) নির্দিষ্ট দীর্ঘ-সময় ধরে চলা অপারেশনটি সম্পন্ন হওয়া পর্যন্ত অথবা সর্বাধিক একটি নির্দিষ্ট টাইমআউট পর্যন্ত অপেক্ষা করে এবং সর্বশেষ অবস্থাটি ফেরত দেয়।

অনুমোদনের পরিধি

নিম্নলিখিত 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 সেট করে এবং একাধিক কালেকশন থেকে ডেটা পড়ে, তখন এটি তৈরি হয়। উদাহরণস্বরূপ, সমস্ত সমর্থিত লোকেশনের সমস্ত রিসোর্সের তালিকা করার চেষ্টার সময়।

অপারেশন

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

ক্ষেত্র
name

string

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

metadata

Any

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

done

bool

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

ইউনিয়ন ফিল্ড ' result । এটি অপারেশনের ফলাফল, যা একটি error (error) অথবা একটি বৈধ response (valid 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 কনটেক্সট ডেডলাইনও নির্দিষ্ট করা থাকে, তবে কম সময়টি ব্যবহৃত হবে।