Package google.longrunning

इंडेक्स

ऑपरेशंस

एपीआई सेवा की मदद से, लंबे समय तक चलने वाले ऑपरेशन मैनेज करता है.

जब किसी एपीआई तरीके को पूरा होने में आम तौर पर ज़्यादा समय लगता है, तो उसे क्लाइंट को Operation दिखाने के लिए डिज़ाइन किया जा सकता है. क्लाइंट, इस इंटरफ़ेस का इस्तेमाल करके, ऑपरेशन रिसॉर्स को पॉलिंग करके असाइनिटिव तरीके से असल रिस्पॉन्स पा सकता है. इसके अलावा, रिस्पॉन्स पाने के लिए, ऑपरेशन रिसॉर्स को किसी दूसरे एपीआई (जैसे, Pub/Sub API) को पास किया जा सकता है. लंबे समय तक चलने वाले ऑपरेशन दिखाने वाली किसी भी एपीआई सेवा को Operations इंटरफ़ेस लागू करना चाहिए, ताकि डेवलपर को क्लाइंट का बेहतर अनुभव मिल सके.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

ज़्यादा समय तक चलने वाले ऑपरेशन को असिंक्रोनस तरीके से रद्द करने की प्रोसेस शुरू करता है. सर्वर, ऑपरेशन को रद्द करने की पूरी कोशिश करता है. हालांकि, इस बात की कोई गारंटी नहीं है कि ऑपरेशन रद्द हो जाएगा. अगर सर्वर पर यह तरीका काम नहीं करता है, तो यह google.rpc.Code.UNIMPLEMENTED दिखाता है. क्लाइंट Operations.GetOperation या दूसरे तरीकों का इस्तेमाल करके यह देख सकते हैं कि सदस्यता रद्द होने के बावजूद, कार्रवाई पूरी हुई या नहीं. रद्द करने पर, कार्रवाई को मिटाया नहीं जाता. इसके बजाय, यह Code.CANCELLED के हिसाब से, 1 के google.rpc.Status.code वाले Operation.error मान वाली कार्रवाई बन जाता है.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/cloud-platform
DeleteOperation

rpc DeleteOperation(DeleteOperationRequest) returns (Empty)

लंबे समय तक चलने वाली कार्रवाई को मिटाता है. इस तरीके से पता चलता है कि क्लाइंट की अब कार्रवाई के नतीजे में दिलचस्पी नहीं है. इससे कार्रवाई रद्द नहीं होती. अगर सर्वर पर यह तरीका काम नहीं करता है, तो यह google.rpc.Code.UNIMPLEMENTED दिखाता है.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/cloud-platform
GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation)

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

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/cloud-platform
IAM की अनुमतियां

name संसाधन पर, IAM की इस अनुमति की ज़रूरत है:

  • routeoptimization.operations.get

ज़्यादा जानकारी के लिए, IAM दस्तावेज़ देखें.
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

यह अनुरोध में तय किए गए फ़िल्टर से मैच करने वाली कार्रवाइयों की सूची बनाता है. अगर सर्वर इस तरीके के साथ काम नहीं करता है, तो यह UNIMPLEMENTED दिखाता है.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/cloud-platform
WaitOperation

rpc WaitOperation(WaitOperationRequest) returns (Operation)

यह तब तक इंतज़ार करता है, जब तक कि लंबे समय तक चलने वाला कोई ऑपरेशन पूरा नहीं हो जाता या तय किए गए टाइम आउट तक नहीं पहुंच जाता. साथ ही, यह ऑपरेशन की नई स्थिति दिखाता है. अगर कार्रवाई पहले ही पूरी हो चुकी है, तो सबसे नई स्थिति तुरंत दिखाई जाती है. अगर तय किया गया टाइम आउट, डिफ़ॉल्ट एचटीटीपी/RPC टाइम आउट से ज़्यादा है, तो एचटीटीपी/RPC टाइम आउट का इस्तेमाल किया जाता है. अगर सर्वर पर यह तरीका काम नहीं करता है, तो यह google.rpc.Code.UNIMPLEMENTED दिखाता है. ध्यान दें कि इस तरीके से, ज़्यादा से ज़्यादा लोगों तक पहुंचने की कोशिश की जाती है. यह तय किए गए टाइम आउट से पहले भी अपडेट दे सकता है. इसमें टाइम आउट की अवधि भी शामिल है. इसका मतलब है कि तुरंत जवाब देने से भी, ऑपरेशन के पूरा होने की गारंटी नहीं मिलती.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/cloud-platform

CancelOperationRequest

Operations.CancelOperation के लिए अनुरोध का मैसेज.

फ़ील्ड
name

string

उस ऑपरेशन रिसॉर्स का नाम जिसे रद्द करना है.

DeleteOperationRequest

Operations.DeleteOperation के लिए अनुरोध का मैसेज.

फ़ील्ड
name

string

मिटाए जाने वाले ऑपरेशन रिसॉर्स का नाम.

GetOperationRequest

Operations.GetOperation के लिए अनुरोध का मैसेज.

फ़ील्ड
name

string

ऑपरेशन रिसॉर्स का नाम.

ListOperationsRequest

Operations.ListOperations के लिए अनुरोध का मैसेज.

फ़ील्ड
name

string

ऑपरेशन के पैरंट रिसॉर्स का नाम.
filter

string

स्टैंडर्ड सूची फ़िल्टर.
page_size

int32

सूची के पेज का स्टैंडर्ड साइज़.
page_token

string

स्टैंडर्ड लिस्ट पेज टोकन.

ListOperationsResponse

Operations.ListOperations के लिए जवाब का मैसेज.

फ़ील्ड
operations[]

Operation

अनुरोध में तय किए गए फ़िल्टर से मैच करने वाली कार्रवाइयों की सूची.
next_page_token

string

सूची के अगले पेज का स्टैंडर्ड टोकन.

कार्रवाई

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

फ़ील्ड
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 होता है.

WaitOperationRequest

Operations.WaitOperation के लिए अनुरोध का मैसेज.

फ़ील्ड
name

string

इंतज़ार करने के लिए ऑपरेशन संसाधन का नाम.
timeout

Duration

टाइम आउट होने से पहले, इंतज़ार करने की ज़्यादा से ज़्यादा अवधि. अगर इसे खाली छोड़ दिया जाता है, तो दिए गए एचटीटीपी/RPC प्रोटोकॉल से ज़्यादा से ज़्यादा समय तक इंतज़ार करना होगा. अगर आरपीसी कॉन्टेक्स्ट के लिए समयसीमा भी तय की गई है, तो छोटी फ़ाइल का इस्तेमाल किया जाएगा.