संसाधन: ऑपरेशन
यह संसाधन लंबे समय तक चलने वाले ऑपरेशन का प्रतिनिधित्व करता है जो नेटवर्क एपीआई कॉल का परिणाम है।
JSON प्रतिनिधित्व |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
खेत | |
---|---|
name | सर्वर द्वारा निर्दिष्ट नाम, जो केवल उसी सेवा के भीतर अद्वितीय है जो मूल रूप से इसे लौटाता है। यदि आप डिफ़ॉल्ट HTTP मैपिंग का उपयोग करते हैं, |
metadata | ऑपरेशन से जुड़ा सेवा-विशिष्ट मेटाडेटा। इसमें आम तौर पर प्रगति की जानकारी और सामान्य मेटाडेटा जैसे निर्माण समय शामिल होता है। कुछ सेवाएँ ऐसा मेटाडेटा प्रदान नहीं कर सकती हैं। कोई भी विधि जो लंबे समय तक चलने वाले ऑपरेशन को लौटाती है, उसे मेटाडेटा प्रकार, यदि कोई हो, का दस्तावेजीकरण करना चाहिए। एक वस्तु जिसमें मनमाना प्रकार के फ़ील्ड हों। एक अतिरिक्त फ़ील्ड |
done | यदि मान |
संघ क्षेत्र result . ऑपरेशन परिणाम, जो या तो एक error या वैध response हो सकता है। यदि done == false , तो न तो error और न ही response सेट की जाती है। यदि done == true , तो error या response में से कोई एक सेट किया जा सकता है। कुछ सेवाएँ परिणाम प्रदान नहीं कर सकती हैं। result निम्न में से केवल एक ही हो सकता है: | |
error | विफलता या रद्दीकरण की स्थिति में ऑपरेशन का त्रुटि परिणाम। |
response | ऑपरेशन की सामान्य, सफल प्रतिक्रिया. यदि मूल विधि सफलता पर कोई डेटा नहीं लौटाती है, जैसे कि एक वस्तु जिसमें मनमाना प्रकार के फ़ील्ड हों। एक अतिरिक्त फ़ील्ड |
तरीकों | |
---|---|
| लंबे समय से चल रहे ऑपरेशन की नवीनतम स्थिति प्राप्त करता है। |
| उन परिचालनों को सूचीबद्ध करता है जो अनुरोध में निर्दिष्ट फ़िल्टर से मेल खाते हैं। |