Índice
RoadsSelection(interface)BatchCreateSelectedRoutesRequest(mensagem)BatchCreateSelectedRoutesResponse(mensagem)CreateSelectedRouteRequest(mensagem)DeleteSelectedRouteRequest(mensagem)GetSelectedRouteRequest(mensagem)ListSelectedRoutesRequest(mensagem)ListSelectedRoutesResponse(mensagem)SelectedRoute(mensagem)SelectedRoute.DynamicRoute(mensagem)SelectedRoute.State(enum)SelectedRoute.ValidationError(enum)
RoadsSelection
Definição de serviço da API Roads Selection.
| BatchCreateSelectedRoutes |
|---|
|
Cria várias SelectedRoutes e inicia uma programação para recuperar periodicamente informações de cache de cada uma das rotas.
|
| CreateSelectedRoute |
|---|
|
Cria um SelectedRoute e inicia uma programação para recuperar periodicamente informações de cache da rota.
|
| DeleteSelectedRoute |
|---|
|
Exclui o SelectedRoute especificado para o projeto especificado.
|
| GetSelectedRoute |
|---|
|
Recebe um SelectedRoute conforme especificado pelo nome.
|
| ListSelectedRoutes |
|---|
|
Lista todas as SelectedRoutes do projeto especificado com paginação.
|
BatchCreateSelectedRoutesRequest
Solicitação para criar vários SelectedRoutes.
| Campos | |
|---|---|
parent |
Opcional. O recurso de projeto compartilhado por todas as rotas selecionadas. Formato: projects/{project}. Se este campo estiver definido, o campo "parent" nas mensagens "CreateSelectedRouteRequest" precisará estar vazio ou corresponder a este campo. |
requests[] |
Obrigatório. A mensagem de solicitação que especifica a rota selecionada a ser criada. É possível criar no máximo 1.000 rotas selecionadas em um lote. |
BatchCreateSelectedRoutesResponse
Resposta da criação de várias SelectedRoutes.
| Campos | |
|---|---|
selected_routes[] |
SelectedRoutes criado. |
CreateSelectedRouteRequest
Solicitação para criar um SelectedRoute.
| Campos | |
|---|---|
parent |
Obrigatório. O projeto em que o |
selected_route |
Obrigatório. O |
selected_route_id |
Opcional. O ID a ser usado para o Esse valor precisa ter de 4 a 63 caracteres, e os caracteres válidos são: "a-z", "A-Z", "0-9" ou "-". Se ele não for fornecido ou estiver vazio, um UUID será gerado após a criação do recurso. |
DeleteSelectedRouteRequest
Solicitação para excluir um SelectedRoute.
| Campos | |
|---|---|
name |
Obrigatório. O nome do SelectedRoute a ser excluído. Formato: projects/{project}/selectedRoutes/{selected_route} |
GetSelectedRouteRequest
Solicitação para receber um SelectedRoute.
| Campos | |
|---|---|
name |
Obrigatório. O nome do |
ListSelectedRoutesRequest
Solicitação para listar SelectedRoutes.
| Campos | |
|---|---|
parent |
Obrigatório. O pai, que é o projeto de onde todos os |
page_size |
Opcional. O número de resultados que devem ser retornados para uma determinada página. Se não for definido, o valor padrão será 100. Quando um valor de 0 é fornecido, ele é definido como o padrão. O valor máximo é 5.000. Qualquer valor acima disso será definido como 5.000. |
page_token |
Opcional. Um token de página recebido de uma chamada |
ListSelectedRoutesResponse
Resposta que lista SelectedRoutes.
| Campos | |
|---|---|
selected_routes[] |
Uma página de SelectedRoutes armazenada no projeto especificado na solicitação. |
next_page_token |
Token que pode ser enviado como |
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.
| Campos | |
|---|---|
name |
Identificador. Nome do recurso do Formato: projects/{project}/selectedRoutes/{selected_route} |
display_name |
Opcional. Nome de exibição da rota. Esse é um campo opcional que pode ser usado pelo cliente. Ele não precisa ser único. |
create_time |
Apenas saída. A hora em que a rota selecionada foi criada. |
state |
Apenas saída. O estado da rota selecionada. |
route_attributes |
Opcional. Os atributos personalizados da rota selecionada. Ao adicioná-los, é possível filtrar / 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". |
Campo de união route_type. No momento, apenas DynamicRoute é aceito. route_type pode ser apenas de um dos tipos a seguir: |
|
dynamic_route |
O |
validation_error |
Apenas saída. O erro de validação para a rota selecionada quando o estado é STATE_INVALID. |
DynamicRoute
Representa uma rota com waypoints (origem, destino e intermediários). A rota real passa por todos os pontos de parada, mas pode mudar de tempos em tempos devido às variações nas condições de trânsito.
| Campos | |
|---|---|
origin |
Obrigatório. Local de origem do trajeto. |
destination |
Obrigatório. Local de término do trajeto. |
intermediates[] |
Opcional. Um conjunto de pontos de referência intermediários ao longo do trajeto (excluindo os pontos finais). Eles são sempre pontos de passagem. É possível usar até 25 waypoints intermediários. Adicionar esses dados corretamente pode reduzir a variação do trajeto real ao longo do tempo. |
Estado
O estado da rota selecionada.
| Enums | |
|---|---|
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.
| Enums | |
|---|---|
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 da via (muito poucas pessoas passam por ela). |