Package google.longrunning

अनुक्रमणिका

संचालन

एपीआई सेवा के साथ लंबे समय तक चलने वाले संचालन का प्रबंधन करता है।

जब एक एपीआई विधि को पूरा होने में सामान्य रूप से लंबा समय लगता है, तो इसे क्लाइंट को Operation वापस करने के लिए डिज़ाइन किया जा सकता है, और क्लाइंट इस इंटरफ़ेस का उपयोग ऑपरेशन संसाधन को मतदान करके अतुल्यकालिक रूप से वास्तविक प्रतिक्रिया प्राप्त करने के लिए कर सकता है, या ऑपरेशन संसाधन को किसी अन्य एपीआई में पास कर सकता है ( जैसे पब/सब एपीआई) प्रतिक्रिया प्राप्त करने के लिए। कोई भी एपीआई सेवा जो लंबे समय तक चलने वाले ऑपरेशंस लौटाती है, उसे 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/datastore
  • https://www.googleapis.com/auth/cloud-platform

अधिक जानकारी के लिए, प्रमाणीकरण अवलोकन देखें।

डिलीटऑपरेशन

rpc DeleteOperation( DeleteOperationRequest ) returns ( Empty )

लंबे समय से चल रहे ऑपरेशन को हटा देता है. यह विधि इंगित करती है कि ग्राहक को अब ऑपरेशन परिणाम में कोई दिलचस्पी नहीं है। यह ऑपरेशन रद्द नहीं करता. यदि सर्वर इस पद्धति का समर्थन नहीं करता है, तो यह google.rpc.Code.UNIMPLEMENTED लौटाता है।

प्राधिकरण के दायरे

निम्नलिखित OAuth स्कोप में से एक की आवश्यकता है:

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

अधिक जानकारी के लिए, प्रमाणीकरण अवलोकन देखें।

ऑपरेशन प्राप्त करें

rpc GetOperation( GetOperationRequest ) returns ( Operation )

लंबे समय से चल रहे ऑपरेशन की नवीनतम स्थिति प्राप्त करता है। एपीआई सेवा द्वारा अनुशंसित अंतराल पर ऑपरेशन परिणाम का सर्वेक्षण करने के लिए ग्राहक इस पद्धति का उपयोग कर सकते हैं।

प्राधिकरण के दायरे

निम्नलिखित OAuth स्कोप में से एक की आवश्यकता है:

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

अधिक जानकारी के लिए, प्रमाणीकरण अवलोकन देखें।

सूचीसंचालन

rpc ListOperations( ListOperationsRequest ) returns ( ListOperationsResponse )

उन परिचालनों को सूचीबद्ध करता है जो अनुरोध में निर्दिष्ट फ़िल्टर से मेल खाते हैं। यदि सर्वर इस विधि का समर्थन नहीं करता है, तो यह UNIMPLEMENTED लौटाता है।

प्राधिकरण के दायरे

निम्नलिखित OAuth स्कोप में से एक की आवश्यकता है:

  • https://www.googleapis.com/auth/datastore
  • 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/datastore
  • https://www.googleapis.com/auth/cloud-platform

अधिक जानकारी के लिए, प्रमाणीकरण अवलोकन देखें।

ऑपरेशन अनुरोध रद्द करें

Operations.CancelOperation के लिए अनुरोध संदेश।

खेत
name

string

रद्द किए जाने वाले ऑपरेशन संसाधन का नाम.

DeleteOperationRequest

Operations.DeleteOperation के लिए अनुरोध संदेश।

खेत
name

string

हटाए जाने वाले ऑपरेशन संसाधन का नाम.

GetOperationRequest

Operations.GetOperation के लिए अनुरोध संदेश।

खेत
name

string

ऑपरेशन संसाधन का नाम.

सूचीसंचालनअनुरोध

Operations.ListOperations के लिए अनुरोध संदेश।

खेत
name

string

ऑपरेशन के मूल संसाधन का नाम.

filter

string

मानक सूची फ़िल्टर.

page_size

int32

मानक सूची पृष्ठ का आकार.

page_token

string

मानक सूची पृष्ठ टोकन.

सूची संचालन प्रतिक्रिया

Operations.ListOperations के लिए प्रतिक्रिया संदेश।

खेत
operations[]

Operation

परिचालनों की एक सूची जो अनुरोध में निर्दिष्ट फ़िल्टर से मेल खाती है।

next_page_token

string

मानक सूची अगले पृष्ठ का टोकन।

संचालन

यह संसाधन लंबे समय तक चलने वाले ऑपरेशन का प्रतिनिधित्व करता है जो नेटवर्क एपीआई कॉल का परिणाम है।

खेत
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 प्रोटोकॉल द्वारा अनुमत अधिकतम समय होगी। यदि आरपीसी संदर्भ की समय सीमा भी निर्दिष्ट है, तो छोटे का उपयोग किया जाएगा।