Синхронные и асинхронные конечные точки

Разработчики Европейской экономической зоны (ЕЭЗ)

API оптимизации маршрутов предоставляет два метода:

  • OptimizeTours — это синхронный метод, который возвращает оптимизированный маршрут в ответ на запрос OptimizeToursRequest . Клиенты должны поддерживать открытое соединение с API оптимизации маршрутов до тех пор, пока запрос не будет обработан и не будет возвращён ответ OptimizeToursResponse или ошибка.
  • BatchOptimizeTours — это асинхронный метод, который принимает URI для одного или нескольких сообщений OptimizeToursRequest и соответствующих сообщений OptimizeToursResponse , возвращая имя ресурса длительной операции (LRO) ( REST , gRPC ), используемой для проверки завершения пакета. Сообщения OptimizeToursRequest обрабатываются в фоновом режиме, поэтому клиенты поддерживают открытые соединения с API оптимизации маршрутов только в течение времени, необходимого для отправки BatchOptimizeToursRequest или вызова GetOperation для проверки состояния LRO. BatchOptimizeTours считывает запросы из Google Cloud Storage и записывает ответы в него.

Варианты использования

OptimizeTours удобен для решения небольших и простых запросов или запросов, время выполнения которых не превышает нескольких минут. Поддержание длительных подключений к API оптимизации маршрутов увеличивает риск прерывания работы до момента возврата решения.

BatchOptimizeTours может обрабатывать более крупные запросы и запросы с более длительным временем решения, поскольку не требует длительного подключения к API оптимизации маршрутов.

Длительные операции

LRO считываются из API оптимизации маршрутов с помощью метода GetOperation для проверки статуса выполнения пакета. LRO включают свойство done , которое указывает, завершена ли обработка всего пакета, и поле error , в котором сообщается об ошибках, возникших во время обработки. Если done равно true и error нет, пакет выполнен успешно. Наличие error указывает на то, что обработка части или всех пакетов не удалась.

Типичный жизненный цикл запроса BatchOptimizeTours выглядит следующим образом:

  1. Отправьте запрос BatchOptimizeToursRequest в API оптимизации маршрута, который вернет имя ресурса LRO.
  2. Опрашивайте GetOperation с возвращенным именем ресурса LRO, пока в ответе LRO не появятся свойства done или error .
  3. Если done равно true и ошибок нет, считайте OptimizeToursResponses из URI Google Cloud Storage, указанных в запросе BatchOptimizeTours . Если error присутствует, проверьте её, соответствующим образом обновите OptimizeToursRequest в Google Cloud Storage и повторите попытку в зависимости от обнаруженной ошибки.

Запросы OptimizeTours и BatchOptimizeTours можно отправлять различными способами: из командной строки или с помощью клиентской библиотеки.

Далее: Сделайте запрос API