REST Resource: enterprises.devices.operations

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

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

जेएसओएन के काेड में दिखाना 
{
  "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

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

object

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

एक ऑब्जेक्ट, जिसमें आर्बिट्रेरी टाइप के फ़ील्ड शामिल हैं. एक और फ़ील्ड "@type" में, टाइप की पहचान करने वाला एक यूआरआई शामिल है. उदाहरण: { "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" में, टाइप की पहचान करने वाला एक यूआरआई शामिल है. उदाहरण: { "id": 1234, "@type": "types.example.com/standard/id" }.

स्थिति

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

एपीआई डिज़ाइन गाइड में गड़बड़ी के इस मॉडल और इसके साथ काम करने के तरीके के बारे में ज़्यादा जानकारी पाई जा सकती है.

जेएसओएन के काेड में दिखाना 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
फ़ील्ड
code

integer

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

string

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

object

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

एक ऑब्जेक्ट, जिसमें आर्बिट्रेरी टाइप के फ़ील्ड शामिल हैं. एक और फ़ील्ड "@type" में, टाइप की पहचान करने वाला एक यूआरआई शामिल है. उदाहरण: { "id": 1234, "@type": "types.example.com/standard/id" }.

तरीके

cancel

 लंबे समय तक चलने वाली कार्रवाई पर, एसिंक्रोनस तरीके से रद्द करना शुरू करता है.

get

 लंबे समय से चल रही किसी कार्रवाई की ताज़ा स्थिति की जानकारी देता है.

list

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