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 response:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of mutually exclusive fields.
  "validationError": enum (ValidationError),
  "dynamicRouting": boolean
}
Поля
name

string

Идентификатор. Название ресурса SelectedRoute.

Формат: projects/{project}/selectedRoutes/{selectedRoute}
displayName

string

Необязательное поле. Отображаемое название маршрута. Это необязательное поле, которое может использовать клиент. Оно не обязательно должно быть уникальным. Длина ограничена 100 символами (в кодовых точках Unicode).
createTime

string (Timestamp format)

Только для вывода. Время создания выбранного маршрута.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "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 символов (в кодовых точках Unicode). Ключи не должны начинаться с goog.

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Поддерживается только DynamicRoute. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
dynamicRoute

object (DynamicRoute)

SelectedRoute – это динамический маршрут.
Конец взаимоисключающих полей.
validationError

enum (ValidationError)

Только для вывода. Ошибка проверки для выбранного маршрута, когда состояние – STATE_INVALID.
dynamicRouting

boolean

Необязательное поле. Если задано значение true, выбранный маршрут может динамически меняться в зависимости от ситуации на дорогах в соответствии с указанными путевыми точками. Если задано значение false, выбранный маршрут будет фиксированным и не будет учитывать текущую загруженность дорог. Он будет соответствовать маршруту, рассчитанному во время создания без учета трафика. Если его не указать, по умолчанию будет использоваться значение false, которое означает, что маршрут фиксированный.

DynamicRoute

Это маршрут с путевыми точками (начальной, конечной и промежуточными). Фактический маршрут гарантированно проходит через все путевые точки. Если для параметра dynamicRouting задано значение false, фактический маршрут остается фиксированным независимо от загруженности дорог. Если для параметра dynamicRouting задано значение true, фактический маршрут может меняться в зависимости от загруженности дорог.

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, указанный по его имени.