REST Resource: selection.v1.projects.selectedRoutes

Recurso: SelectedRoute

Un SelectedRoute representa una ruta específica para la que un cliente desea recuperar información periódicamente (p.ej., la duración) para los casos de uso contratados.

Representación 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
}
Campos
name

string

Es el identificador. Es el nombre del recurso de SelectedRoute.

Formato: projects/{project}/selectedRoutes/{selectedRoute}
displayName

string

Opcional. Es el nombre visible de la ruta. Este es un campo opcional que puede usar el cliente. No es necesario que sea único. La longitud está limitada a 100 caracteres (contados en puntos de código Unicode).
createTime

string (Timestamp format)

Solo salida. Es la hora en la que se creó la ruta seleccionada por primera vez.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
state

enum (State)

Solo salida. Es el estado de la ruta seleccionada.
routeAttributes

map (key: string, value: string)

Opcional. Son los atributos personalizados de la ruta seleccionada. Si los agregas, podrás filtrar o agrupar las rutas cuando recuperes información histórica y en tiempo real sobre ellas. Se admiten hasta 25 atributos por ruta. Cada clave y valor debe ser una cadena no vacía y puede tener hasta 100 caracteres (contados en puntos de código Unicode). Las claves no deben comenzar con goog.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Solo se admite DynamicRoute. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
dynamicRoute

object (DynamicRoute)

La SelectedRoute es una ruta dinámica.
Fin de los campos mutuamente excluyentes.
validationError

enum (ValidationError)

Solo salida. Es el error de validación de la ruta seleccionada cuando el estado es STATE_INVALID.
dynamicRouting

boolean

Opcional. Si se establece en true, la ruta seleccionada puede redirigir de forma dinámica según el tráfico en vivo de acuerdo con los puntos de referencia de entrada. Si se establece en false, la ruta seleccionada será una ruta fija que no tiene en cuenta el tráfico en tiempo real y sigue la ruta que no tiene en cuenta el tráfico calculada en el momento de la creación. Si se omite, el valor será false de forma predeterminada, lo que indica que es una ruta fija.

DynamicRoute

Representa una ruta con puntos de referencia (origen, destino y puntos intermedios). Se garantiza que la ruta real pasará por todos los puntos de referencia. Si dynamicRouting se establece en false, la ruta real permanece fija, independientemente de las condiciones de tráfico. De lo contrario, si dynamicRouting se establece en true, la ruta real puede cambiar según las condiciones de tráfico.

Representación JSON 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
Campos
origin

object (LatLng)

Obligatorio. Es la ubicación de origen de la ruta.
destination

object (LatLng)

Obligatorio. Es la ubicación final de la ruta.
intermediates[]

object (LatLng)

Opcional. Es un conjunto de puntos de referencia intermedios a lo largo de la ruta (sin incluir los puntos terminales). Siempre son puntos de paso. Se admiten hasta 25 puntos de referencia intermedios. Agregarlos correctamente puede reducir la variación de la ruta real periódicamente.

LatLng

Es un objeto que representa un par de valores de latitud y longitud. Esto se expresa como un par de dobles para representar la latitud en grados y la longitud en grados. A menos que se especifique lo contrario, este objeto debe cumplir con el estándar WGS84. Los valores deben pertenecer a rangos normalizados.

Representación JSON 
{
  "latitude": number,
  "longitude": number
}
Campos
latitude

number

La latitud expresada en grados. Debe pertenecer al rango [-90.0, +90.0].
longitude

number

La longitud expresada en grados. Debe pertenecer al rango [-180.0, +180.0].

Estado

Es el estado de la ruta seleccionada.

Enums
STATE_UNSPECIFIED No se estableció el estado de esta ruta.
STATE_SCHEDULING Se creó la ruta y se está programando.
STATE_RUNNING Se creó la ruta y tiene un programa activo.
STATE_DELETING Se marcó la ruta para su eliminación.
STATE_VALIDATING La ruta está en proceso de validación.
STATE_INVALID La ruta no es válida según uno de los criterios de validación.

ValidationError

Es el error de validación de la ruta seleccionada.

Enums
VALIDATION_ERROR_UNSPECIFIED No se estableció el error de validación de esta ruta.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION La ruta está fuera de la jurisdicción del proyecto.
VALIDATION_ERROR_LOW_ROAD_USAGE La ruta tiene poco uso de la vía (pasan muy pocas personas por ella).

Métodos

batchCreate

 Crea varios recursos SelectedRoute y, además, inicia un programa para recuperar periódicamente la información de la caché de cada una de las rutas.

batchDelete

 Borra varios recursos SelectedRoute del proyecto especificado.

batchUpdate

 Actualiza varios recursos SelectedRoute según lo especificado por sus nombres.

create

 Crea un SelectedRoute y, luego, inicia un programa para recuperar periódicamente la información de la caché de la ruta.

delete

 Borra la SelectedRoute especificada para el proyecto indicado.

get

 Obtiene una SelectedRoute según lo especificado por su nombre.

list

 Enumera todos los recursos SelectedRoute del proyecto especificado con paginación.

patch

 Actualiza una SelectedRoute según lo especificado por su nombre.