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)

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

यह RFC 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

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

create

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

delete

 इस तरीके का इस्तेमाल करके, किसी प्रोजेक्ट के लिए चुने गए रूट को मिटाया जा सकता है.

get

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

list

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