Google is committed to advancing racial equity for Black communities. See how.
इस पेज का अनुवाद Cloud Translation API से किया गया है.
Switch to English

ऑपरेशन

यह संसाधन लंबे समय तक चलने वाले ऑपरेशन का प्रतिनिधित्व करता है जो कि नेटवर्क एपीआई कॉल का परिणाम है।

JSON प्रतिनिधित्व
 {
  "name" :  string ,
  "metadata" :  {
    "@type" :  string ,
    field1 :  ... ,
    ...
  } ,
  "done" :  boolean ,

  // Union field result can be only one of the following:
  "error" :  {
    object ( Status )
  } ,
  "response" :  {
    "@type" :  string ,
    field1 :  ... ,
    ...
  }
  // End of list of possible types for union field result .
} 
खेत
name

string

सर्वर द्वारा निर्दिष्ट नाम, जो केवल उसी सेवा के भीतर अद्वितीय है जो मूल रूप से इसे वापस करता है। यदि आप डिफ़ॉल्ट HTTP मैपिंग का उपयोग करते हैं, तो name operations/{unique_id} साथ समाप्त होने वाला संसाधन नाम होना चाहिए।

metadata

object

सेवा-विशिष्ट मेटाडेटा ऑपरेशन से जुड़ा है। इसमें आमतौर पर प्रगति की जानकारी और सामान्य मेटाडेटा जैसे कि समय बनाएँ। कुछ सेवाएं इस तरह के मेटाडेटा प्रदान नहीं कर सकती हैं। कोई भी विधि जो एक लंबे समय से चल रहे ऑपरेशन को लौटाती है, उसे मेटाडेटा प्रकार का दस्तावेज़ करना चाहिए, यदि कोई हो।

एक वस्तु जिसमें एक मनमाने प्रकार के क्षेत्र होते हैं। एक अतिरिक्त फ़ील्ड "@type" में एक URI प्रकार की पहचान होती है। उदाहरण: { "id": 1234, "@type": "types.example.com/standard/id" }

done

boolean

यदि मान false , तो इसका मतलब है कि ऑपरेशन अभी भी जारी है। यदि true , तो ऑपरेशन पूरा हो गया है, और error या response उपलब्ध है।

संघ क्षेत्र का result । ऑपरेशन का परिणाम, जो या तो एक error या एक वैध response । यदि done == false , तो न तो error और न ही response निर्धारित है। अगर done == true , तो error या response से एक बिल्कुल निर्धारित है। result केवल निम्न में से एक हो सकता है:
error

object ( Status )

विफलता या रद्दीकरण के मामले में ऑपरेशन का त्रुटि परिणाम।

response

object

सफलता के मामले में ऑपरेशन की सामान्य प्रतिक्रिया। यदि मूल विधि सफलता का कोई डेटा नहीं देती है, जैसे कि Delete , तो प्रतिक्रिया google.protobuf.Empty । यदि मूल विधि मानक है / Get Create / Update , तो प्रतिक्रिया संसाधन होनी चाहिए। अन्य विधियों के लिए, प्रतिक्रिया में XxxResponse प्रकार होना चाहिए, जहाँ Xxx मूल विधि नाम है। उदाहरण के लिए, यदि मूल विधि का नाम TakeSnapshot() , तो अनुमानित प्रतिक्रिया प्रकार TakeSnapshotResponse

एक वस्तु जिसमें एक मनमाने प्रकार के क्षेत्र होते हैं। एक अतिरिक्त फ़ील्ड "@type" में एक URI प्रकार की पहचान होती है। उदाहरण: { "id": 1234, "@type": "types.example.com/standard/id" }

स्थिति

Status प्रकार एक तार्किक त्रुटि मॉडल को परिभाषित करता है जो विभिन्न प्रोग्रामिंग वातावरणों के लिए उपयुक्त है, जिसमें REST API और RPC API शामिल हैं। इसका उपयोग gRPC द्वारा किया जाता है। प्रत्येक Status संदेश में डेटा के तीन टुकड़े होते हैं: त्रुटि कोड, त्रुटि संदेश और त्रुटि विवरण।

आप इस त्रुटि मॉडल के बारे में और एपीआई डिजाइन गाइड में इसके साथ काम करने के तरीके के बारे में अधिक जानकारी प्राप्त कर सकते हैं।

JSON प्रतिनिधित्व
 {
  "code" :  integer ,
  "message" :  string ,
  "details" :  [
    {
      "@type" :  string ,
      field1 :  ... ,
      ...
    }
  ]
} 
खेत
code

integer

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

message

string

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

details[]

object

संदेशों की एक सूची जो त्रुटि विवरण ले जाती है। एपीआई के लिए उपयोग करने के लिए संदेश प्रकारों का एक सामान्य सेट है।

एक वस्तु जिसमें एक मनमाना प्रकार का क्षेत्र होता है। एक अतिरिक्त फ़ील्ड "@type" में एक URI प्रकार की पहचान होती है। उदाहरण: { "id": 1234, "@type": "types.example.com/standard/id" }