Package google.rpc

इंडेक्स

स्थिति

Status टाइप, एक लॉजिकल गड़बड़ी मॉडल के बारे में बताता है. यह मॉडल अलग-अलग प्रोग्रामिंग एनवायरमेंट के लिए सही होता है. इनमें REST API और RPC एपीआई शामिल हैं. इसका इस्तेमाल gRPC करता है. गड़बड़ी वाले मॉडल को इस तरह से डिज़ाइन किया गया है कि:

  • ज़्यादातर उपयोगकर्ताओं के लिए इस्तेमाल करने और समझने में आसान
  • अचानक होने वाली ज़रूरतों को पूरा करने के लिए सुविधाजनक

खास जानकारी

Status मैसेज में तीन तरह का डेटा होता है: गड़बड़ी कोड, गड़बड़ी का मैसेज, और गड़बड़ी की जानकारी. गड़बड़ी का कोड, google.rpc.Code की Enum वैल्यू होनी चाहिए. हालांकि, ज़रूरत पड़ने पर यह गड़बड़ी के अन्य कोड भी स्वीकार कर सकता है. गड़बड़ी का मैसेज, डेवलपर को अंग्रेज़ी में भेजा जाना चाहिए. इससे डेवलपर को गड़बड़ी को understand और understand में मदद मिलेगी. अगर उपयोगकर्ता को दिखने वाले किसी गड़बड़ी के स्थानीय मैसेज की ज़रूरत है, तो स्थानीय जगह के अनुसार मैसेज को गड़बड़ी की जानकारी में रखें या क्लाइंट में इसे स्थानीय भाषा में लिखें. गड़बड़ी की वैकल्पिक जानकारी में, गड़बड़ी के बारे में मनमुताबिक जानकारी शामिल हो सकती है. google.rpc पैकेज में, गड़बड़ी की जानकारी वाले टाइप का पहले से एक सेट मौजूद है. इसका इस्तेमाल, आम तौर पर होने वाली गड़बड़ी की स्थितियों के लिए किया जा सकता है.

भाषा मैप करना

Status मैसेज, गड़बड़ी के मॉडल को लॉजिकल तरीके से दिखाता है. हालांकि, ज़रूरी नहीं है कि यह असली वायर फ़ॉर्मैट हो. जब Status मैसेज, अलग-अलग क्लाइंट लाइब्रेरी और अलग-अलग वायर प्रोटोकॉल में दिखता है, तो उसे अलग-अलग तरीके से मैप किया जा सकता है. उदाहरण के लिए, इसे Java में कुछ अपवादों के साथ मैप किया जाएगा, लेकिन C में कुछ गड़बड़ी कोड के साथ मैप किए जाने की ज़्यादा संभावना है.

अन्य इस्तेमाल

गड़बड़ी के मॉडल और Status मैसेज का इस्तेमाल, कई तरह की सुविधाओं में किया जा सकता है. इनमें, एपीआई के साथ या उसके बिना, हर जगह एक जैसा डेवलपर अनुभव दिया जा सकता है.

गड़बड़ी के इस मॉडल के इस्तेमाल के उदाहरण:

  • आंशिक गड़बड़ियां. अगर किसी सेवा को क्लाइंट को कुछ गड़बड़ियां दिखानी हैं, तो हो सकता है कि वह सामान्य गड़बड़ियों के बारे में बताने के लिए, Status को जोड़ दे.

  • वर्कफ़्लो की गड़बड़ियां. एक सामान्य वर्कफ़्लो में कई चरण होते हैं. हर चरण में, गड़बड़ी की रिपोर्ट करने के लिए Status मैसेज हो सकता है.

  • बैच कार्रवाइयां. अगर कोई क्लाइंट बैच अनुरोध और बैच रिस्पॉन्स का इस्तेमाल करता है, तो Status मैसेज का इस्तेमाल, गड़बड़ी वाले हर सब-रिस्पॉन्स के लिए, सीधे बैच रिस्पॉन्स में किया जाना चाहिए.

  • एसिंक्रोनस कार्रवाइयां. अगर कोई एपीआई कॉल, एसिंक्रोनस ऑपरेशन से जुड़े नतीजों को अपने रिस्पॉन्स में एम्बेड करता है, तो उन कार्रवाइयों की स्थिति को सीधे Status मैसेज का इस्तेमाल करके दिखाया जाना चाहिए.

  • डेटा इकट्ठा करने की सुविधा. अगर लॉग में एपीआई की कुछ गड़बड़ियां सेव हैं, तो सुरक्षा/निजता से जुड़ी वजहों से, डेटा हटाए जाने के तुरंत बाद, Status मैसेज का इस्तेमाल किया जा सकता है.

फ़ील्ड
code

int32

स्टेटस कोड, जो google.rpc.Code की Enum वैल्यू होनी चाहिए.

message

string

डेवलपर को दिखने वाला गड़बड़ी का मैसेज, जो अंग्रेज़ी में होना चाहिए. उपयोगकर्ताओं को दिखने वाली गड़बड़ी के मैसेज का स्थानीय भाषा में अनुवाद किया जाना चाहिए और google.rpc.Status.details फ़ील्ड में भेजा जाना चाहिए. इसके अलावा, क्लाइंट इस मैसेज को स्थानीय भाषा में भी भेज सकता है.

details[]

Any

उन मैसेज की सूची जिनमें गड़बड़ी की जानकारी होती है. एपीआई के इस्तेमाल के लिए, मैसेज टाइप का एक सामान्य सेट है.