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,
    ...
  },

  // 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)
}
Campos
name

string

Identificador. Nome do recurso do SelectedRoute.

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

string

Opcional. Nome de exibição da rota. Esse é um campo opcional que 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. A 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. Ao adicioná-los, é possível filtrar ou agrupar as rotas 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" }.
No momento, apenas DynamicRoute é aceito. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo, um dos campos será definido em uma solicitação:
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 para o trajeto selecionado quando o estado é STATE_INVALID.

DynamicRoute

Representa uma rota com waypoints (origem, destino e intermediários). O trajeto real passa por todos os pontos de referência, mas pode mudar de tempos em tempos devido às variações 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 do trajeto.
destination

object (LatLng)

Obrigatório. Local de término do trajeto.
intermediates[]

object (LatLng)

Opcional. Um conjunto de pontos de referência intermediários ao longo do trajeto (excluindo os pontos terminais). Eles são sempre pontos de passagem. É possível usar até 25 waypoints intermediários. Adicionar esses pontos 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 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 desta 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 vias (muito 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 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 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 um SelectedRoute conforme especificado pelo nome.