REST Resource: networks

संसाधन: नेटवर्क

इस्तेमाल किए जा सकने वाले पूरे मौजूदा नेटवर्क की जानकारी देता है. एपीआई इस्तेमाल करने वाले किसी ग्राहक के पास कई नेटवर्क हो सकते हैं. उदाहरण के लिए, मुख्य नेटवर्क और आने वाले समय में आकलन के लिए होने वाले बदलाव.

JSON के काेड में दिखाना 
{
  "name": string,
  "dimensions": [
    {
      object (ValueDimension)
    }
  ],
  "pricing": {
    object (PricingStrategy)
  },
  "currencyCode": string,
  "timeStep": string,
  "distanceMatrix": [
    {
      object (DistanceMatrixEntry)
    }
  ]
}
फ़ील्ड
name

string

ज़रूरी है. आइडेंटिफ़ायर. अपडेट नहीं किया जा सका.
dimensions[]

object (ValueDimension)

दूरी, वज़न, पैलेट वगैरह. साथ ही, स्केलिंग (पूर्णांकों पर फ़्लोट करने वाले मैप को मैप करने के लिए).
pricing

object (PricingStrategy)

ज़रूरी नहीं. वह कीमत जिसे भेजने वाला व्यक्ति ऐसे शिपमेंट के लिए पेमेंट करता है जिसके लिए अलग से लाइन की ज़रूरत नहीं होती.
currencyCode

string

ज़रूरी नहीं. पूरे नेटवर्क में एक मॉनेटरी यूनिट का इस्तेमाल किया जाता है. किसी एपीआई ग्राहक के पास अलग-अलग नेटवर्क के लिए कई अलग-अलग यूनिट हो सकती हैं; एक नेटवर्क में सिर्फ़ एक मॉनेटरी यूनिट हो सकती है. इकाई ISO 4217 में एन्कोड होनी चाहिए, जैसे google3/google/type/Money.proto.
timeStep

string (Duration format)

ज़रूरी नहीं. समय का अंतर. फ़ैसले इस सटीक समय के साथ आउटपुट होते हैं. अंदरूनी रूप से, स्टेट को इसी सटीक तरीके से रखा जाता है.

सेकंड में कुल नौ दशमलव अंक, जो 's' पर खत्म होते हैं. उदाहरण: "3.5s".
distanceMatrix[]

object (DistanceMatrixEntry)

ज़रूरी नहीं. दूरी का मैट्रिक्स (वेटेड डायरेक्टेड किनारों की सूची को दिखाता है).

DistanceMatrixEntry

सोर्स हब और डेस्टिनेशन हब के बीच की दूरी.

JSON के काेड में दिखाना 
{
  "sourceHub": string,
  "destinationHub": string,
  "weights": [
    {
      object (ValueDimension)
    }
  ]
}
फ़ील्ड
sourceHub

string

ज़रूरी है. सोर्स हब.
destinationHub

string

ज़रूरी है. डेस्टिनेशन हब.
weights[]

object (ValueDimension)

ज़रूरी है. हब के बीच की दूरी, कई डाइमेंशन में मापी गई.

तरीके

create

 नेटवर्क बनाता है.

delete

 नेटवर्क को मिटाता है.

get

 नेटवर्क की जानकारी हासिल करता है.

list

 नेटवर्क को सूची में शामिल करता है.

listPaths

 उन सभी पाथ को दिखाता है जो फ़िलहाल उपलब्ध हैं.

patch

 नेटवर्क को अपडेट करता है.