अनुक्रमणिका
-
Operations
(इंटरफ़ेस) -
CancelOperationRequest
(संदेश) -
DeleteOperationRequest
(संदेश) -
GetOperationRequest
(संदेश) -
ListOperationsRequest
(संदेश) -
ListOperationsResponse
(संदेश) -
Operation
(संदेश) -
WaitOperationRequest
(संदेश)
संचालन
एपीआई सेवा के साथ लंबे समय तक चलने वाले संचालन का प्रबंधन करता है।
जब एक एपीआई विधि को पूरा होने में सामान्य रूप से लंबा समय लगता है, तो इसे क्लाइंट को Operation
वापस करने के लिए डिज़ाइन किया जा सकता है, और क्लाइंट इस इंटरफ़ेस का उपयोग ऑपरेशन संसाधन को मतदान करके अतुल्यकालिक रूप से वास्तविक प्रतिक्रिया प्राप्त करने के लिए कर सकता है, या ऑपरेशन संसाधन को किसी अन्य एपीआई में पास कर सकता है ( जैसे पब/सब एपीआई) प्रतिक्रिया प्राप्त करने के लिए। कोई भी एपीआई सेवा जो लंबे समय तक चलने वाले ऑपरेशंस लौटाती है, उसे Operations
इंटरफ़ेस लागू करना चाहिए ताकि डेवलपर्स को लगातार क्लाइंट अनुभव मिल सके।
ऑपरेशन रद्द करें |
---|
लंबे समय तक चलने वाले ऑपरेशन पर अतुल्यकालिक रद्दीकरण प्रारंभ करता है। सर्वर ऑपरेशन को रद्द करने का सर्वोत्तम प्रयास करता है, लेकिन सफलता की गारंटी नहीं है। यदि सर्वर इस पद्धति का समर्थन नहीं करता है, तो यह
|
डिलीटऑपरेशन |
---|
लंबे समय से चल रहे ऑपरेशन को हटा देता है. यह विधि इंगित करती है कि ग्राहक को अब ऑपरेशन परिणाम में कोई दिलचस्पी नहीं है। यह ऑपरेशन रद्द नहीं करता. यदि सर्वर इस पद्धति का समर्थन नहीं करता है, तो यह
|
ऑपरेशन प्राप्त करें |
---|
लंबे समय से चल रहे ऑपरेशन की नवीनतम स्थिति प्राप्त करता है। एपीआई सेवा द्वारा अनुशंसित अंतराल पर ऑपरेशन परिणाम का सर्वेक्षण करने के लिए ग्राहक इस पद्धति का उपयोग कर सकते हैं।
|
सूचीसंचालन |
---|
उन परिचालनों को सूचीबद्ध करता है जो अनुरोध में निर्दिष्ट फ़िल्टर से मेल खाते हैं। यदि सर्वर इस विधि का समर्थन नहीं करता है, तो यह
|
प्रतीक्षा ऑपरेशन |
---|
निर्दिष्ट लंबे समय तक चलने वाला ऑपरेशन पूरा होने तक प्रतीक्षा करता है या अधिकतम निर्दिष्ट टाइमआउट तक पहुंचने पर नवीनतम स्थिति लौटाता है। यदि ऑपरेशन पहले ही हो चुका है, तो नवीनतम स्थिति तुरंत लौटा दी जाती है। यदि निर्दिष्ट टाइमआउट डिफ़ॉल्ट HTTP/RPC टाइमआउट से अधिक है, तो HTTP/RPC टाइमआउट का उपयोग किया जाता है। यदि सर्वर इस पद्धति का समर्थन नहीं करता है, तो यह
|
ऑपरेशन अनुरोध रद्द करें
Operations.CancelOperation
के लिए अनुरोध संदेश।
खेत | |
---|---|
name | रद्द किए जाने वाले ऑपरेशन संसाधन का नाम. |
DeleteOperationRequest
Operations.DeleteOperation
के लिए अनुरोध संदेश।
खेत | |
---|---|
name | हटाए जाने वाले ऑपरेशन संसाधन का नाम. |
GetOperationRequest
Operations.GetOperation
के लिए अनुरोध संदेश।
खेत | |
---|---|
name | ऑपरेशन संसाधन का नाम. |
सूचीसंचालनअनुरोध
Operations.ListOperations
के लिए अनुरोध संदेश।
खेत | |
---|---|
name | ऑपरेशन के मूल संसाधन का नाम. |
filter | मानक सूची फ़िल्टर. |
page_size | मानक सूची पृष्ठ का आकार. |
page_token | मानक सूची पृष्ठ टोकन. |
सूची संचालन प्रतिक्रिया
Operations.ListOperations
के लिए प्रतिक्रिया संदेश।
खेत | |
---|---|
operations[] | परिचालनों की एक सूची जो अनुरोध में निर्दिष्ट फ़िल्टर से मेल खाती है। |
next_page_token | मानक सूची अगले पृष्ठ का टोकन। |
संचालन
यह संसाधन लंबे समय तक चलने वाले ऑपरेशन का प्रतिनिधित्व करता है जो नेटवर्क एपीआई कॉल का परिणाम है।
खेत | |
---|---|
name | सर्वर द्वारा निर्दिष्ट नाम, जो केवल उसी सेवा के भीतर अद्वितीय है जो मूल रूप से इसे लौटाता है। यदि आप डिफ़ॉल्ट HTTP मैपिंग का उपयोग करते हैं, |
metadata | ऑपरेशन से जुड़ा सेवा-विशिष्ट मेटाडेटा। इसमें आम तौर पर प्रगति की जानकारी और सामान्य मेटाडेटा जैसे निर्माण समय शामिल होता है। कुछ सेवाएँ ऐसा मेटाडेटा प्रदान नहीं कर सकती हैं। कोई भी विधि जो लंबे समय तक चलने वाले ऑपरेशन को लौटाती है, उसे मेटाडेटा प्रकार, यदि कोई हो, का दस्तावेजीकरण करना चाहिए। |
done | यदि मान |
संघ क्षेत्र result . ऑपरेशन परिणाम, जो या तो एक error या वैध response हो सकता है। यदि done == false , तो न तो error और न ही response सेट की जाती है। यदि done == true , तो error या response में से कोई एक सेट किया जा सकता है। कुछ सेवाएँ परिणाम प्रदान नहीं कर सकती हैं। result निम्न में से केवल एक ही हो सकता है: | |
error | विफलता या रद्दीकरण की स्थिति में ऑपरेशन का त्रुटि परिणाम। |
response | ऑपरेशन की सामान्य, सफल प्रतिक्रिया. यदि मूल विधि सफलता पर कोई डेटा नहीं लौटाती है, जैसे कि |
प्रतीक्षाऑपरेशनअनुरोध
Operations.WaitOperation
के लिए अनुरोध संदेश।
खेत | |
---|---|
name | प्रतीक्षा करने के लिए ऑपरेशन संसाधन का नाम. |
timeout | समय समाप्त होने से पहले प्रतीक्षा करने की अधिकतम अवधि. यदि खाली छोड़ दिया जाता है, तो प्रतीक्षा अंतर्निहित HTTP/RPC प्रोटोकॉल द्वारा अनुमत अधिकतम समय होगी। यदि आरपीसी संदर्भ की समय सीमा भी निर्दिष्ट है, तो छोटे का उपयोग किया जाएगा। |