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 .

قالب: پروژه‌ها/{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 مسیر بر اساس یکی از معیارهای اعتبارسنجی نامعتبر است.

خطای اعتبارسنجی

خطای اعتبارسنجی مسیر انتخاب شده.

Enums
VALIDATION_ERROR_UNSPECIFIED خطای اعتبارسنجی این مسیر تنظیم نشده است.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION مسیر خارج از صلاحیت پروژه است.
VALIDATION_ERROR_LOW_ROAD_USAGE این مسیر دارای کاربری کم جاده ای است ( افراد بسیار کمی از آن عبور می کنند).

روش ها

batchCreate

 چندین SelectedRoutes ایجاد می کند و برنامه ای را برای بازیابی دوره ای اطلاعات حافظه پنهان برای هر یک از مسیرها شروع می کند.

create

 یک SelectedRoute ایجاد می کند و برنامه ای را برای بازیابی دوره ای اطلاعات حافظه پنهان مسیر شروع می کند.

delete

 SelectedRoute مشخص شده را برای پروژه مشخص شده حذف می کند.

get

 یک SelectedRoute همانطور که با نام آن مشخص شده است دریافت می کند.

list

 تمام SelectedRoutes را برای پروژه مشخص شده با صفحه بندی فهرست می کند.