Index
RoadsSelection(interface)BatchCreateSelectedRoutesRequest(message)BatchCreateSelectedRoutesResponse(message)BatchDeleteSelectedRoutesRequest(message)BatchUpdateSelectedRoutesRequest(message)BatchUpdateSelectedRoutesResponse(message)CreateSelectedRouteRequest(message)DeleteSelectedRouteRequest(message)GetSelectedRouteRequest(message)ListSelectedRoutesRequest(message)ListSelectedRoutesResponse(message)SelectedRoute(message)SelectedRoute.DynamicRoute(message)SelectedRoute.State(enum)SelectedRoute.ValidationError(enum)UpdateSelectedRouteRequest(message)
RoadsSelection
Définition de service pour l'API Roads Selection.
| BatchCreateSelectedRoutes |
|---|
|
Crée plusieurs ressources
|
| BatchDeleteSelectedRoutes |
|---|
|
Supprime plusieurs ressources
|
| BatchUpdateSelectedRoutes |
|---|
|
Met à jour plusieurs ressources
|
| CreateSelectedRoute |
|---|
|
Crée une SelectedRoute et lance une planification pour récupérer régulièrement les informations de cache de l'itinéraire.
|
| DeleteSelectedRoute |
|---|
|
Supprime la SelectedRoute spécifiée pour le projet spécifié.
|
| GetSelectedRoute |
|---|
|
Récupère un SelectedRoute spécifié par son nom.
|
| ListSelectedRoutes |
|---|
|
Répertorie toutes les ressources
|
| UpdateSelectedRoute |
|---|
|
Met à jour un SelectedRoute spécifié par son nom.
|
BatchCreateSelectedRoutesRequest
Requête de création de plusieurs SelectedRoute.
| Champs | |
|---|---|
parent |
Obligatoire. Ressource de projet partagée par toutes les routes sélectionnées dans le lot. Il est obligatoire, car la requête par lot n'accepte qu'un seul |
requests[] |
Obligatoire. Message de requête spécifiant la route sélectionnée à créer. Vous pouvez créer jusqu'à 1 000 itinéraires sélectionnés dans un lot. La ressource parente de chaque requête doit être vide ou correspondre à l'élément |
BatchCreateSelectedRoutesResponse
Réponse de la création de plusieurs SelectedRoute.
| Champs | |
|---|---|
selected_routes[] |
|
BatchDeleteSelectedRoutesRequest
Requête de suppression de plusieurs SelectedRoute.
| Champs | |
|---|---|
parent |
Obligatoire. Ressource de projet partagée par toutes les routes sélectionnées à supprimer. Il est obligatoire, car la requête par lot n'accepte qu'un seul |
names[] |
Obligatoire. Noms des routes sélectionnées à supprimer. Vous pouvez supprimer jusqu'à 1 000 routes sélectionnées par lot. Format : projects/{project}/selectedRoutes/{selected_route} |
BatchUpdateSelectedRoutesRequest
Requête de mise à jour de plusieurs SelectedRoute.
| Champs | |
|---|---|
parent |
Obligatoire. Ressource de projet partagée par toutes les routes sélectionnées dans le lot. Il est obligatoire, car la requête par lot n'accepte qu'un seul |
requests[] |
Obligatoire. Message de requête spécifiant la route sélectionnée à mettre à jour. Vous pouvez mettre à jour jusqu'à 1 000 routes sélectionnées par lot. La ressource parente de chaque requête doit être vide ou correspondre à l'élément |
update_mask |
Facultatif. Liste des champs à mettre à jour, partagée par toutes les requêtes enfants du lot. Les chemins d'accès aux champs sont relatifs à Exemple : S'il est défini, ce Si ce champ est omis, le |
BatchUpdateSelectedRoutesResponse
Réponse de la mise à jour de plusieurs SelectedRoute.
| Champs | |
|---|---|
selected_routes[] |
|
CreateSelectedRouteRequest
Requête de création d'un SelectedRoute.
| Champs | |
|---|---|
parent |
Obligatoire. Projet dans lequel le |
selected_route |
Obligatoire. |
selected_route_id |
Facultatif. ID à utiliser pour l'élément Cette valeur doit contenir entre 4 et 63 caractères, et les caractères valides sont "a-z", "A-Z", "0-9", "-" ou "_". Si vous ne fournissez pas d'ID ou si le champ est vide, un UUID sera généré après la création de la ressource. |
DeleteSelectedRouteRequest
Requête de suppression d'un SelectedRoute.
| Champs | |
|---|---|
name |
Obligatoire. Nom de la SelectedRoute à supprimer. Format : projects/{project}/selectedRoutes/{selected_route} |
GetSelectedRouteRequest
Requête pour obtenir un SelectedRoute.
| Champs | |
|---|---|
name |
Obligatoire. Nom de la ressource |
ListSelectedRoutesRequest
Requête permettant de lister les ressources SelectedRoute.
| Champs | |
|---|---|
parent |
Obligatoire. |
page_size |
Facultatif. Nombre de résultats à renvoyer pour une page donnée. Si ce nombre n'est pas défini, la valeur par défaut est 100. Lorsque la valeur 0 est spécifiée, la valeur par défaut est définie. La valeur maximale est de 5 000. Toute valeur supérieure à 5 000 est définie sur 5 000. |
page_token |
Facultatif. Jeton de page reçu d'un appel |
ListSelectedRoutesResponse
Réponse listant les SelectedRoute.
| Champs | |
|---|---|
selected_routes[] |
Page de ressources |
next_page_token |
Jeton pouvant être envoyé en tant que |
SelectedRoute
Un SelectedRoute représente un itinéraire spécifique pour lequel un client souhaite récupérer régulièrement des informations (par exemple, la durée) pour des cas d'utilisation contractuels.
| Champs | |
|---|---|
name |
Identifiant. Nom de ressource de Format : projects/{project}/selectedRoutes/{selected_route} |
display_name |
Facultatif. Nom à afficher de la route. Il s'agit d'un champ facultatif qui peut être utilisé par le client. Il ne doit pas forcément être unique. La longueur est limitée à 100 caractères (comptés en points de code Unicode). |
create_time |
Uniquement en sortie. Heure à laquelle la route sélectionnée a été créée. |
state |
Uniquement en sortie. État de la route sélectionnée. |
route_attributes |
Facultatif. Attributs personnalisés de la route sélectionnée. L'ajout de ces tags permet de filtrer ou de regrouper les itinéraires lors de la récupération des informations historiques et en temps réel sur les itinéraires. Vous pouvez utiliser jusqu'à 25 attributs par itinéraire. Chaque clé et chaque valeur doivent être une chaîne non vide et peuvent comporter jusqu'à 100 caractères (comptés en points de code Unicode). Les clés ne doivent pas commencer par |
Champ d'union route_type. Seule la région DynamicRoute est compatible. La route_type ne peut être qu'un des éléments suivants : |
|
dynamic_route |
|
validation_error |
Uniquement en sortie. Erreur de validation pour la route sélectionnée lorsque l'état est STATE_INVALID. |
dynamic_routing |
Facultatif. Si la valeur est définie sur |
DynamicRoute
Il représente un itinéraire avec des points de cheminement (point de départ, destination et points intermédiaires). L'itinéraire réel passera par tous les points de cheminement. Si dynamic_routing est défini sur false, l'itinéraire réel reste fixe, quelles que soient les conditions de circulation. Sinon, si dynamic_routing est défini sur true, l'itinéraire réel peut changer en fonction des conditions de circulation.
| Champs | |
|---|---|
origin |
Obligatoire. Lieu de départ de l'itinéraire. |
destination |
Obligatoire. Lieu d'arrivée de l'itinéraire. |
intermediates[] |
Facultatif. Ensemble de points de cheminement intermédiaires le long de l'itinéraire (à l'exclusion des points de terminaison). Il s'agit toujours de points de passage. Vous pouvez ajouter jusqu'à 25 points de cheminement intermédiaires. En les ajoutant correctement, vous pouvez réduire les variations de l'itinéraire réel de temps en temps. |
État
État de la route sélectionnée.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
L'état de cette route n'est pas défini. |
STATE_SCHEDULING |
L'itinéraire a été créé et est en cours de planification. |
STATE_RUNNING |
La route a été créée et est associée à une programmation active. |
STATE_DELETING |
La route a été marquée pour suppression. |
STATE_VALIDATING |
La route est en cours de validation. |
STATE_INVALID |
La route n'est pas valide d'après l'un des critères de validation. |
ValidationError
Erreur de validation pour l'itinéraire sélectionné.
| Enums | |
|---|---|
VALIDATION_ERROR_UNSPECIFIED |
L'erreur de validation de cette route n'est pas définie. |
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION |
La route se trouve en dehors de la juridiction du projet. |
VALIDATION_ERROR_LOW_ROAD_USAGE |
La route est peu fréquentée (très peu de personnes l'empruntent). |
UpdateSelectedRouteRequest
Requête de mise à jour d'un SelectedRoute.
| Champs | |
|---|---|
selected_route |
Obligatoire. |
update_mask |
Facultatif. Liste des champs à mettre à jour. Les chemins d'accès aux champs sont relatifs à Exemple : Si Si |