Índice
RoadsSelection(interface)BatchCreateSelectedRoutesRequest(mensagem)BatchCreateSelectedRoutesResponse(mensagem)BatchDeleteSelectedRoutesRequest(mensagem)BatchUpdateSelectedRoutesRequest(mensagem)BatchUpdateSelectedRoutesResponse(mensagem)CreateSelectedRouteRequest(mensagem)DeleteSelectedRouteRequest(mensagem)GetSelectedRouteRequest(mensagem)ListSelectedRoutesRequest(mensagem)ListSelectedRoutesResponse(mensagem)SelectedRoute(mensagem)SelectedRoute.DynamicRoute(mensagem)SelectedRoute.State(enum)SelectedRoute.ValidationError(enum)UpdateSelectedRouteRequest(mensagem)
RoadsSelection
Definição de serviço da API Roads Selection.
| BatchCreateSelectedRoutes |
|---|
|
Cria vários recursos
|
| BatchDeleteSelectedRoutes |
|---|
|
Exclui vários recursos
|
| BatchUpdateSelectedRoutes |
|---|
|
Atualiza vários recursos
|
| CreateSelectedRoute |
|---|
|
Cria um SelectedRoute e inicia uma programação para recuperar periodicamente as 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 todos os recursos
|
| UpdateSelectedRoute |
|---|
|
Atualiza uma SelectedRoute conforme especificado pelo nome.
|
BatchCreateSelectedRoutesRequest
Solicitação para criar vários SelectedRoutes.
| Campos | |
|---|---|
parent |
Obrigatório. O recurso do projeto compartilhado por todas as rotas selecionadas no lote. Ele é obrigatório porque a solicitação em lote só aceita um único |
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. O recurso pai de cada solicitação precisa estar vazio ou corresponder ao |
BatchCreateSelectedRoutesResponse
Resposta da criação de vários SelectedRoutes.
| Campos | |
|---|---|
selected_routes[] |
Recursos de |
BatchDeleteSelectedRoutesRequest
Solicitação para excluir vários SelectedRoutes.
| Campos | |
|---|---|
parent |
Obrigatório. O recurso do projeto compartilhado por todas as rotas selecionadas para exclusão. Ele é obrigatório porque a solicitação em lote só aceita um único |
names[] |
Obrigatório. Os nomes das rotas selecionadas para exclusão. É possível excluir até 1.000 rotas selecionadas em um lote. Formato: projects/{project}/selectedRoutes/{selected_route} |
BatchUpdateSelectedRoutesRequest
Solicitação para atualizar vários SelectedRoutes.
| Campos | |
|---|---|
parent |
Obrigatório. O recurso do projeto compartilhado por todas as rotas selecionadas no lote. Ele é obrigatório porque a solicitação em lote só aceita um único |
requests[] |
Obrigatório. A mensagem de solicitação que especifica a rota selecionada para atualização. É possível atualizar até 1.000 rotas selecionadas em um lote. O recurso pai de cada solicitação precisa estar vazio ou corresponder ao |
update_mask |
Opcional. A lista de campos a serem atualizados compartilhados por todas as solicitações filhas no lote. Os caminhos de campo são relativos a Exemplo: Se definido, esse Se omitido, o |
BatchUpdateSelectedRoutesResponse
Resposta da atualização de vários SelectedRoutes.
| Campos | |
|---|---|
selected_routes[] |
|
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 da SelectedRoute a ser excluída. 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 |
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, o valor é definido como padrão. O valor máximo é 5.000. Qualquer valor acima disso é 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 recursos |
next_page_token |
Token que pode ser enviado como |
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.
| Campos | |
|---|---|
name |
Identificador. Nome do recurso do Formato: projects/{project}/selectedRoutes/{selected_route} |
display_name |
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). |
create_time |
Apenas saída. Hora em que o trajeto selecionado foi criado. |
state |
Apenas saída. O estado da rota selecionada. |
route_attributes |
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 |
Campo de união route_type. Somente 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 da rota selecionada quando o estado é STATE_INVALID. |
dynamic_routing |
Opcional. Se definido como |
DynamicRoute
Representa um trajeto com waypoints (origem, destino e intermediários). O trajeto real vai passar por todos os waypoints. Se dynamic_routing for definido como false, o trajeto real vai permanecer fixo, independentemente das condições de trânsito. Caso contrário, se dynamic_routing for definido como true, o trajeto real poderá mudar com base nas condições de trânsito.
| Campos | |
|---|---|
origin |
Obrigatório. Local de origem da rota. |
destination |
Obrigatório. Local de término do trajeto. |
intermediates[] |
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. |
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). |
UpdateSelectedRouteRequest
Solicitação para atualizar um SelectedRoute.
| Campos | |
|---|---|
selected_route |
Obrigatório. O |
update_mask |
Opcional. Lista de campos a serem atualizados. Os caminhos de campo são relativos a Exemplo: Se Se |