Endpoint sincroni e asincroni

L'API Route Optimization espone due metodi:

  • OptimizeTours è un metodo sincrono che restituisce un percorso ottimizzato in risposta a un OptimizeToursRequest. I client devono mantenere aperta la connessione all'API Route Optimization finché la richiesta non viene elaborata e non viene restituito un valore OptimizeToursResponse o un errore.
  • BatchOptimizeTours è un metodo asincrono che accetta URI per uno o più messaggi OptimizeToursRequest e OptimizeToursResponse corrispondenti, restituendo il nome della risorsa di un'operazione a lunga esecuzione (LRO) (REST, gRPC) utilizzata per verificare il completamento del batch. I messaggi OptimizeToursRequest vengono elaborati in background, pertanto i client mantengono aperte le connessioni all'API Route Optimization solo il tempo necessario per inviare il messaggio BatchOptimizeToursRequest o per chiamare GetOperation per controllare lo stato dell'operazione LRO. BatchOptimizeTours legge le richieste e scrive le risposte in Google Cloud Storage.

Casi d'uso

OptimizeTours è comodo per risolvere richieste piccole e semplici o per richieste con tempi di risoluzione di alcuni minuti o meno. Il mantenimento di connessioni di lunga durata all'API Route Optimization aumenta il rischio di interruzione prima che sia possibile restituire una soluzione.

BatchOptimizeTours può gestire richieste più grandi e con tempi di risoluzione più lunghi perché non richiede una connessione di lunga durata all'API Route Optimization.

Operazioni a lunga esecuzione

Le LRO vengono lette dall'API Route Optimization utilizzando il metodo GetOperation per controllare lo stato di completamento di un batch. Le richieste LRO includono una proprietà done che indica se l'elaborazione dell'intero batch è completata e un campo error che segnala gli errori riscontrati durante l'elaborazione. Se done è vero e non è presente error, il batch è stato completato correttamente. La presenza di un valore error indica che l'elaborazione del batch non è riuscita in parte o del tutto.

Il ciclo di vita tipico di una richiesta BatchOptimizeTours è il seguente:

  1. Invia un BatchOptimizeToursRequest all'API Route Optimization, che restituisce il nome della risorsa di un LRO.
  2. Esegui un sondaggio su GetOperation con il nome della risorsa LRO restituito finché le proprietà done o error non vengono visualizzate nella risposta LRO.
  3. Se done è true e non è presente alcun errore, leggi OptimizeToursResponses degli URI di Google Cloud Storage specificati nella richiesta BatchOptimizeTours. Se è presente error, controlla l'errore, aggiorna i OptimizeToursRequest di conseguenza in Google Cloud Storage e riprova come opportuno a seconda dell'errore osservato.

Puoi inviare richieste OptimizeTours e BatchOptimizeTours in diversi modi, dalla riga di comando o utilizzando una libreria client.

Passaggio successivo: effettua una richiesta API