feat: [routeoptimization] Add support for generating route tokens (#5706

)

* feat: Add support for generating route tokens

feat: A new field `route_token` is added to message `.google.maps.routeoptimization.v1.ShipmentRoute.Transition`
docs: A comment for method `BatchOptimizeTours` in service `RouteOptimization` is changed
docs: A comment for field `populate_transition_polylines` in message `.google.maps.routeoptimization.v1.OptimizeToursRequest` is changed
docs: A comment for field `code` in message `.google.maps.routeoptimization.v1.OptimizeToursValidationError` is changed
PiperOrigin-RevId: 677952232

Source-Link: googleapis/googleapis@534e49c

Source-Link: googleapis/googleapis-gen@da6e35d
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtcm91dGVvcHRpbWl6YXRpb24vLk93bEJvdC55YW1sIiwiaCI6ImRhNmUzNWQzMWIwZGU5ZGRiYWE5N2JkOTY0ODk5ZmJiOWIxYzAwMGMifQ==

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Daniel Bankhead <[email protected]>
Co-authored-by: sofisl <[email protected]>

packages/google-maps-routeoptimization/samples/generated/v1/route_optimization.optimize_tours.js

@@ -186,7 +186,7 @@ function main(parent) {
    */
   // const populatePolylines = true
   /**
-   *  If true, polylines will be populated in response
+   *  If true, polylines and route tokens will be populated in response
    *  ShipmentRoute.transitions google.maps.routeoptimization.v1.ShipmentRoute.transitions.
    */
   // const populateTransitionPolylines = true

packages/google-maps-routeoptimization/samples/generated/v1/snippet_metadata_google.maps.routeoptimization.v1.json

@@ -119,7 +119,7 @@
             "regionTag": "routeoptimization_v1_generated_RouteOptimization_BatchOptimizeTours_async",
             "title": "RouteOptimization batchOptimizeTours Sample",
             "origin": "API_DEFINITION",
-            "description": " Optimizes vehicle tours for one or more `OptimizeToursRequest` messages as a batch. This method is a Long Running Operation (LRO). The inputs for optimization (`OptimizeToursRequest` messages) and outputs (`OptimizeToursResponse` messages) are read/written from/to Cloud Storage in user-specified format. Like the `OptimizeTours` method, each `OptimizeToursRequest` contains a `ShipmentModel` and returns an `OptimizeToursResponse` containing `ShipmentRoute`s, which are a set of routes to be performed by vehicles minimizing the overall cost. The user can poll `operations.get` to check the status of the LRO: If the LRO's `done` field is false, then at least one request is still being processed. Other requests may have completed successfully and their results are available in GCS. If the LRO's `done` field is true, then all requests have been processed. Any successfully processed requests will have their results available in GCS. Any requests that failed will not have their results available in GCS. If the LRO's `error` field is set, then it contains the error from one of the failed requests.",
+            "description": " Optimizes vehicle tours for one or more `OptimizeToursRequest` messages as a batch. This method is a Long Running Operation (LRO). The inputs for optimization (`OptimizeToursRequest` messages) and outputs (`OptimizeToursResponse` messages) are read from and written to Cloud Storage in user-specified format. Like the `OptimizeTours` method, each `OptimizeToursRequest` contains a `ShipmentModel` and returns an `OptimizeToursResponse` containing `ShipmentRoute` fields, which are a set of routes to be performed by vehicles minimizing the overall cost. The user can poll `operations.get` to check the status of the LRO: If the LRO `done` field is false, then at least one request is still being processed. Other requests may have completed successfully and their results are available in Cloud Storage. If the LRO's `done` field is true, then all requests have been processed. Any successfully processed requests will have their results available in Cloud Storage. Any requests that failed will not have their results available in Cloud Storage. If the LRO's `error` field is set, then it contains the error from one of the failed requests.",
             "canonical": true,
             "file": "route_optimization.batch_optimize_tours.js",
             "language": "JAVASCRIPT",

packages/google-maps-routeoptimization/src/v1/route_optimization_client.ts

@@ -587,7 +587,7 @@ export class RouteOptimizationClient {
    * @param {boolean} request.populatePolylines
    *   If true, polylines will be populated in response `ShipmentRoute`s.
    * @param {boolean} request.populateTransitionPolylines
-   *   If true, polylines will be populated in response
+   *   If true, polylines and route tokens will be populated in response
    *   {@link protos.google.maps.routeoptimization.v1.ShipmentRoute.transitions|ShipmentRoute.transitions}.
    * @param {boolean} request.allowLargeDeadlineDespiteInterruptionRisk
    *   If this is set, then the request can have a deadline
@@ -704,23 +704,23 @@ export class RouteOptimizationClient {
    *
    * This method is a Long Running Operation (LRO). The inputs for optimization
    * (`OptimizeToursRequest` messages) and outputs (`OptimizeToursResponse`
-   * messages) are read/written from/to Cloud Storage in user-specified
+   * messages) are read from and written to Cloud Storage in user-specified
    * format. Like the `OptimizeTours` method, each `OptimizeToursRequest`
    * contains a `ShipmentModel` and returns an `OptimizeToursResponse`
-   * containing `ShipmentRoute`s, which are a set of routes to be performed by
-   * vehicles minimizing the overall cost.
+   * containing `ShipmentRoute` fields, which are a set of routes to be
+   * performed by vehicles minimizing the overall cost.
    *
    * The user can poll `operations.get` to check the status of the LRO:
    *
-   * If the LRO's `done` field is false, then at least one request is still
+   * If the LRO `done` field is false, then at least one request is still
    * being processed. Other requests may have completed successfully and their
-   * results are available in GCS.
+   * results are available in Cloud Storage.
    *
    * If the LRO's `done` field is true, then all requests have been processed.
    * Any successfully processed requests will have their results available in
-   * GCS. Any requests that failed will not have their results available in
-   * GCS. If the LRO's `error` field is set, then it contains the error from
-   * one of the failed requests.
+   * Cloud Storage. Any requests that failed will not have their results
+   * available in Cloud Storage. If the LRO's `error` field is set, then it
+   * contains the error from one of the failed requests.
    *
    * @param {Object} request
    *   The request object that will be sent.