REST Resource: selection.v1.projects.selectedRoutes

Ресурс: Выбранный маршрут

Объект 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

Объект, представляющий пару координат широты и долготы. Он выражается в виде пары чисел с плавающей запятой (double), обозначающих градусы широты и долготы. Если не указано иное, этот объект должен соответствовать стандарту WGS84 . Значения должны находиться в пределах нормализованных диапазонов.

JSON-представление 
{
  "latitude": number,
  "longitude": number
}
Поля
latitude

number

Широта в градусах. Она должна находиться в диапазоне [-90,0, +90,0].

longitude

number

Долгота в градусах. Она должна находиться в диапазоне [-180,0, +180,0].

Состояние

Состояние выбранного маршрута.

Перечисления
STATE_UNSPECIFIED Состояние этого маршрута не задано.
STATE_SCHEDULING Маршрут составлен и находится в стадии планирования.
STATE_RUNNING Маршрут создан и имеет действующее расписание.
STATE_DELETING Маршрут помечен для удаления.
STATE_VALIDATING Маршрут в настоящее время проходит процедуру проверки.
STATE_INVALID Маршрут признан недействительным на основании одного из критериев проверки.

ValidationError

Ошибка проверки выбранного маршрута.

Перечисления
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 в соответствии с его именем.