Package google.longrunning

सूची

कार्रवाई

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

फ़ील्ड
name

string

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

metadata

Any

कार्रवाई से जुड़ा, सेवा के हिसाब से मेटाडेटा. आम तौर पर, इसमें प्रगति की जानकारी और सामान्य मेटाडेटा होता है, जैसे कि बनाने का समय. हो सकता है कि कुछ सेवाएं ऐसा मेटाडेटा न दें. लंबे समय तक चलने वाली कार्रवाई के लिए इस्तेमाल होने वाले किसी भी तरीके में, मेटाडेटा का टाइप (अगर कोई है) दर्ज होना चाहिए.

done

bool

अगर वैल्यू false है, तो इसका मतलब है कि कार्रवाई अब भी जारी है. अगर true पूरा हो गया है, तो कार्रवाई पूरी हो जाती है और error या response उपलब्ध होती है.

यूनियन फ़ील्ड result. ऑपरेशन का नतीजा, error या कोई मान्य response हो सकता है. अगर done == false है, तो error या response को सेट नहीं किया जाता. अगर done == true है, तो error या response में से कोई एक सेट होगा. result इनमें से सिर्फ़ एक हो सकता है:
error

Status

कार्रवाई नहीं होने या रद्द होने पर, गड़बड़ी का नतीजा.

response

Any

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