संसाधन: कार्रवाई
यह संसाधन, लंबे समय तक चलने वाली किसी कार्रवाई को दिखाता है, जो नेटवर्क एपीआई कॉल की वजह से होती है.
जेएसओएन के काेड में दिखाना |
---|
{ "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 |
कार्रवाई का सामान्य और सफल रिस्पॉन्स. अगर ओरिजनल तरीके से काम पूरा होने का कोई डेटा नहीं मिलता (जैसे कि |
स्थिति
Status
टाइप, एक लॉजिकल गड़बड़ी वाले मॉडल के बारे में बताता है. यह मॉडल अलग-अलग प्रोग्रामिंग एनवायरमेंट के लिए सही होता है. इनमें REST API और RPC एपीआई शामिल हैं. इसका इस्तेमाल gRPC करता है. हर Status
मैसेज में तीन तरह का डेटा होता है: गड़बड़ी कोड, गड़बड़ी का मैसेज, और गड़बड़ी की जानकारी.
एपीआई की डिज़ाइन गाइड में, गड़बड़ी के इस मॉडल और उस पर काम करने के तरीके के बारे में ज़्यादा जानें.
जेएसओएन के काेड में दिखाना |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
फ़ील्ड | |
---|---|
code |
स्टेटस कोड, जो |
message |
डेवलपर को दिखने वाला गड़बड़ी का मैसेज, जो अंग्रेज़ी में होना चाहिए. उपयोगकर्ता को दिखने वाली गड़बड़ी के मैसेज को स्थानीय भाषा में लिखना चाहिए और |
details[] |
मैसेज की ऐसी सूची जिसमें गड़बड़ी की जानकारी होती है. एपीआई के इस्तेमाल के लिए, मैसेज का एक सामान्य सेट है. |
तरीके |
|
---|---|
|
लंबे समय तक चलने वाली कार्रवाई की ताज़ा स्थिति की जानकारी देता है. |