REST Resource: selection.v1.projects.selectedRoutes

संसाधन: SelectedRoute

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a request:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of mutually exclusive fields.
  "validationError": enum (ValidationError)
}
फ़ील्ड
name

string

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

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

string

ज़रूरी नहीं. रास्ते का डिसप्ले नेम. यह एक ऐसा फ़ील्ड है जिसे ग्राहक इस्तेमाल कर सकता है. हालांकि, यह ज़रूरी नहीं है. यह यूनीक होना ज़रूरी नहीं है. इसकी लंबाई 100 वर्णों से ज़्यादा नहीं होनी चाहिए. वर्णों की गिनती यूनिकोड कोड पॉइंट में की जाती है.
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)

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

एक ऑब्जेक्ट, जिसमें "key": value जोड़े की सूची शामिल हो. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
फ़िलहाल, सिर्फ़ DynamicRoute को इस्तेमाल किया जा सकता है. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. अनुरोध में ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
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

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

get

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

list

 यह तय किए गए प्रोजेक्ट के लिए, पेज नंबर डालने की सुविधा के साथ सभी SelectedRoute संसाधन दिखाता है.

patch

 यह अनुरोध, नाम के हिसाब से चुने गए रास्ते की जानकारी को अपडेट करता है.