docs: fix minor docstring formatting (#3684)

* docs: fix minor docstring formatting PiperOrigin-RevId: 491440092 Source-Link: googleapis/googleapis@16db2fb Source-Link: googleapis/googleapis-gen@5ac3b73 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLW9wdGltaXphdGlvbi8uT3dsQm90LnlhbWwiLCJoIjoiNWFjM2I3M2EwYWY1ZTFkY2NlZTUzNDMxZTNkNTEyNGZkMTZlMzA3MyJ9 * Update .OwlBot.lock.yaml * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Update .OwlBot.lock.yaml Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: sofisl <[email protected]>
googleapis · Nov 30, 2022 · a4916de · a4916de
1 parent d978fb0
commit a4916de
Show file tree

Hide file tree

Showing 6 changed files with 287 additions and 157 deletions.
diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml
@@ -13,4 +13,4 @@
 # limitations under the License.
 docker:
   image: gcr.io/cloud-devrel-public-resources/owlbot-nodejs-mono-repo:latest
-  digest: sha256:4178ea7c7f3e71650ca9f50fc8eb9ccbe004e4d4ea6aeac26a2249d32ea823f8
+  digest: sha256:2fe57986c24050a5a5a2f51a3c609b28eaa88eebe16d47c7ffcbfed7bbd38ac0
diff --git a/packages/google-cloud-optimization/protos/google/cloud/optimization/v1/fleet_routing.proto b/packages/google-cloud-optimization/protos/google/cloud/optimization/v1/fleet_routing.proto
diff --git a/...ages/google-cloud-optimization/samples/generated/v1/fleet_routing.batch_optimize_tours.js b/...ages/google-cloud-optimization/samples/generated/v1/fleet_routing.batch_optimize_tours.js
@@ -35,8 +35,8 @@ function main(parent, modelConfigs) {
    */
   // const parent = 'abc123'
   /**
-   *  Required. Input/Output information each purchase model, such as file paths and data
-   *  formats.
+   *  Required. Input/Output information each purchase model, such as file paths
+   *  and data formats.
    */
   // const modelConfigs = 1234
 

diff --git a/packages/google-cloud-optimization/samples/generated/v1/fleet_routing.optimize_tours.js b/packages/google-cloud-optimization/samples/generated/v1/fleet_routing.optimize_tours.js
@@ -83,8 +83,9 @@ function main(parent) {
    *      <= visits0.start_time <= visits1.start_time ...
    *      <= vehicle_end_time`).
    *    * a shipment may only be performed on a vehicle that is allowed. A
-   *      vehicle is allowed if Shipment.allowed_vehicle_indices google.cloud.optimization.v1.Shipment.allowed_vehicle_indices  is empty or
-   *      its `vehicle_index` is included in
+   *      vehicle is allowed if
+   *      Shipment.allowed_vehicle_indices google.cloud.optimization.v1.Shipment.allowed_vehicle_indices 
+   *      is empty or its `vehicle_index` is included in
    *      Shipment.allowed_vehicle_indices google.cloud.optimization.v1.Shipment.allowed_vehicle_indices.
    *  If the injected solution is not feasible, a validation error is not
    *  necessarily returned and an error indicating infeasibility may be returned
@@ -118,16 +119,27 @@ function main(parent) {
   // const refreshDetailsRoutes = 1234
   /**
    *  If true:
-   *    * uses ShipmentRoute.vehicle_label google.cloud.optimization.v1.ShipmentRoute.vehicle_label  instead of `vehicle_index` to
+   *    * uses
+   *    ShipmentRoute.vehicle_label google.cloud.optimization.v1.ShipmentRoute.vehicle_label 
+   *    instead of `vehicle_index` to
    *      match routes in an injected solution with vehicles in the request;
-   *      reuses the mapping of original ShipmentRoute.vehicle_index google.cloud.optimization.v1.ShipmentRoute.vehicle_index  to new
-   *      ShipmentRoute.vehicle_index google.cloud.optimization.v1.ShipmentRoute.vehicle_index  to update
+   *      reuses the mapping of original
+   *      ShipmentRoute.vehicle_index google.cloud.optimization.v1.ShipmentRoute.vehicle_index 
+   *      to new
+   *      ShipmentRoute.vehicle_index google.cloud.optimization.v1.ShipmentRoute.vehicle_index 
+   *      to update
    *      ConstraintRelaxation.vehicle_indices google.cloud.optimization.v1.InjectedSolutionConstraint.ConstraintRelaxation.vehicle_indices 
    *      if non-empty, but the mapping must be unambiguous (i.e., multiple
    *      `ShipmentRoute`s must not share the same original `vehicle_index`).
-   *    * uses ShipmentRoute.Visit.shipment_label google.cloud.optimization.v1.ShipmentRoute.Visit.shipment_label  instead of `shipment_index`
+   *    * uses
+   *    ShipmentRoute.Visit.shipment_label google.cloud.optimization.v1.ShipmentRoute.Visit.shipment_label 
+   *    instead of `shipment_index`
    *      to match visits in an injected solution with shipments in the request;
-   *    * uses SkippedShipment.label google.cloud.optimization.v1.SkippedShipment.label  instead of SkippedShipment.index google.cloud.optimization.v1.SkippedShipment.index  to
+   *    * uses
+   *    SkippedShipment.label google.cloud.optimization.v1.SkippedShipment.label 
+   *    instead of
+   *    SkippedShipment.index google.cloud.optimization.v1.SkippedShipment.index 
+   *    to
    *      match skipped shipments in the injected solution with request
    *      shipments.
    *  This interpretation applies to the `injected_first_solution_routes`,
@@ -137,8 +149,10 @@ function main(parent) {
    *  vehicles have been removed from or added to the request.
    *  If true, labels in the following categories must appear at most once in
    *  their category:
-   *    * Vehicle.label google.cloud.optimization.v1.Vehicle.label  in the request;
-   *    * Shipment.label google.cloud.optimization.v1.Shipment.label  in the request;
+   *    * Vehicle.label google.cloud.optimization.v1.Vehicle.label  in the
+   *    request;
+   *    * Shipment.label google.cloud.optimization.v1.Shipment.label  in the
+   *    request;
    *    * ShipmentRoute.vehicle_label google.cloud.optimization.v1.ShipmentRoute.vehicle_label  in the injected solution;
    *    * SkippedShipment.label google.cloud.optimization.v1.SkippedShipment.label  and ShipmentRoute.Visit.shipment_label google.cloud.optimization.v1.ShipmentRoute.Visit.shipment_label  in
    *      the injected solution (except pickup/delivery visit pairs, whose
@@ -147,27 +161,32 @@ function main(parent) {
    *  request vehicle, the corresponding route is removed from the solution
    *  along with its visits. If a `shipment_label` in the injected solution does
    *  not correspond to a request shipment, the corresponding visit is removed
-   *  from the solution. If a SkippedShipment.label google.cloud.optimization.v1.SkippedShipment.label  in the injected solution
-   *  does not correspond to a request shipment, the `SkippedShipment` is removed
-   *  from the solution.
+   *  from the solution. If a
+   *  SkippedShipment.label google.cloud.optimization.v1.SkippedShipment.label 
+   *  in the injected solution does not correspond to a request shipment, the
+   *  `SkippedShipment` is removed from the solution.
    *  Removing route visits or entire routes from an injected solution may
    *  have an effect on the implied constraints, which may lead to change in
    *  solution, validation errors, or infeasibility.
-   *  NOTE: The caller must ensure that each Vehicle.label google.cloud.optimization.v1.Vehicle.label 
-   *  (resp. Shipment.label google.cloud.optimization.v1.Shipment.label) uniquely identifies a vehicle (resp. shipment)
-   *  entity used across the two relevant requests: the past request that
-   *  produced the `OptimizeToursResponse` used in the injected solution and the
-   *  current request that includes the injected solution. The uniqueness checks
-   *  described above are not enough to guarantee this requirement.
+   *  NOTE: The caller must ensure that each
+   *  Vehicle.label google.cloud.optimization.v1.Vehicle.label  (resp.
+   *  Shipment.label google.cloud.optimization.v1.Shipment.label) uniquely
+   *  identifies a vehicle (resp. shipment) entity used across the two relevant
+   *  requests: the past request that produced the `OptimizeToursResponse` used
+   *  in the injected solution and the current request that includes the injected
+   *  solution. The uniqueness checks described above are not enough to guarantee
+   *  this requirement.
    */
   // const interpretInjectedSolutionsUsingLabels = true
   /**
    *  Consider traffic estimation in calculating `ShipmentRoute` fields
    *  Transition.travel_duration google.cloud.optimization.v1.ShipmentRoute.Transition.travel_duration,
    *  Visit.start_time google.cloud.optimization.v1.ShipmentRoute.Visit.start_time,
    *  and `vehicle_end_time`; in setting the
-   *  ShipmentRoute.has_traffic_infeasibilities google.cloud.optimization.v1.ShipmentRoute.has_traffic_infeasibilities  field, and in calculating the
-   *  OptimizeToursResponse.total_cost google.cloud.optimization.v1.OptimizeToursResponse.total_cost  field.
+   *  ShipmentRoute.has_traffic_infeasibilities google.cloud.optimization.v1.ShipmentRoute.has_traffic_infeasibilities 
+   *  field, and in calculating the
+   *  OptimizeToursResponse.total_cost google.cloud.optimization.v1.OptimizeToursResponse.total_cost 
+   *  field.
    */
   // const considerRoadTraffic = true
   /**

diff --git a/...loud-optimization/samples/generated/v1/snippet_metadata.google.cloud.optimization.v1.json b/...loud-optimization/samples/generated/v1/snippet_metadata.google.cloud.optimization.v1.json
@@ -22,7 +22,7 @@
             "segments": [
                 {
                     "start": 25,
-                    "end": 227,
+                    "end": 246,
                     "type": "FULL"
                 }
             ],

diff --git a/packages/google-cloud-optimization/src/v1/fleet_routing_client.ts b/packages/google-cloud-optimization/src/v1/fleet_routing_client.ts
@@ -424,8 +424,9 @@ export class FleetRoutingClient {
    *       <= visits[0].start_time <= visits[1].start_time ...
    *       <= vehicle_end_time`).
    *     * a shipment may only be performed on a vehicle that is allowed. A
-   *       vehicle is allowed if {@link google.cloud.optimization.v1.Shipment.allowed_vehicle_indices|Shipment.allowed_vehicle_indices} is empty or
-   *       its `vehicle_index` is included in
+   *       vehicle is allowed if
+   *       {@link google.cloud.optimization.v1.Shipment.allowed_vehicle_indices|Shipment.allowed_vehicle_indices}
+   *       is empty or its `vehicle_index` is included in
    *       {@link google.cloud.optimization.v1.Shipment.allowed_vehicle_indices|Shipment.allowed_vehicle_indices}.
    *
    *   If the injected solution is not feasible, a validation error is not
@@ -460,16 +461,27 @@ export class FleetRoutingClient {
    * @param {boolean} request.interpretInjectedSolutionsUsingLabels
    *   If true:
    *
-   *     * uses {@link google.cloud.optimization.v1.ShipmentRoute.vehicle_label|ShipmentRoute.vehicle_label} instead of `vehicle_index` to
+   *     * uses
+   *     {@link google.cloud.optimization.v1.ShipmentRoute.vehicle_label|ShipmentRoute.vehicle_label}
+   *     instead of `vehicle_index` to
    *       match routes in an injected solution with vehicles in the request;
-   *       reuses the mapping of original {@link google.cloud.optimization.v1.ShipmentRoute.vehicle_index|ShipmentRoute.vehicle_index} to new
-   *       {@link google.cloud.optimization.v1.ShipmentRoute.vehicle_index|ShipmentRoute.vehicle_index} to update
+   *       reuses the mapping of original
+   *       {@link google.cloud.optimization.v1.ShipmentRoute.vehicle_index|ShipmentRoute.vehicle_index}
+   *       to new
+   *       {@link google.cloud.optimization.v1.ShipmentRoute.vehicle_index|ShipmentRoute.vehicle_index}
+   *       to update
    *       {@link google.cloud.optimization.v1.InjectedSolutionConstraint.ConstraintRelaxation.vehicle_indices|ConstraintRelaxation.vehicle_indices}
    *       if non-empty, but the mapping must be unambiguous (i.e., multiple
    *       `ShipmentRoute`s must not share the same original `vehicle_index`).
-   *     * uses {@link google.cloud.optimization.v1.ShipmentRoute.Visit.shipment_label|ShipmentRoute.Visit.shipment_label} instead of `shipment_index`
+   *     * uses
+   *     {@link google.cloud.optimization.v1.ShipmentRoute.Visit.shipment_label|ShipmentRoute.Visit.shipment_label}
+   *     instead of `shipment_index`
    *       to match visits in an injected solution with shipments in the request;
-   *     * uses {@link google.cloud.optimization.v1.SkippedShipment.label|SkippedShipment.label} instead of {@link google.cloud.optimization.v1.SkippedShipment.index|SkippedShipment.index} to
+   *     * uses
+   *     {@link google.cloud.optimization.v1.SkippedShipment.label|SkippedShipment.label}
+   *     instead of
+   *     {@link google.cloud.optimization.v1.SkippedShipment.index|SkippedShipment.index}
+   *     to
    *       match skipped shipments in the injected solution with request
    *       shipments.
    *
@@ -482,8 +494,10 @@ export class FleetRoutingClient {
    *   If true, labels in the following categories must appear at most once in
    *   their category:
    *
-   *     * {@link google.cloud.optimization.v1.Vehicle.label|Vehicle.label} in the request;
-   *     * {@link google.cloud.optimization.v1.Shipment.label|Shipment.label} in the request;
+   *     * {@link google.cloud.optimization.v1.Vehicle.label|Vehicle.label} in the
+   *     request;
+   *     * {@link google.cloud.optimization.v1.Shipment.label|Shipment.label} in the
+   *     request;
    *     * {@link google.cloud.optimization.v1.ShipmentRoute.vehicle_label|ShipmentRoute.vehicle_label} in the injected solution;
    *     * {@link google.cloud.optimization.v1.SkippedShipment.label|SkippedShipment.label} and {@link google.cloud.optimization.v1.ShipmentRoute.Visit.shipment_label|ShipmentRoute.Visit.shipment_label} in
    *       the injected solution (except pickup/delivery visit pairs, whose
@@ -493,27 +507,32 @@ export class FleetRoutingClient {
    *   request vehicle, the corresponding route is removed from the solution
    *   along with its visits. If a `shipment_label` in the injected solution does
    *   not correspond to a request shipment, the corresponding visit is removed
-   *   from the solution. If a {@link google.cloud.optimization.v1.SkippedShipment.label|SkippedShipment.label} in the injected solution
-   *   does not correspond to a request shipment, the `SkippedShipment` is removed
-   *   from the solution.
+   *   from the solution. If a
+   *   {@link google.cloud.optimization.v1.SkippedShipment.label|SkippedShipment.label}
+   *   in the injected solution does not correspond to a request shipment, the
+   *   `SkippedShipment` is removed from the solution.
    *
    *   Removing route visits or entire routes from an injected solution may
    *   have an effect on the implied constraints, which may lead to change in
    *   solution, validation errors, or infeasibility.
    *
-   *   NOTE: The caller must ensure that each {@link google.cloud.optimization.v1.Vehicle.label|Vehicle.label}
-   *   (resp. {@link google.cloud.optimization.v1.Shipment.label|Shipment.label}) uniquely identifies a vehicle (resp. shipment)
-   *   entity used across the two relevant requests: the past request that
-   *   produced the `OptimizeToursResponse` used in the injected solution and the
-   *   current request that includes the injected solution. The uniqueness checks
-   *   described above are not enough to guarantee this requirement.
+   *   NOTE: The caller must ensure that each
+   *   {@link google.cloud.optimization.v1.Vehicle.label|Vehicle.label} (resp.
+   *   {@link google.cloud.optimization.v1.Shipment.label|Shipment.label}) uniquely
+   *   identifies a vehicle (resp. shipment) entity used across the two relevant
+   *   requests: the past request that produced the `OptimizeToursResponse` used
+   *   in the injected solution and the current request that includes the injected
+   *   solution. The uniqueness checks described above are not enough to guarantee
+   *   this requirement.
    * @param {boolean} request.considerRoadTraffic
    *   Consider traffic estimation in calculating `ShipmentRoute` fields
    *   {@link google.cloud.optimization.v1.ShipmentRoute.Transition.travel_duration|Transition.travel_duration},
    *   {@link google.cloud.optimization.v1.ShipmentRoute.Visit.start_time|Visit.start_time},
    *   and `vehicle_end_time`; in setting the
-   *   {@link google.cloud.optimization.v1.ShipmentRoute.has_traffic_infeasibilities|ShipmentRoute.has_traffic_infeasibilities} field, and in calculating the
-   *   {@link google.cloud.optimization.v1.OptimizeToursResponse.total_cost|OptimizeToursResponse.total_cost} field.
+   *   {@link google.cloud.optimization.v1.ShipmentRoute.has_traffic_infeasibilities|ShipmentRoute.has_traffic_infeasibilities}
+   *   field, and in calculating the
+   *   {@link google.cloud.optimization.v1.OptimizeToursResponse.total_cost|OptimizeToursResponse.total_cost}
+   *   field.
    * @param {boolean} request.populatePolylines
    *   If true, polylines will be populated in response `ShipmentRoute`s.
    * @param {boolean} request.populateTransitionPolylines
@@ -539,10 +558,11 @@ export class FleetRoutingClient {
    *   Label that may be used to identify this request, reported back in the
    *   {@link google.cloud.optimization.v1.OptimizeToursResponse.request_label|OptimizeToursResponse.request_label}.
    * @param {boolean} request.populateTravelStepPolylines
-   *   Deprecated: Use {@link |OptimizeToursRequest.populate_transition_polylines} instead.
-   *   If true, polylines will be populated in response
-   *   {@link google.cloud.optimization.v1.ShipmentRoute.transitions|ShipmentRoute.transitions}. Note that in this case, the polylines will
-   *   also be populated in the deprecated `travel_steps`.
+   *   Deprecated: Use {@link |OptimizeToursRequest.populate_transition_polylines}
+   *   instead. If true, polylines will be populated in response
+   *   {@link google.cloud.optimization.v1.ShipmentRoute.transitions|ShipmentRoute.transitions}.
+   *   Note that in this case, the polylines will also be populated in the
+   *   deprecated `travel_steps`.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
@@ -649,8 +669,8 @@ export class FleetRoutingClient {
    *
    *   If no location is specified, a region will be chosen automatically.
    * @param {number[]} request.modelConfigs
-   *   Required. Input/Output information each purchase model, such as file paths and data
-   *   formats.
+   *   Required. Input/Output information each purchase model, such as file paths
+   *   and data formats.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.