REST Resource: projects.operations

संसाधन: ऑपरेशन

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

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" }

तरीकों

get

 लंबे समय से चल रहे ऑपरेशन की नवीनतम स्थिति प्राप्त करता है।