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