Points de terminaison synchrones et asynchrones

L'API Route Optimization expose deux méthodes:

  • OptimizeTours est une méthode synchrone qui renvoie un itinéraire optimisé en réponse à un OptimizeToursRequest. Les clients doivent maintenir une connexion ouverte à l'API Route Optimization jusqu'à ce que la requête soit traitée et qu'un OptimizeToursResponse ou une erreur soit renvoyé.
  • BatchOptimizeTours est une méthode asynchrone qui accepte des URI pour un ou plusieurs OptimizeToursRequest et les messages OptimizeToursResponse correspondants, et renvoie le nom de ressource d'une opération de longue durée (REST, gRPC) utilisée pour vérifier l'achèvement du lot. Les OptimizeToursRequest sont traitées en arrière-plan. Par conséquent, les clients ne maintiennent une connexion ouverte à l'API Route Optimization que le temps nécessaire pour envoyer le BatchOptimizeToursRequest ou pour appeler GetOperation afin de vérifier l'état de l'opération de longue durée. BatchOptimizeTours lit les requêtes provenant de Google Cloud Storage et y écrit les réponses.

Cas d'utilisation

OptimizeTours est pratique pour résoudre de petites requêtes simples ou des requêtes dont le temps de résolution est de quelques minutes ou moins. Le maintien de connexions de longue durée à l'API Route Optimization augmente le risque d'interruption avant qu'une solution puisse être renvoyée.

BatchOptimizeTours peut gérer des requêtes plus volumineuses et des requêtes avec un temps de résolution plus long, car il ne nécessite pas de connexion durable à l'API Route Optimization.

Opérations de longue durée

Les LRO sont lus à partir de l'API Route Optimization à l'aide de la méthode GetOperation pour vérifier l'état d'avancement d'un lot. Les LRO incluent une propriété done qui indique si le traitement de l'ensemble du lot est terminé et un champ error qui signale les erreurs rencontrées lors du traitement. Si done est défini sur "true" et qu'aucun error n'est présent, le lot a bien été exécuté. La présence d'un error indique que le traitement d'une partie ou de la totalité du lot a échoué.

Le cycle de vie typique d'une requête BatchOptimizeTours est le suivant:

  1. Envoyez un BatchOptimizeToursRequest à l'API Route Optimization, qui renvoie le nom de la ressource d'une opération de longue durée.
  2. Interrogez GetOperation avec le nom de la ressource LRO renvoyée jusqu'à ce que les propriétés done ou error apparaissent dans la réponse de l'opération de longue durée.
  3. Si done est défini sur "true" et qu'aucune erreur n'est présente, lisez OptimizeToursResponses à partir des URI Google Cloud Storage spécifiés dans la requête BatchOptimizeTours. Si error est présent, inspectez l'erreur, mettez à jour les OptimizeToursRequest en conséquence dans Google Cloud Storage, puis réessayez selon l'erreur observée.

Vous pouvez envoyer des requêtes OptimizeTours et BatchOptimizeTours de différentes manières, à partir de la ligne de commande ou à l'aide d'une bibliothèque cliente.

Étape suivante: Envoyer une requête API