Package com.google.cloud.optimization.v1

Interface OptimizeToursRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    OptimizeToursRequest, OptimizeToursRequest.Builder
    public interface OptimizeToursRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean getAllowLargeDeadlineDespiteInterruptionRisk()
      If this is set, then the request can have a deadline (see https://grpc.io/blog/deadlines) of up to 60 minutes.
      boolean getConsiderRoadTraffic()
      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.
      double getGeodesicMetersPerSecond()
      When `use_geodesic_distances` is true, this field must be set and defines the speed applied to compute travel times.
      ShipmentRoute getInjectedFirstSolutionRoutes​(int index)
      Guide the optimization algorithm in finding a first solution that is similar to a previous solution.
      int getInjectedFirstSolutionRoutesCount()
      Guide the optimization algorithm in finding a first solution that is similar to a previous solution.
      List<ShipmentRoute> getInjectedFirstSolutionRoutesList()
      Guide the optimization algorithm in finding a first solution that is similar to a previous solution.
      ShipmentRouteOrBuilder getInjectedFirstSolutionRoutesOrBuilder​(int index)
      Guide the optimization algorithm in finding a first solution that is similar to a previous solution.
      List<? extends ShipmentRouteOrBuilder> getInjectedFirstSolutionRoutesOrBuilderList()
      Guide the optimization algorithm in finding a first solution that is similar to a previous solution.
      InjectedSolutionConstraint getInjectedSolutionConstraint()
      Constrain the optimization algorithm to find a final solution that is similar to a previous solution.
      InjectedSolutionConstraintOrBuilder getInjectedSolutionConstraintOrBuilder()
      Constrain the optimization algorithm to find a final solution that is similar to a previous solution.
      boolean getInterpretInjectedSolutionsUsingLabels()
      If true: * 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 [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`).
      String getLabel()
      Label that may be used to identify this request, reported back in the [OptimizeToursResponse.request_label][google.cloud.optimization.v1.OptimizeToursResponse.request_label].
      com.google.protobuf.ByteString getLabelBytes()
      Label that may be used to identify this request, reported back in the [OptimizeToursResponse.request_label][google.cloud.optimization.v1.OptimizeToursResponse.request_label].
      int getMaxValidationErrors()
      Truncates the number of validation errors returned.
      ShipmentModel getModel()
      Shipment model to solve.
      ShipmentModelOrBuilder getModelOrBuilder()
      Shipment model to solve.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      boolean getPopulatePolylines()
      If true, polylines will be populated in response `ShipmentRoute`s.
      boolean getPopulateTransitionPolylines()
      If true, polylines will be populated in response [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions].
      boolean getPopulateTravelStepPolylines()
      Deprecated.
      google.cloud.optimization.v1.OptimizeToursRequest.populate_travel_step_polylines is deprecated.
      ShipmentRoute getRefreshDetailsRoutes​(int index)
      If non-empty, the given routes will be refreshed, without modifying their underlying sequence of visits or travel times: only other details will be updated.
      int getRefreshDetailsRoutesCount()
      If non-empty, the given routes will be refreshed, without modifying their underlying sequence of visits or travel times: only other details will be updated.
      List<ShipmentRoute> getRefreshDetailsRoutesList()
      If non-empty, the given routes will be refreshed, without modifying their underlying sequence of visits or travel times: only other details will be updated.
      ShipmentRouteOrBuilder getRefreshDetailsRoutesOrBuilder​(int index)
      If non-empty, the given routes will be refreshed, without modifying their underlying sequence of visits or travel times: only other details will be updated.
      List<? extends ShipmentRouteOrBuilder> getRefreshDetailsRoutesOrBuilderList()
      If non-empty, the given routes will be refreshed, without modifying their underlying sequence of visits or travel times: only other details will be updated.
      OptimizeToursRequest.SearchMode getSearchMode()
      Search mode used to solve the request.
      int getSearchModeValue()
      Search mode used to solve the request.
      OptimizeToursRequest.SolvingMode getSolvingMode()
      By default, the solving mode is `DEFAULT_SOLVE` (0).
      int getSolvingModeValue()
      By default, the solving mode is `DEFAULT_SOLVE` (0).
      com.google.protobuf.Duration getTimeout()
      If this timeout is set, the server returns a response before the timeout period has elapsed or the server deadline for synchronous requests is reached, whichever is sooner.
      com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
      If this timeout is set, the server returns a response before the timeout period has elapsed or the server deadline for synchronous requests is reached, whichever is sooner.
      boolean getUseGeodesicDistances()
      If true, travel distances will be computed using geodesic distances instead of Google Maps distances, and travel times will be computed using geodesic distances with a speed defined by `geodesic_meters_per_second`.
      boolean hasGeodesicMetersPerSecond()
      When `use_geodesic_distances` is true, this field must be set and defines the speed applied to compute travel times.
      boolean hasInjectedSolutionConstraint()
      Constrain the optimization algorithm to find a final solution that is similar to a previous solution.
      boolean hasMaxValidationErrors()
      Truncates the number of validation errors returned.
      boolean hasModel()
      Shipment model to solve.
      boolean hasTimeout()
      If this timeout is set, the server returns a response before the timeout period has elapsed or the server deadline for synchronous requests is reached, whichever is sooner.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        String getParent()
         Required. Target project and location to make a call.

 Format: `projects/{project-id}/locations/{location-id}`.

 If no location is specified, a region will be chosen automatically.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. Target project and location to make a call.

 Format: `projects/{project-id}/locations/{location-id}`.

 If no location is specified, a region will be chosen automatically.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for parent.

      • hasTimeout

        boolean hasTimeout()
         If this timeout is set, the server returns a response before the timeout
 period has elapsed or the server deadline for synchronous requests is
 reached, whichever is sooner.

 For asynchronous requests, the server will generate a solution (if
 possible) before the timeout has elapsed.
        .google.protobuf.Duration timeout = 2;
        Returns:
        Whether the timeout field is set.

      • getTimeout

        com.google.protobuf.Duration getTimeout()
         If this timeout is set, the server returns a response before the timeout
 period has elapsed or the server deadline for synchronous requests is
 reached, whichever is sooner.

 For asynchronous requests, the server will generate a solution (if
 possible) before the timeout has elapsed.
        .google.protobuf.Duration timeout = 2;
        Returns:
        The timeout.

      • getTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
         If this timeout is set, the server returns a response before the timeout
 period has elapsed or the server deadline for synchronous requests is
 reached, whichever is sooner.

 For asynchronous requests, the server will generate a solution (if
 possible) before the timeout has elapsed.
        .google.protobuf.Duration timeout = 2;

      • hasModel

        boolean hasModel()
         Shipment model to solve.
        .google.cloud.optimization.v1.ShipmentModel model = 3;
        Returns:
        Whether the model field is set.

      • getModel

        ShipmentModel getModel()
         Shipment model to solve.
        .google.cloud.optimization.v1.ShipmentModel model = 3;
        Returns:
        The model.

      • getModelOrBuilder

        ShipmentModelOrBuilder getModelOrBuilder()
         Shipment model to solve.
        .google.cloud.optimization.v1.ShipmentModel model = 3;

      • getSolvingModeValue

        int getSolvingModeValue()
         By default, the solving mode is `DEFAULT_SOLVE` (0).
        .google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;
        Returns:
        The enum numeric value on the wire for solvingMode.

      • getSolvingMode

        OptimizeToursRequest.SolvingMode getSolvingMode()
         By default, the solving mode is `DEFAULT_SOLVE` (0).
        .google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;
        Returns:
        The solvingMode.

      • getSearchModeValue

        int getSearchModeValue()
         Search mode used to solve the request.
        .google.cloud.optimization.v1.OptimizeToursRequest.SearchMode search_mode = 6;
        Returns:
        The enum numeric value on the wire for searchMode.

      • getSearchMode

        OptimizeToursRequest.SearchMode getSearchMode()
         Search mode used to solve the request.
        .google.cloud.optimization.v1.OptimizeToursRequest.SearchMode search_mode = 6;
        Returns:
        The searchMode.

      • getInjectedFirstSolutionRoutesList

        List<ShipmentRoute> getInjectedFirstSolutionRoutesList()
         Guide the optimization algorithm in finding a first solution that is
 similar to a previous solution.

 The model is constrained when the first solution is built.
 Any shipments not performed on a route are implicitly skipped in the first
 solution, but they may be performed in successive solutions.

 The solution must satisfy some basic validity assumptions:

   * for all routes, `vehicle_index` must be in range and not be duplicated.
   * for all visits, `shipment_index` and `visit_request_index` must be
     in range.
   * a shipment may only be referenced on one route.
   * the pickup of a pickup-delivery shipment must be performed before
     the delivery.
   * no more than one pickup alternative or delivery alternative of
     a shipment may be performed.
   * for all routes, times are increasing (i.e., `vehicle_start_time
     <= 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
     [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
 instead.
        repeated .google.cloud.optimization.v1.ShipmentRoute injected_first_solution_routes = 7;

      • getInjectedFirstSolutionRoutes

        ShipmentRoute getInjectedFirstSolutionRoutes​(int index)
         Guide the optimization algorithm in finding a first solution that is
 similar to a previous solution.

 The model is constrained when the first solution is built.
 Any shipments not performed on a route are implicitly skipped in the first
 solution, but they may be performed in successive solutions.

 The solution must satisfy some basic validity assumptions:

   * for all routes, `vehicle_index` must be in range and not be duplicated.
   * for all visits, `shipment_index` and `visit_request_index` must be
     in range.
   * a shipment may only be referenced on one route.
   * the pickup of a pickup-delivery shipment must be performed before
     the delivery.
   * no more than one pickup alternative or delivery alternative of
     a shipment may be performed.
   * for all routes, times are increasing (i.e., `vehicle_start_time
     <= 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
     [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
 instead.
        repeated .google.cloud.optimization.v1.ShipmentRoute injected_first_solution_routes = 7;

      • getInjectedFirstSolutionRoutesCount

        int getInjectedFirstSolutionRoutesCount()
         Guide the optimization algorithm in finding a first solution that is
 similar to a previous solution.

 The model is constrained when the first solution is built.
 Any shipments not performed on a route are implicitly skipped in the first
 solution, but they may be performed in successive solutions.

 The solution must satisfy some basic validity assumptions:

   * for all routes, `vehicle_index` must be in range and not be duplicated.
   * for all visits, `shipment_index` and `visit_request_index` must be
     in range.
   * a shipment may only be referenced on one route.
   * the pickup of a pickup-delivery shipment must be performed before
     the delivery.
   * no more than one pickup alternative or delivery alternative of
     a shipment may be performed.
   * for all routes, times are increasing (i.e., `vehicle_start_time
     <= 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
     [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
 instead.
        repeated .google.cloud.optimization.v1.ShipmentRoute injected_first_solution_routes = 7;

      • getInjectedFirstSolutionRoutesOrBuilderList

        List<? extends ShipmentRouteOrBuilder> getInjectedFirstSolutionRoutesOrBuilderList()
         Guide the optimization algorithm in finding a first solution that is
 similar to a previous solution.

 The model is constrained when the first solution is built.
 Any shipments not performed on a route are implicitly skipped in the first
 solution, but they may be performed in successive solutions.

 The solution must satisfy some basic validity assumptions:

   * for all routes, `vehicle_index` must be in range and not be duplicated.
   * for all visits, `shipment_index` and `visit_request_index` must be
     in range.
   * a shipment may only be referenced on one route.
   * the pickup of a pickup-delivery shipment must be performed before
     the delivery.
   * no more than one pickup alternative or delivery alternative of
     a shipment may be performed.
   * for all routes, times are increasing (i.e., `vehicle_start_time
     <= 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
     [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
 instead.
        repeated .google.cloud.optimization.v1.ShipmentRoute injected_first_solution_routes = 7;

      • getInjectedFirstSolutionRoutesOrBuilder

        ShipmentRouteOrBuilder getInjectedFirstSolutionRoutesOrBuilder​(int index)
         Guide the optimization algorithm in finding a first solution that is
 similar to a previous solution.

 The model is constrained when the first solution is built.
 Any shipments not performed on a route are implicitly skipped in the first
 solution, but they may be performed in successive solutions.

 The solution must satisfy some basic validity assumptions:

   * for all routes, `vehicle_index` must be in range and not be duplicated.
   * for all visits, `shipment_index` and `visit_request_index` must be
     in range.
   * a shipment may only be referenced on one route.
   * the pickup of a pickup-delivery shipment must be performed before
     the delivery.
   * no more than one pickup alternative or delivery alternative of
     a shipment may be performed.
   * for all routes, times are increasing (i.e., `vehicle_start_time
     <= 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
     [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
 instead.
        repeated .google.cloud.optimization.v1.ShipmentRoute injected_first_solution_routes = 7;

      • hasInjectedSolutionConstraint

        boolean hasInjectedSolutionConstraint()
         Constrain the optimization algorithm to find a final solution that is
 similar to a previous solution. For example, this may be used to freeze
 portions of routes which have already been completed or which are to be
 completed but must not be modified.

 If the injected solution is not feasible, a validation error is not
 necessarily returned and an error indicating infeasibility may be returned
 instead.
        .google.cloud.optimization.v1.InjectedSolutionConstraint injected_solution_constraint = 8;
        Returns:
        Whether the injectedSolutionConstraint field is set.

      • getInjectedSolutionConstraint

        InjectedSolutionConstraint getInjectedSolutionConstraint()
         Constrain the optimization algorithm to find a final solution that is
 similar to a previous solution. For example, this may be used to freeze
 portions of routes which have already been completed or which are to be
 completed but must not be modified.

 If the injected solution is not feasible, a validation error is not
 necessarily returned and an error indicating infeasibility may be returned
 instead.
        .google.cloud.optimization.v1.InjectedSolutionConstraint injected_solution_constraint = 8;
        Returns:
        The injectedSolutionConstraint.

      • getInjectedSolutionConstraintOrBuilder

        InjectedSolutionConstraintOrBuilder getInjectedSolutionConstraintOrBuilder()
         Constrain the optimization algorithm to find a final solution that is
 similar to a previous solution. For example, this may be used to freeze
 portions of routes which have already been completed or which are to be
 completed but must not be modified.

 If the injected solution is not feasible, a validation error is not
 necessarily returned and an error indicating infeasibility may be returned
 instead.
        .google.cloud.optimization.v1.InjectedSolutionConstraint injected_solution_constraint = 8;

      • getRefreshDetailsRoutesList

        List<ShipmentRoute> getRefreshDetailsRoutesList()
         If non-empty, the given routes will be refreshed, without modifying their
 underlying sequence of visits or travel times: only other details will be
 updated. This does not solve the model.

 As of 2020/11, this only populates the polylines of non-empty routes and
 requires that `populate_polylines` is true.

 The `route_polyline` fields of the passed-in routes may be inconsistent
 with route `transitions`.

 This field must not be used together with `injected_first_solution_routes`
 or `injected_solution_constraint`.

 `Shipment.ignore` and `Vehicle.ignore` have no effect on the behavior.
 Polylines are still populated between all visits in all non-empty routes
 regardless of whether the related shipments or vehicles are ignored.
        repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

      • getRefreshDetailsRoutes

        ShipmentRoute getRefreshDetailsRoutes​(int index)
         If non-empty, the given routes will be refreshed, without modifying their
 underlying sequence of visits or travel times: only other details will be
 updated. This does not solve the model.

 As of 2020/11, this only populates the polylines of non-empty routes and
 requires that `populate_polylines` is true.

 The `route_polyline` fields of the passed-in routes may be inconsistent
 with route `transitions`.

 This field must not be used together with `injected_first_solution_routes`
 or `injected_solution_constraint`.

 `Shipment.ignore` and `Vehicle.ignore` have no effect on the behavior.
 Polylines are still populated between all visits in all non-empty routes
 regardless of whether the related shipments or vehicles are ignored.
        repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

      • getRefreshDetailsRoutesCount

        int getRefreshDetailsRoutesCount()
         If non-empty, the given routes will be refreshed, without modifying their
 underlying sequence of visits or travel times: only other details will be
 updated. This does not solve the model.

 As of 2020/11, this only populates the polylines of non-empty routes and
 requires that `populate_polylines` is true.

 The `route_polyline` fields of the passed-in routes may be inconsistent
 with route `transitions`.

 This field must not be used together with `injected_first_solution_routes`
 or `injected_solution_constraint`.

 `Shipment.ignore` and `Vehicle.ignore` have no effect on the behavior.
 Polylines are still populated between all visits in all non-empty routes
 regardless of whether the related shipments or vehicles are ignored.
        repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

      • getRefreshDetailsRoutesOrBuilderList

        List<? extends ShipmentRouteOrBuilder> getRefreshDetailsRoutesOrBuilderList()
         If non-empty, the given routes will be refreshed, without modifying their
 underlying sequence of visits or travel times: only other details will be
 updated. This does not solve the model.

 As of 2020/11, this only populates the polylines of non-empty routes and
 requires that `populate_polylines` is true.

 The `route_polyline` fields of the passed-in routes may be inconsistent
 with route `transitions`.

 This field must not be used together with `injected_first_solution_routes`
 or `injected_solution_constraint`.

 `Shipment.ignore` and `Vehicle.ignore` have no effect on the behavior.
 Polylines are still populated between all visits in all non-empty routes
 regardless of whether the related shipments or vehicles are ignored.
        repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

      • getRefreshDetailsRoutesOrBuilder

        ShipmentRouteOrBuilder getRefreshDetailsRoutesOrBuilder​(int index)
         If non-empty, the given routes will be refreshed, without modifying their
 underlying sequence of visits or travel times: only other details will be
 updated. This does not solve the model.

 As of 2020/11, this only populates the polylines of non-empty routes and
 requires that `populate_polylines` is true.

 The `route_polyline` fields of the passed-in routes may be inconsistent
 with route `transitions`.

 This field must not be used together with `injected_first_solution_routes`
 or `injected_solution_constraint`.

 `Shipment.ignore` and `Vehicle.ignore` have no effect on the behavior.
 Polylines are still populated between all visits in all non-empty routes
 regardless of whether the related shipments or vehicles are ignored.
        repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

      • getInterpretInjectedSolutionsUsingLabels

        boolean getInterpretInjectedSolutionsUsingLabels()
         If true:

   * 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
     [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`
     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
     match skipped shipments in the injected solution with request
     shipments.

 This interpretation applies to the `injected_first_solution_routes`,
 `injected_solution_constraint`, and `refresh_details_routes` fields.
 It can be used when shipment or vehicle indices in the request have
 changed since the solution was created, perhaps because shipments or
 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;
   * [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
     `shipment_label` must appear twice).

 If a `vehicle_label` in the injected solution does not correspond to a
 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.

 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.
        bool interpret_injected_solutions_using_labels = 10;
        Returns:
        The interpretInjectedSolutionsUsingLabels.

      • getConsiderRoadTraffic

        boolean getConsiderRoadTraffic()
         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.
        bool consider_road_traffic = 11;
        Returns:
        The considerRoadTraffic.

      • getPopulatePolylines

        boolean getPopulatePolylines()
         If true, polylines will be populated in response `ShipmentRoute`s.
        bool populate_polylines = 12;
        Returns:
        The populatePolylines.

      • getPopulateTransitionPolylines

        boolean getPopulateTransitionPolylines()
         If true, polylines will be populated in response
 [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions].
 Note that in this case, the polylines will also be populated in the
 deprecated `travel_steps`.
        bool populate_transition_polylines = 13;
        Returns:
        The populateTransitionPolylines.

      • getAllowLargeDeadlineDespiteInterruptionRisk

        boolean getAllowLargeDeadlineDespiteInterruptionRisk()
         If this is set, then the request can have a deadline
 (see https://grpc.io/blog/deadlines) of up to 60 minutes.
 Otherwise, the maximum deadline is only 30 minutes.
 Note that long-lived requests have a significantly larger (but still small)
 risk of interruption.
        bool allow_large_deadline_despite_interruption_risk = 14;
        Returns:
        The allowLargeDeadlineDespiteInterruptionRisk.

      • getUseGeodesicDistances

        boolean getUseGeodesicDistances()
         If true, travel distances will be computed using geodesic distances instead
 of Google Maps distances, and travel times will be computed using geodesic
 distances with a speed defined by `geodesic_meters_per_second`.
        bool use_geodesic_distances = 15;
        Returns:
        The useGeodesicDistances.

      • hasGeodesicMetersPerSecond

        boolean hasGeodesicMetersPerSecond()
         When `use_geodesic_distances` is true, this field must be set and defines
 the speed applied to compute travel times. Its value must be at least 1.0
 meters/seconds.
        optional double geodesic_meters_per_second = 16;
        Returns:
        Whether the geodesicMetersPerSecond field is set.

      • getGeodesicMetersPerSecond

        double getGeodesicMetersPerSecond()
         When `use_geodesic_distances` is true, this field must be set and defines
 the speed applied to compute travel times. Its value must be at least 1.0
 meters/seconds.
        optional double geodesic_meters_per_second = 16;
        Returns:
        The geodesicMetersPerSecond.

      • hasMaxValidationErrors

        boolean hasMaxValidationErrors()
         Truncates the number of validation errors returned. These errors are
 typically attached to an INVALID_ARGUMENT error payload as a BadRequest
 error detail (https://cloud.google.com/apis/design/errors#error_details),
 unless solving_mode=VALIDATE_ONLY: see the
 [OptimizeToursResponse.validation_errors][google.cloud.optimization.v1.OptimizeToursResponse.validation_errors]
 field.
 This defaults to 100 and is capped at 10,000.
        optional int32 max_validation_errors = 5;
        Returns:
        Whether the maxValidationErrors field is set.

      • getMaxValidationErrors

        int getMaxValidationErrors()
         Truncates the number of validation errors returned. These errors are
 typically attached to an INVALID_ARGUMENT error payload as a BadRequest
 error detail (https://cloud.google.com/apis/design/errors#error_details),
 unless solving_mode=VALIDATE_ONLY: see the
 [OptimizeToursResponse.validation_errors][google.cloud.optimization.v1.OptimizeToursResponse.validation_errors]
 field.
 This defaults to 100 and is capped at 10,000.
        optional int32 max_validation_errors = 5;
        Returns:
        The maxValidationErrors.

      • getLabel

        String getLabel()
         Label that may be used to identify this request, reported back in the
 [OptimizeToursResponse.request_label][google.cloud.optimization.v1.OptimizeToursResponse.request_label].
        string label = 17;
        Returns:
        The label.

      • getLabelBytes

        com.google.protobuf.ByteString getLabelBytes()
         Label that may be used to identify this request, reported back in the
 [OptimizeToursResponse.request_label][google.cloud.optimization.v1.OptimizeToursResponse.request_label].
        string label = 17;
        Returns:
        The bytes for label.

      • getPopulateTravelStepPolylines

        @Deprecated
boolean getPopulateTravelStepPolylines()
        Deprecated.
        google.cloud.optimization.v1.OptimizeToursRequest.populate_travel_step_polylines is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=359
         Deprecated: Use
 [OptimizeToursRequest.populate_transition_polylines][google.cloud.optimization.v1.OptimizeToursRequest.populate_transition_polylines]
 instead. If true, polylines will be populated in response
 [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions].
 Note that in this case, the polylines will also be populated in the
 deprecated `travel_steps`.
        bool populate_travel_step_polylines = 20 [deprecated = true];
        Returns:
        The populateTravelStepPolylines.