REST Resource: selection.v1.projects.selectedRoutes

Recurso: SelectedRoute

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

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

string

Es el identificador. Es el nombre del recurso 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.
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, se permite filtrar o agrupar las rutas cuando se recupera información histórica y en tiempo real de las rutas. Se admiten hasta 10 atributos por ruta. Cada clave y valor debe ser una cadena no vacía y puede tener hasta 100 caracteres. Las claves no deben comenzar con goog.

Un objeto que contiene una lista de "key": value pares. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Campo de unión route_type. Actualmente, solo se admite DynamicRoute. route_type puede ser solo uno de los siguientes:
dynamicRoute

object (DynamicRoute)

El SelectedRoute es una ruta dinámica.
validationError

enum (ValidationError)

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

DynamicRoute

Representa una ruta con puntos de referencia (origen, destino e intermedios). Se garantiza que la ruta real pasará por todos los puntos de referencia, pero podría cambiar de vez en cuando debido a las diferentes 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. Si los agregas correctamente, se puede reducir la variación de la ruta real de vez en cuando.

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 una programación activa.
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 un uso bajo de la vía (muy pocas personas la atraviesan).

Métodos

batchCreate

 Crea varios recursos SelectedRoute e inicia una programación para recuperar periódicamente la información de la caché de cada una de las rutas.

batchDelete

 Borra varios recursos SelectedRoute para el proyecto especificado.

batchUpdate

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

create

 Crea un SelectedRoute e inicia una programación para recuperar periódicamente la información de la caché de la ruta.

delete

 Borra el SelectedRoute especificado para el proyecto especificado.

get

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

list

 Muestra una lista de todos los recursos SelectedRoute para el proyecto especificado con paginación.

patch

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