Package com.google.cloud.optimization.v1
Class OptimizeToursRequest.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<OptimizeToursRequest.Builder>
com.google.cloud.optimization.v1.OptimizeToursRequest.Builder
- All Implemented Interfaces:
OptimizeToursRequestOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- OptimizeToursRequest
public static final class OptimizeToursRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<OptimizeToursRequest.Builder>
implements OptimizeToursRequestOrBuilder
Request to be given to a tour optimization solver which defines the shipment model to solve as well as optimization parameters.Protobuf type
google.cloud.optimization.v1.OptimizeToursRequest-
Method Summary
Modifier and TypeMethodDescriptionaddAllInjectedFirstSolutionRoutes(Iterable<? extends ShipmentRoute> values) Guide the optimization algorithm in finding a first solution that is similar to a previous solution.addAllRefreshDetailsRoutes(Iterable<? extends ShipmentRoute> values) 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.addInjectedFirstSolutionRoutes(int index, ShipmentRoute value) Guide the optimization algorithm in finding a first solution that is similar to a previous solution.addInjectedFirstSolutionRoutes(int index, ShipmentRoute.Builder builderForValue) Guide the optimization algorithm in finding a first solution that is similar to a previous solution.Guide the optimization algorithm in finding a first solution that is similar to a previous solution.addInjectedFirstSolutionRoutes(ShipmentRoute.Builder builderForValue) Guide the optimization algorithm in finding a first solution that is similar to a previous solution.Guide the optimization algorithm in finding a first solution that is similar to a previous solution.addInjectedFirstSolutionRoutesBuilder(int index) Guide the optimization algorithm in finding a first solution that is similar to a previous solution.addRefreshDetailsRoutes(int index, ShipmentRoute value) 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.addRefreshDetailsRoutes(int index, ShipmentRoute.Builder builderForValue) 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.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.addRefreshDetailsRoutes(ShipmentRoute.Builder builderForValue) 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.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.addRefreshDetailsRoutesBuilder(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.build()clear()If this is set, then the request can have a deadline (see https://grpc.io/blog/deadlines) of up to 60 minutes.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.When `use_geodesic_distances` is true, this field must be set and defines the speed applied to compute travel times.Guide the optimization algorithm in finding a first solution that is similar to a previous solution.Constrain the optimization algorithm to find a final solution that is similar to a previous solution.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`)Label that may be used to identify this request, reported back in the [OptimizeToursResponse.request_label][google.cloud.optimization.v1.OptimizeToursResponse.request_label].Truncates the number of validation errors returned.Shipment model to solve.Required.If true, polylines will be populated in response `ShipmentRoute`s.If true, polylines will be populated in response [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions].Deprecated.google.cloud.optimization.v1.OptimizeToursRequest.populate_travel_step_polylines is deprecated.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.Search mode used to solve the request.By default, the solving mode is `DEFAULT_SOLVE` (0).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.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`.booleanIf this is set, then the request can have a deadline (see https://grpc.io/blog/deadlines) of up to 60 minutes.booleanConsider 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.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptordoubleWhen `use_geodesic_distances` is true, this field must be set and defines the speed applied to compute travel times.getInjectedFirstSolutionRoutes(int index) Guide the optimization algorithm in finding a first solution that is similar to a previous solution.getInjectedFirstSolutionRoutesBuilder(int index) Guide the optimization algorithm in finding a first solution that is similar to a previous solution.Guide the optimization algorithm in finding a first solution that is similar to a previous solution.intGuide the optimization algorithm in finding a first solution that is similar to a previous solution.Guide the optimization algorithm in finding a first solution that is similar to a previous solution.getInjectedFirstSolutionRoutesOrBuilder(int index) Guide the optimization algorithm in finding a first solution that is similar to a previous solution.List<? extends ShipmentRouteOrBuilder>Guide the optimization algorithm in finding a first solution that is similar to a previous solution.Constrain the optimization algorithm to find a final solution that is similar to a previous solution.Constrain the optimization algorithm to find a final solution that is similar to a previous solution.Constrain the optimization algorithm to find a final solution that is similar to a previous solution.booleanIf 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`)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.ByteStringLabel that may be used to identify this request, reported back in the [OptimizeToursResponse.request_label][google.cloud.optimization.v1.OptimizeToursResponse.request_label].intTruncates the number of validation errors returned.getModel()Shipment model to solve.Shipment model to solve.Shipment model to solve.Required.com.google.protobuf.ByteStringRequired.booleanIf true, polylines will be populated in response `ShipmentRoute`s.booleanIf true, polylines will be populated in response [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions].booleanDeprecated.google.cloud.optimization.v1.OptimizeToursRequest.populate_travel_step_polylines is deprecated.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.getRefreshDetailsRoutesBuilder(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.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.intIf non-empty, the given routes will be refreshed, without modifying their underlying sequence of visits or travel times: only other details will be updated.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.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>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.Search mode used to solve the request.intSearch mode used to solve the request.By default, the solving mode is `DEFAULT_SOLVE` (0).intBy default, the solving mode is `DEFAULT_SOLVE` (0).com.google.protobuf.DurationIf 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.Duration.BuilderIf 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.DurationOrBuilderIf 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.booleanIf 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`.booleanWhen `use_geodesic_distances` is true, this field must be set and defines the speed applied to compute travel times.booleanConstrain the optimization algorithm to find a final solution that is similar to a previous solution.booleanTruncates the number of validation errors returned.booleanhasModel()Shipment model to solve.booleanIf 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.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(OptimizeToursRequest other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) Constrain the optimization algorithm to find a final solution that is similar to a previous solution.mergeModel(ShipmentModel value) Shipment model to solve.mergeTimeout(com.google.protobuf.Duration value) 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.removeInjectedFirstSolutionRoutes(int index) Guide the optimization algorithm in finding a first solution that is similar to a previous solution.removeRefreshDetailsRoutes(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.setAllowLargeDeadlineDespiteInterruptionRisk(boolean value) If this is set, then the request can have a deadline (see https://grpc.io/blog/deadlines) of up to 60 minutes.setConsiderRoadTraffic(boolean value) 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.setGeodesicMetersPerSecond(double value) When `use_geodesic_distances` is true, this field must be set and defines the speed applied to compute travel times.setInjectedFirstSolutionRoutes(int index, ShipmentRoute value) Guide the optimization algorithm in finding a first solution that is similar to a previous solution.setInjectedFirstSolutionRoutes(int index, ShipmentRoute.Builder builderForValue) Guide the optimization algorithm in finding a first solution that is similar to a previous solution.Constrain the optimization algorithm to find a final solution that is similar to a previous solution.setInjectedSolutionConstraint(InjectedSolutionConstraint.Builder builderForValue) Constrain the optimization algorithm to find a final solution that is similar to a previous solution.setInterpretInjectedSolutionsUsingLabels(boolean value) 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`)Label that may be used to identify this request, reported back in the [OptimizeToursResponse.request_label][google.cloud.optimization.v1.OptimizeToursResponse.request_label].setLabelBytes(com.google.protobuf.ByteString value) Label that may be used to identify this request, reported back in the [OptimizeToursResponse.request_label][google.cloud.optimization.v1.OptimizeToursResponse.request_label].setMaxValidationErrors(int value) Truncates the number of validation errors returned.setModel(ShipmentModel value) Shipment model to solve.setModel(ShipmentModel.Builder builderForValue) Shipment model to solve.Required.setParentBytes(com.google.protobuf.ByteString value) Required.setPopulatePolylines(boolean value) If true, polylines will be populated in response `ShipmentRoute`s.setPopulateTransitionPolylines(boolean value) If true, polylines will be populated in response [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions].setPopulateTravelStepPolylines(boolean value) Deprecated.google.cloud.optimization.v1.OptimizeToursRequest.populate_travel_step_polylines is deprecated.setRefreshDetailsRoutes(int index, ShipmentRoute value) 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.setRefreshDetailsRoutes(int index, ShipmentRoute.Builder builderForValue) 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.Search mode used to solve the request.setSearchModeValue(int value) Search mode used to solve the request.By default, the solving mode is `DEFAULT_SOLVE` (0).setSolvingModeValue(int value) By default, the solving mode is `DEFAULT_SOLVE` (0).setTimeout(com.google.protobuf.Duration value) 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.setTimeout(com.google.protobuf.Duration.Builder builderForValue) 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.setUseGeodesicDistances(boolean value) 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`.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<OptimizeToursRequest.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<OptimizeToursRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<OptimizeToursRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<OptimizeToursRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<OptimizeToursRequest.Builder>
-
mergeFrom
public OptimizeToursRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<OptimizeToursRequest.Builder>- Throws:
IOException
-
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];- Specified by:
getParentin interfaceOptimizeToursRequestOrBuilder- Returns:
- The parent.
-
getParentBytes
public 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];- Specified by:
getParentBytesin interfaceOptimizeToursRequestOrBuilder- Returns:
- The bytes for parent.
-
setParent
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];- Parameters:
value- The parent to set.- Returns:
- This builder for chaining.
-
clearParent
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:
- This builder for chaining.
-
setParentBytes
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];- Parameters:
value- The bytes for parent to set.- Returns:
- This builder for chaining.
-
hasTimeout
public 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;- Specified by:
hasTimeoutin interfaceOptimizeToursRequestOrBuilder- Returns:
- Whether the timeout field is set.
-
getTimeout
public 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;- Specified by:
getTimeoutin interfaceOptimizeToursRequestOrBuilder- Returns:
- The timeout.
-
setTimeout
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; -
setTimeout
public OptimizeToursRequest.Builder setTimeout(com.google.protobuf.Duration.Builder builderForValue) 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; -
mergeTimeout
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; -
clearTimeout
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; -
getTimeoutBuilder
public com.google.protobuf.Duration.Builder getTimeoutBuilder()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; -
getTimeoutOrBuilder
public 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;- Specified by:
getTimeoutOrBuilderin interfaceOptimizeToursRequestOrBuilder
-
hasModel
public boolean hasModel()Shipment model to solve.
.google.cloud.optimization.v1.ShipmentModel model = 3;- Specified by:
hasModelin interfaceOptimizeToursRequestOrBuilder- Returns:
- Whether the model field is set.
-
getModel
Shipment model to solve.
.google.cloud.optimization.v1.ShipmentModel model = 3;- Specified by:
getModelin interfaceOptimizeToursRequestOrBuilder- Returns:
- The model.
-
setModel
Shipment model to solve.
.google.cloud.optimization.v1.ShipmentModel model = 3; -
setModel
Shipment model to solve.
.google.cloud.optimization.v1.ShipmentModel model = 3; -
mergeModel
Shipment model to solve.
.google.cloud.optimization.v1.ShipmentModel model = 3; -
clearModel
Shipment model to solve.
.google.cloud.optimization.v1.ShipmentModel model = 3; -
getModelBuilder
Shipment model to solve.
.google.cloud.optimization.v1.ShipmentModel model = 3; -
getModelOrBuilder
Shipment model to solve.
.google.cloud.optimization.v1.ShipmentModel model = 3;- Specified by:
getModelOrBuilderin interfaceOptimizeToursRequestOrBuilder
-
getSolvingModeValue
public int getSolvingModeValue()By default, the solving mode is `DEFAULT_SOLVE` (0).
.google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;- Specified by:
getSolvingModeValuein interfaceOptimizeToursRequestOrBuilder- Returns:
- The enum numeric value on the wire for solvingMode.
-
setSolvingModeValue
By default, the solving mode is `DEFAULT_SOLVE` (0).
.google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;- Parameters:
value- The enum numeric value on the wire for solvingMode to set.- Returns:
- This builder for chaining.
-
getSolvingMode
By default, the solving mode is `DEFAULT_SOLVE` (0).
.google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;- Specified by:
getSolvingModein interfaceOptimizeToursRequestOrBuilder- Returns:
- The solvingMode.
-
setSolvingMode
By default, the solving mode is `DEFAULT_SOLVE` (0).
.google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;- Parameters:
value- The solvingMode to set.- Returns:
- This builder for chaining.
-
clearSolvingMode
By default, the solving mode is `DEFAULT_SOLVE` (0).
.google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;- Returns:
- This builder for chaining.
-
getSearchModeValue
public int getSearchModeValue()Search mode used to solve the request.
.google.cloud.optimization.v1.OptimizeToursRequest.SearchMode search_mode = 6;- Specified by:
getSearchModeValuein interfaceOptimizeToursRequestOrBuilder- Returns:
- The enum numeric value on the wire for searchMode.
-
setSearchModeValue
Search mode used to solve the request.
.google.cloud.optimization.v1.OptimizeToursRequest.SearchMode search_mode = 6;- Parameters:
value- The enum numeric value on the wire for searchMode to set.- Returns:
- This builder for chaining.
-
getSearchMode
Search mode used to solve the request.
.google.cloud.optimization.v1.OptimizeToursRequest.SearchMode search_mode = 6;- Specified by:
getSearchModein interfaceOptimizeToursRequestOrBuilder- Returns:
- The searchMode.
-
setSearchMode
Search mode used to solve the request.
.google.cloud.optimization.v1.OptimizeToursRequest.SearchMode search_mode = 6;- Parameters:
value- The searchMode to set.- Returns:
- This builder for chaining.
-
clearSearchMode
Search mode used to solve the request.
.google.cloud.optimization.v1.OptimizeToursRequest.SearchMode search_mode = 6;- Returns:
- This builder for chaining.
-
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;- Specified by:
getInjectedFirstSolutionRoutesListin interfaceOptimizeToursRequestOrBuilder
-
getInjectedFirstSolutionRoutesCount
public 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;- Specified by:
getInjectedFirstSolutionRoutesCountin interfaceOptimizeToursRequestOrBuilder
-
getInjectedFirstSolutionRoutes
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;- Specified by:
getInjectedFirstSolutionRoutesin interfaceOptimizeToursRequestOrBuilder
-
setInjectedFirstSolutionRoutes
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; -
setInjectedFirstSolutionRoutes
public OptimizeToursRequest.Builder setInjectedFirstSolutionRoutes(int index, ShipmentRoute.Builder builderForValue) 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; -
addInjectedFirstSolutionRoutes
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; -
addInjectedFirstSolutionRoutes
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; -
addInjectedFirstSolutionRoutes
public OptimizeToursRequest.Builder addInjectedFirstSolutionRoutes(ShipmentRoute.Builder builderForValue) 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; -
addInjectedFirstSolutionRoutes
public OptimizeToursRequest.Builder addInjectedFirstSolutionRoutes(int index, ShipmentRoute.Builder builderForValue) 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; -
addAllInjectedFirstSolutionRoutes
public OptimizeToursRequest.Builder addAllInjectedFirstSolutionRoutes(Iterable<? extends ShipmentRoute> values) 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; -
clearInjectedFirstSolutionRoutes
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; -
removeInjectedFirstSolutionRoutes
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; -
getInjectedFirstSolutionRoutesBuilder
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
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;- Specified by:
getInjectedFirstSolutionRoutesOrBuilderin interfaceOptimizeToursRequestOrBuilder
-
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;- Specified by:
getInjectedFirstSolutionRoutesOrBuilderListin interfaceOptimizeToursRequestOrBuilder
-
addInjectedFirstSolutionRoutesBuilder
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; -
addInjectedFirstSolutionRoutesBuilder
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; -
getInjectedFirstSolutionRoutesBuilderList
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
public 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;- Specified by:
hasInjectedSolutionConstraintin interfaceOptimizeToursRequestOrBuilder- Returns:
- Whether the injectedSolutionConstraint field is set.
-
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;- Specified by:
getInjectedSolutionConstraintin interfaceOptimizeToursRequestOrBuilder- Returns:
- The injectedSolutionConstraint.
-
setInjectedSolutionConstraint
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; -
setInjectedSolutionConstraint
public OptimizeToursRequest.Builder setInjectedSolutionConstraint(InjectedSolutionConstraint.Builder builderForValue) 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; -
mergeInjectedSolutionConstraint
public OptimizeToursRequest.Builder mergeInjectedSolutionConstraint(InjectedSolutionConstraint value) 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; -
clearInjectedSolutionConstraint
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; -
getInjectedSolutionConstraintBuilder
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; -
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;- Specified by:
getInjectedSolutionConstraintOrBuilderin interfaceOptimizeToursRequestOrBuilder
-
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;- Specified by:
getRefreshDetailsRoutesListin interfaceOptimizeToursRequestOrBuilder
-
getRefreshDetailsRoutesCount
public 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;- Specified by:
getRefreshDetailsRoutesCountin interfaceOptimizeToursRequestOrBuilder
-
getRefreshDetailsRoutes
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;- Specified by:
getRefreshDetailsRoutesin interfaceOptimizeToursRequestOrBuilder
-
setRefreshDetailsRoutes
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; -
setRefreshDetailsRoutes
public OptimizeToursRequest.Builder setRefreshDetailsRoutes(int index, ShipmentRoute.Builder builderForValue) 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; -
addRefreshDetailsRoutes
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; -
addRefreshDetailsRoutes
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; -
addRefreshDetailsRoutes
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; -
addRefreshDetailsRoutes
public OptimizeToursRequest.Builder addRefreshDetailsRoutes(int index, ShipmentRoute.Builder builderForValue) 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; -
addAllRefreshDetailsRoutes
public OptimizeToursRequest.Builder addAllRefreshDetailsRoutes(Iterable<? extends ShipmentRoute> values) 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; -
clearRefreshDetailsRoutes
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; -
removeRefreshDetailsRoutes
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; -
getRefreshDetailsRoutesBuilder
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
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;- Specified by:
getRefreshDetailsRoutesOrBuilderin interfaceOptimizeToursRequestOrBuilder
-
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;- Specified by:
getRefreshDetailsRoutesOrBuilderListin interfaceOptimizeToursRequestOrBuilder
-
addRefreshDetailsRoutesBuilder
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; -
addRefreshDetailsRoutesBuilder
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; -
getRefreshDetailsRoutesBuilderList
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
public 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;- Specified by:
getInterpretInjectedSolutionsUsingLabelsin interfaceOptimizeToursRequestOrBuilder- Returns:
- The interpretInjectedSolutionsUsingLabels.
-
setInterpretInjectedSolutionsUsingLabels
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;- Parameters:
value- The interpretInjectedSolutionsUsingLabels to set.- Returns:
- This builder for chaining.
-
clearInterpretInjectedSolutionsUsingLabels
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:
- This builder for chaining.
-
getConsiderRoadTraffic
public 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;- Specified by:
getConsiderRoadTrafficin interfaceOptimizeToursRequestOrBuilder- Returns:
- The considerRoadTraffic.
-
setConsiderRoadTraffic
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;- Parameters:
value- The considerRoadTraffic to set.- Returns:
- This builder for chaining.
-
clearConsiderRoadTraffic
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:
- This builder for chaining.
-
getPopulatePolylines
public boolean getPopulatePolylines()If true, polylines will be populated in response `ShipmentRoute`s.
bool populate_polylines = 12;- Specified by:
getPopulatePolylinesin interfaceOptimizeToursRequestOrBuilder- Returns:
- The populatePolylines.
-
setPopulatePolylines
If true, polylines will be populated in response `ShipmentRoute`s.
bool populate_polylines = 12;- Parameters:
value- The populatePolylines to set.- Returns:
- This builder for chaining.
-
clearPopulatePolylines
If true, polylines will be populated in response `ShipmentRoute`s.
bool populate_polylines = 12;- Returns:
- This builder for chaining.
-
getPopulateTransitionPolylines
public 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;- Specified by:
getPopulateTransitionPolylinesin interfaceOptimizeToursRequestOrBuilder- Returns:
- The populateTransitionPolylines.
-
setPopulateTransitionPolylines
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;- Parameters:
value- The populateTransitionPolylines to set.- Returns:
- This builder for chaining.
-
clearPopulateTransitionPolylines
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:
- This builder for chaining.
-
getAllowLargeDeadlineDespiteInterruptionRisk
public 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;- Specified by:
getAllowLargeDeadlineDespiteInterruptionRiskin interfaceOptimizeToursRequestOrBuilder- Returns:
- The allowLargeDeadlineDespiteInterruptionRisk.
-
setAllowLargeDeadlineDespiteInterruptionRisk
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;- Parameters:
value- The allowLargeDeadlineDespiteInterruptionRisk to set.- Returns:
- This builder for chaining.
-
clearAllowLargeDeadlineDespiteInterruptionRisk
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:
- This builder for chaining.
-
getUseGeodesicDistances
public 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;- Specified by:
getUseGeodesicDistancesin interfaceOptimizeToursRequestOrBuilder- Returns:
- The useGeodesicDistances.
-
setUseGeodesicDistances
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;- Parameters:
value- The useGeodesicDistances to set.- Returns:
- This builder for chaining.
-
clearUseGeodesicDistances
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:
- This builder for chaining.
-
hasGeodesicMetersPerSecond
public 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;- Specified by:
hasGeodesicMetersPerSecondin interfaceOptimizeToursRequestOrBuilder- Returns:
- Whether the geodesicMetersPerSecond field is set.
-
getGeodesicMetersPerSecond
public 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;- Specified by:
getGeodesicMetersPerSecondin interfaceOptimizeToursRequestOrBuilder- Returns:
- The geodesicMetersPerSecond.
-
setGeodesicMetersPerSecond
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;- Parameters:
value- The geodesicMetersPerSecond to set.- Returns:
- This builder for chaining.
-
clearGeodesicMetersPerSecond
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:
- This builder for chaining.
-
hasMaxValidationErrors
public 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;- Specified by:
hasMaxValidationErrorsin interfaceOptimizeToursRequestOrBuilder- Returns:
- Whether the maxValidationErrors field is set.
-
getMaxValidationErrors
public 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;- Specified by:
getMaxValidationErrorsin interfaceOptimizeToursRequestOrBuilder- Returns:
- The maxValidationErrors.
-
setMaxValidationErrors
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;- Parameters:
value- The maxValidationErrors to set.- Returns:
- This builder for chaining.
-
clearMaxValidationErrors
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:
- This builder for chaining.
-
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;- Specified by:
getLabelin interfaceOptimizeToursRequestOrBuilder- Returns:
- The label.
-
getLabelBytes
public 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;- Specified by:
getLabelBytesin interfaceOptimizeToursRequestOrBuilder- Returns:
- The bytes for label.
-
setLabel
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;- Parameters:
value- The label to set.- Returns:
- This builder for chaining.
-
clearLabel
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:
- This builder for chaining.
-
setLabelBytes
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;- Parameters:
value- The bytes for label to set.- Returns:
- This builder for chaining.
-
getPopulateTravelStepPolylines
Deprecated.google.cloud.optimization.v1.OptimizeToursRequest.populate_travel_step_polylines is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=359Deprecated: 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];- Specified by:
getPopulateTravelStepPolylinesin interfaceOptimizeToursRequestOrBuilder- Returns:
- The populateTravelStepPolylines.
-
setPopulateTravelStepPolylines
Deprecated.google.cloud.optimization.v1.OptimizeToursRequest.populate_travel_step_polylines is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=359Deprecated: 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];- Parameters:
value- The populateTravelStepPolylines to set.- Returns:
- This builder for chaining.
-
clearPopulateTravelStepPolylines
Deprecated.google.cloud.optimization.v1.OptimizeToursRequest.populate_travel_step_polylines is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=359Deprecated: 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:
- This builder for chaining.
-