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 个字符（以 Unicode 码位计算）。
createTime

string (Timestamp format)

仅限输出。所选路线的首次创建时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 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 个字符（以 Unicode 代码点为单位）。键不得以 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] 范围内。

州

所选路线的状态。

枚举
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。