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