REST Resource: selection.v1.projects.selectedRoutes

Recurso: SelectedRoute

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

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

Identificador. Nome do recurso do SelectedRoute.

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

string

Opcional. Nome de exibição da rota. Esse campo é opcional e pode ser usado pelo cliente. Ele não precisa ser único. O comprimento é limitado a 100 caracteres (contados em pontos de código Unicode).
createTime

string (Timestamp format)

Apenas saída. Hora em que o trajeto selecionado foi criado.

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. Ao adicionar esses dados, é possível filtrar ou agrupar os trajetos ao recuperar informações históricas e em tempo real. Até 25 atributos são aceitos por rota. Cada chave e valor precisa ser uma string não vazia e pode ter até 100 caracteres (contados em pontos de código Unicode). As chaves não podem começar com goog.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Somente DynamicRoute é aceito. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
dynamicRoute

object (DynamicRoute)

O SelectedRoute é uma rota dinâmica.
Fim dos campos mutuamente exclusivos.
validationError

enum (ValidationError)

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

boolean

Opcional. Se definido como true, a rota selecionada poderá ser recalculada dinamicamente com base no trânsito em tempo real de acordo com os pontos de passagem de entrada. Se definido como false, o trajeto selecionado será fixo, independente do trânsito em tempo real, e seguirá o caminho calculado no momento da criação, sem considerar o trânsito. Se omitido, o valor será false por padrão, indicando que é uma rota fixa.

DynamicRoute

Representa um trajeto com waypoints (origem, destino e intermediários). O trajeto real vai passar por todos os waypoints. Se dynamicRouting for definido como false, o trajeto real vai permanecer fixo, independentemente das condições de trânsito. Caso contrário, se dynamicRouting for definido como true, o trajeto real poderá mudar com base nas condições de trânsito.

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 término do trajeto.
intermediates[]

object (LatLng)

Opcional. Um conjunto de waypoints intermediários ao longo do trajeto (exceto os pontos terminais). Eles são sempre pontos de passagem. Até 25 waypoints intermediários são aceitos. Adicionar essas informações corretamente pode reduzir a variação do trajeto real periodicamente.

LatLng

Um objeto que representa um par de latitude/longitude. Ele é expresso como um par de valores duplos para representar graus de latitude e 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 desta 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 O trajeto tem baixo uso da via (poucas pessoas passam por ele).

Métodos

batchCreate

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

batchDelete

 Exclui vários recursos SelectedRoute do projeto especificado.

batchUpdate

 Atualiza vários recursos SelectedRoute conforme especificado pelos nomes deles.

create

 Cria um SelectedRoute e inicia uma programação para recuperar periodicamente as 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 do projeto especificado com paginação.

patch

 Atualiza uma SelectedRoute conforme especificado pelo nome.