REST Resource: selection.v1.projects.selectedRoutes

Recurso: SelectedRoute

Um SelectedRoute representa uma rota específica para a qual um cliente quer recuperar informações periodicamente (por exemplo, duração) para casos de uso contratados.

Representação 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

Identificador. Nome do recurso SelectedRoute.

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

string

Opcional. Nome de exibição da rota. Este é um campo opcional que pode ser usado pelo cliente. Ele não precisa ser único.
createTime

string (Timestamp format)

Apenas saída. Hora em que a rota selecionada foi criada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
state

enum (State)

Apenas saída. O estado da rota selecionada.
routeAttributes

map (key: string, value: string)

Opcional. Os atributos personalizados da rota selecionada. A adição deles permite filtrar ou agrupar as rotas ao recuperar informações históricas e em tempo real. Até 10 atributos são aceitos por rota. Cada chave e valor precisa ser uma string não vazia e pode ter até 100 caracteres. As chaves não podem começar com goog.

Um objeto com uma lista de "key": value pares. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Campo de união route_type. No momento, apenas DynamicRoute é aceito. route_type pode ser apenas de um dos tipos a seguir:
dynamicRoute

object (DynamicRoute)

O SelectedRoute é uma rota dinâmica.
validationError

enum (ValidationError)

Apenas saída. O erro de validação da rota selecionada quando o estado é STATE_INVALID.

DynamicRoute

Representa uma rota com waypoints (origem, destino e intermediários). A rota real tem a garantia de passar por todos os waypoints, mas pode mudar de tempos em tempos devido a condições de trânsito variáveis.

Representação JSON 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
Campos
origin

object (LatLng)

Obrigatório. Local de origem da rota.
destination

object (LatLng)

Obrigatório. Local de destino da rota.
intermediates[]

object (LatLng)

Opcional. Um conjunto de waypoints intermediários ao longo da rota (excluindo os pontos terminais). Eles são sempre pontos de passagem. Até 25 waypoints intermediários são aceitos. A adição deles corretamente pode reduzir a variação da rota real periodicamente.

LatLng

Um objeto que representa um par de latitude/longitude. Isso é expresso como um par de números de ponto flutuante de precisão dupla para representar graus de latitude e graus de longitude. A menos que especificado de outra forma, esse objeto precisa seguir o padrão WGS84. Os valores precisam estar dentro de intervalos normalizados.

Representação JSON 
{
  "latitude": number,
  "longitude": number
}
Campos
latitude

number

A latitude em graus. Precisa estar no intervalo [-90,0, +90,0].
longitude

number

A longitude em graus. Precisa estar no intervalo [-180,0, +180,0].

Estado

O estado da rota selecionada.

Tipos enumerados
STATE_UNSPECIFIED O estado dessa rota não está definido.
STATE_SCHEDULING A rota foi criada e está sendo programada.
STATE_RUNNING A rota foi criada e tem uma programação ativa.
STATE_DELETING A rota foi marcada para exclusão.
STATE_VALIDATING A rota está em processo de validação.
STATE_INVALID A rota é inválida com base em um dos critérios de validação.

ValidationError

O erro de validação da rota selecionada.

Tipos enumerados
VALIDATION_ERROR_UNSPECIFIED O erro de validação dessa rota não está definido.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION A rota está fora da jurisdição do projeto.
VALIDATION_ERROR_LOW_ROAD_USAGE A rota tem baixo uso de estradas (muitas poucas pessoas passam por ela).

Métodos

batchCreate

 Cria vários recursos SelectedRoute e inicia uma programação para recuperar periodicamente informações de cache de cada uma das rotas.

batchDelete

 Exclui vários recursos SelectedRoute para o projeto especificado.

batchUpdate

 Atualiza vários recursos SelectedRoute conforme especificado pelos nomes.

create

 Cria um SelectedRoute e inicia uma programação para recuperar periodicamente informações de cache da rota.

delete

 Exclui o SelectedRoute especificado para o projeto especificado.

get

 Recebe um SelectedRoute conforme especificado pelo nome.

list

 Lista todos os recursos SelectedRoute para o projeto especificado com paginação.

patch

 Atualiza um SelectedRoute conforme especificado pelo nome.