संसाधन: ऑपरेशन
यह रिसॉर्स, लंबे समय तक चलने वाली उस कार्रवाई को दिखाता है जो नेटवर्क एपीआई कॉल का नतीजा है.
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 |
ऑपरेशन का सामान्य और सफल रिस्पॉन्स. अगर ओरिजनल तरीका कामयाब होने पर कोई डेटा नहीं दिखाता है, जैसे कि ऐसा ऑब्जेक्ट जिसमें किसी भी तरह के फ़ील्ड शामिल हो सकते हैं. एक अन्य फ़ील्ड |
तरीके |
|
---|---|
|
लंबे समय तक चलने वाले ऑपरेशन की नई स्थिति दिखाता है. |