संसाधन: ऑपरेशन
यह संसाधन लंबे समय तक चलने वाले ऑपरेशन का प्रतिनिधित्व करता है जो नेटवर्क एपीआई कॉल का परिणाम है।
ऑपरेशन का response
क्षेत्र एक UploadReleaseResponse होगा।
JSON प्रतिनिधित्व |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
खेत | |
---|---|
name | सर्वर द्वारा निर्दिष्ट नाम, जो केवल उसी सेवा के भीतर अद्वितीय है जो मूल रूप से इसे लौटाता है। यदि आप डिफ़ॉल्ट HTTP मैपिंग का उपयोग करते हैं, |
metadata | ऑपरेशन से जुड़ा सेवा-विशिष्ट मेटाडेटा। इसमें आम तौर पर प्रगति की जानकारी और सामान्य मेटाडेटा जैसे निर्माण समय शामिल होता है। कुछ सेवाएँ ऐसा मेटाडेटा प्रदान नहीं कर सकती हैं। कोई भी विधि जो लंबे समय तक चलने वाले ऑपरेशन को लौटाती है, उसे मेटाडेटा प्रकार, यदि कोई हो, का दस्तावेजीकरण करना चाहिए। एक वस्तु जिसमें मनमाना प्रकार के फ़ील्ड हों। एक अतिरिक्त फ़ील्ड |
done | यदि मान |
संघ क्षेत्र result . ऑपरेशन परिणाम, जो या तो एक error या वैध response हो सकता है। यदि done == false , तो न तो error और न ही response सेट की जाती है। यदि done == true , तो error या response में से कोई एक सेट किया जा सकता है। कुछ सेवाएँ परिणाम प्रदान नहीं कर सकती हैं। result निम्न में से केवल एक ही हो सकता है: | |
error | विफलता या रद्दीकरण की स्थिति में ऑपरेशन का त्रुटि परिणाम। |
response | सफलता की स्थिति में ऑपरेशन की सामान्य प्रतिक्रिया। इस स्थिति में यह एक UploadReleaseResponse होगा। |
स्थिति
Status
प्रकार एक तार्किक त्रुटि मॉडल को परिभाषित करता है जो REST API और RPC API सहित विभिन्न प्रोग्रामिंग वातावरणों के लिए उपयुक्त है। इसका उपयोग GRPC द्वारा किया जाता है। प्रत्येक Status
संदेश में डेटा के तीन भाग होते हैं: त्रुटि कोड, त्रुटि संदेश और त्रुटि विवरण।
आप एपीआई डिज़ाइन गाइड में इस त्रुटि मॉडल और इसके साथ काम करने के तरीके के बारे में अधिक जानकारी प्राप्त कर सकते हैं।
JSON प्रतिनिधित्व |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
खेत | |
---|---|
code | स्थिति कोड, जो |
message | एक डेवलपर-सामना करने वाला त्रुटि संदेश, जो अंग्रेजी में होना चाहिए। किसी भी उपयोगकर्ता-सामना वाले त्रुटि संदेश को स्थानीयकृत किया जाना चाहिए और |
details[] | संदेशों की एक सूची जिसमें त्रुटि विवरण होता है। एपीआई के उपयोग के लिए संदेश प्रकारों का एक सामान्य सेट है। एक वस्तु जिसमें मनमाना प्रकार के फ़ील्ड हों। एक अतिरिक्त फ़ील्ड |
तरीकों | |
---|---|
| लंबे समय से चल रहे ऑपरेशन की नवीनतम स्थिति प्राप्त करता है। |