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