REST Resource: selection.v1.projects.selectedRoutes

रिसॉर्स: SelectedRoute

SelectedRoute, किसी खास रास्ते को दिखाता है. ग्राहक, कॉन्ट्रैक्ट के तहत इस्तेमाल के मामलों के लिए, इस रास्ते की जानकारी (जैसे, अवधि) समय-समय पर पा सकते हैं.

JSON काेड में दिखाना 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "state": enum (State),
  "routeAttributes": {
    string: string,
    ...
  },

  // Union field route_type can be only one of the following:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of list of possible types for union field route_type.
  "validationError": enum (ValidationError)
}
फ़ील्ड
name

string

आइडेंटिफ़ायर. SelectedRoute का रिसॉर्स नेम.

फ़ॉर्मैट: projects/{project}/selectedRoutes/{selectedRoute}
displayName

string

ज़रूरी नहीं. रास्ते का डिसप्ले नेम. यह फ़ील्ड ज़रूरी नहीं है. इसका इस्तेमाल ग्राहक कर सकते हैं. यह ज़रूरी नहीं है कि यह यूनीक हो.
createTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह समय जब चुने गए रास्ते को पहली बार बनाया गया था.

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".
state

enum (State)

सिर्फ़ आउटपुट के लिए. चुने गए रास्ते की स्थिति.
routeAttributes

map (key: string, value: string)

ज़रूरी नहीं. चुने गए रास्ते के लिए कस्टम एट्रिब्यूट. इन्हें जोड़ने से, रास्ते की पिछली और रीयल-टाइम जानकारी पाने के दौरान, रास्तों को फ़िल्टर या ग्रुप में बांटा जा सकता है. हर रास्ते के लिए, ज़्यादा से ज़्यादा 10 एट्रिब्यूट इस्तेमाल किए जा सकते हैं. हर कुंजी और वैल्यू, खाली न होने वाली स्ट्रिंग होनी चाहिए. इनमें ज़्यादा से ज़्यादा 100 वर्ण हो सकते हैं. कुंजियां, goog से शुरू नहीं होनी चाहिए.

इसमें "key": value पेयर की सूची होती है. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
यूनियन फ़ील्ड route_type. फ़िलहाल, सिर्फ़ DynamicRoute इस्तेमाल किया जा सकता है. route_type इनमें से सिर्फ़ एक हो सकता है:
dynamicRoute

object (DynamicRoute)

SelectedRoute एक डाइनैमिक रूट है.
validationError

enum (ValidationError)

सिर्फ़ आउटपुट के लिए. जब स्थिति STATE_INVALID होती है, तब चुने गए रास्ते के लिए पुष्टि करने में हुई गड़बड़ी.

DynamicRoute

यह वेपॉइंट (शुरुआत की जगह, मंज़िल, और बीच में रुकने की जगहें) वाला रास्ता दिखाता है. इस बात की गारंटी है कि असल रास्ता सभी वेपॉइंट से होकर गुज़रेगा. हालांकि, ट्रैफ़िक की स्थिति में बदलाव की वजह से, यह समय-समय पर बदल सकता है.

JSON काेड में दिखाना 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
फ़ील्ड
origin

object (LatLng)

ज़रूरी है. रास्ते की शुरुआत की जगह.
destination

object (LatLng)

ज़रूरी है. रास्ते की आखिरी जगह.
intermediates[]

object (LatLng)

ज़रूरी नहीं. रास्ते में पड़ने वाले इंटरमीडिएट वेपॉइंट का सेट (टर्मिनल पॉइंट को छोड़कर). ये हमेशा पासिंग-बाय पॉइंट होते हैं. ज़्यादा से ज़्यादा 25 इंटरमीडिएट वेपॉइंट इस्तेमाल किए जा सकते हैं. इन्हें सही तरीके से जोड़ने पर, असल रास्ते में समय-समय पर होने वाले बदलाव को कम किया जा सकता है.

LatLng

यह अक्षांश/देशांतर के पेयर को दिखाने वाला ऑब्जेक्ट है. इसे डबल के पेयर के तौर पर दिखाया जाता है. इससे अक्षांश और देशांतर की डिग्री दिखाई जाती है. जब तक कोई और जानकारी न दी जाए, तब तक इस ऑब्जेक्ट को WGS84 स्टैंडर्ड के मुताबिक होना चाहिए. वैल्यू, नॉर्मलाइज़ की गई सीमाओं के अंदर होनी चाहिए.

JSON काेड में दिखाना 
{
  "latitude": number,
  "longitude": number
}
फ़ील्ड
latitude

number

डिग्री में अक्षांश. यह [-90.0, +90.0] की सीमा में होना चाहिए.
longitude

number

डिग्री में देशांतर. यह [-180.0, +180.0] की सीमा में होना चाहिए.

राज्य

चुने गए रास्ते की स्थिति.

Enums
STATE_UNSPECIFIED इस रास्ते की स्थिति सेट नहीं की गई है.
STATE_SCHEDULING रास्ता बना लिया गया है और इसे शेड्यूल किया जा रहा है.
STATE_RUNNING रास्ता बना लिया गया है और इसका शेड्यूल ऐक्टिव है.
STATE_DELETING रास्ते को मिटाने के लिए चुना गया है.
STATE_VALIDATING रास्ते की पुष्टि की जा रही है.
STATE_INVALID पुष्टि करने के किसी एक मानदंड के आधार पर, रास्ता अमान्य है.

ValidationError

चुने गए रास्ते के लिए पुष्टि करने में हुई गड़बड़ी.

Enums
VALIDATION_ERROR_UNSPECIFIED इस रास्ते के लिए पुष्टि करने में हुई गड़बड़ी सेट नहीं की गई है.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION रास्ता, प्रोजेक्ट के अधिकार क्षेत्र से बाहर है.
VALIDATION_ERROR_LOW_ROAD_USAGE रास्ते का इस्तेमाल कम होता है. इस रास्ते से बहुत कम लोग गुज़रते हैं.

तरीके

batchCreate

 SelectedRoute के कई रिसॉर्स बनाता है और हर रास्ते के लिए, समय-समय पर कैश मेमोरी की जानकारी पाने के लिए शेड्यूल शुरू करता है.

batchDelete

 बताए गए प्रोजेक्ट के लिए, SelectedRoute के कई रिसॉर्स मिटाता है.

batchUpdate

 नामों के हिसाब से, SelectedRoute के कई रिसॉर्स अपडेट करता है.

create

 SelectedRoute बनाता है और रास्ते के लिए, समय-समय पर कैश मेमोरी की जानकारी पाने के लिए शेड्यूल शुरू करता है.

delete

 बताए गए प्रोजेक्ट के लिए, बताया गया SelectedRoute मिटाता है.

get

 नाम के हिसाब से, SelectedRoute की जानकारी देता है.

list

 पेज पर बांटकर, बताए गए प्रोजेक्ट के लिए SelectedRoute के सभी रिसॉर्स की सूची दिखाता है.

patch

 नाम के हिसाब से, SelectedRoute अपडेट करता है.