Class OptimizeToursRequest.Builder (1.13.0)

public static final class OptimizeToursRequest.Builder extends GeneratedMessageV3.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > OptimizeToursRequest.Builder

Implements

OptimizeToursRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllInjectedFirstSolutionRoutes(Iterable<? extends ShipmentRoute> values)

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 is empty or its vehicle_index is included in 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;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.optimization.v1.ShipmentRoute>`

Returns
Type	Description
`OptimizeToursRequest.Builder`

addAllRefreshDetailsRoutes(Iterable<? extends ShipmentRoute> values)

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;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.optimization.v1.ShipmentRoute>`

Returns
Type	Description
`OptimizeToursRequest.Builder`

addInjectedFirstSolutionRoutes(ShipmentRoute value)

public OptimizeToursRequest.Builder addInjectedFirstSolutionRoutes(ShipmentRoute value)

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 is empty or its vehicle_index is included in 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;

Parameter
Name	Description
`value`	`ShipmentRoute`

Returns
Type	Description
`OptimizeToursRequest.Builder`

addInjectedFirstSolutionRoutes(ShipmentRoute.Builder builderForValue)

public OptimizeToursRequest.Builder addInjectedFirstSolutionRoutes(ShipmentRoute.Builder builderForValue)

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 is empty or its vehicle_index is included in 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;

Parameter
Name	Description
`builderForValue`	`ShipmentRoute.Builder`

Returns
Type	Description
`OptimizeToursRequest.Builder`

addInjectedFirstSolutionRoutes(int index, ShipmentRoute value)

public OptimizeToursRequest.Builder addInjectedFirstSolutionRoutes(int index, ShipmentRoute value)

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 is empty or its vehicle_index is included in 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;

Parameters
Name	Description
`index`	`int`
`value`	`ShipmentRoute`

Returns
Type	Description
`OptimizeToursRequest.Builder`

addInjectedFirstSolutionRoutes(int index, ShipmentRoute.Builder builderForValue)

public OptimizeToursRequest.Builder addInjectedFirstSolutionRoutes(int index, ShipmentRoute.Builder builderForValue)

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 is empty or its vehicle_index is included in 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;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ShipmentRoute.Builder`

Returns
Type	Description
`OptimizeToursRequest.Builder`

addInjectedFirstSolutionRoutesBuilder()

public ShipmentRoute.Builder addInjectedFirstSolutionRoutesBuilder()

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 is empty or its vehicle_index is included in 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;

Returns
Type	Description
`ShipmentRoute.Builder`

addInjectedFirstSolutionRoutesBuilder(int index)

public ShipmentRoute.Builder addInjectedFirstSolutionRoutesBuilder(int index)

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 is empty or its vehicle_index is included in 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;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Builder`

addRefreshDetailsRoutes(ShipmentRoute value)

public OptimizeToursRequest.Builder addRefreshDetailsRoutes(ShipmentRoute value)

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Parameter
Name	Description
`value`	`ShipmentRoute`

Returns
Type	Description
`OptimizeToursRequest.Builder`

addRefreshDetailsRoutes(ShipmentRoute.Builder builderForValue)

public OptimizeToursRequest.Builder addRefreshDetailsRoutes(ShipmentRoute.Builder builderForValue)

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Parameter
Name	Description
`builderForValue`	`ShipmentRoute.Builder`

Returns
Type	Description
`OptimizeToursRequest.Builder`

addRefreshDetailsRoutes(int index, ShipmentRoute value)

public OptimizeToursRequest.Builder addRefreshDetailsRoutes(int index, ShipmentRoute value)

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Parameters
Name	Description
`index`	`int`
`value`	`ShipmentRoute`

Returns
Type	Description
`OptimizeToursRequest.Builder`

addRefreshDetailsRoutes(int index, ShipmentRoute.Builder builderForValue)

public OptimizeToursRequest.Builder addRefreshDetailsRoutes(int index, ShipmentRoute.Builder builderForValue)

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ShipmentRoute.Builder`

Returns
Type	Description
`OptimizeToursRequest.Builder`

addRefreshDetailsRoutesBuilder()

public ShipmentRoute.Builder addRefreshDetailsRoutesBuilder()

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Returns
Type	Description
`ShipmentRoute.Builder`

addRefreshDetailsRoutesBuilder(int index)

public ShipmentRoute.Builder addRefreshDetailsRoutesBuilder(int index)

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public OptimizeToursRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`OptimizeToursRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public OptimizeToursRequest build()

Returns
Type	Description
`OptimizeToursRequest`

buildPartial()

public OptimizeToursRequest buildPartial()

Returns
Type	Description
`OptimizeToursRequest`

clear()

public OptimizeToursRequest.Builder clear()

Returns
Type	Description
`OptimizeToursRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAllowLargeDeadlineDespiteInterruptionRisk()

public OptimizeToursRequest.Builder 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
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

clearConsiderRoadTraffic()

public OptimizeToursRequest.Builder clearConsiderRoadTraffic()

Consider traffic estimation in calculating ShipmentRoute fields Transition.travel_duration, Visit.start_time, and vehicle_end_time; in setting the ShipmentRoute.has_traffic_infeasibilities field, and in calculating the OptimizeToursResponse.total_cost field.

bool consider_road_traffic = 11;

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public OptimizeToursRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`OptimizeToursRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGeodesicMetersPerSecond()

public OptimizeToursRequest.Builder 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
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

clearInjectedFirstSolutionRoutes()

public OptimizeToursRequest.Builder clearInjectedFirstSolutionRoutes()

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 is empty or its vehicle_index is included in 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;

Returns
Type	Description
`OptimizeToursRequest.Builder`

clearInjectedSolutionConstraint()

public OptimizeToursRequest.Builder 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;

Returns
Type	Description
`OptimizeToursRequest.Builder`

clearInterpretInjectedSolutionsUsingLabels()

public OptimizeToursRequest.Builder clearInterpretInjectedSolutionsUsingLabels()

If true:

uses 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 to new ShipmentRoute.vehicle_index to update ConstraintRelaxation.vehicle_indices if non-empty, but the mapping must be unambiguous (i.e., multiple ShipmentRoutes must not share the same original vehicle_index).
uses ShipmentRoute.Visit.shipment_label instead of shipment_index to match visits in an injected solution with shipments in the request;
uses SkippedShipment.label instead of 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 in the request;
Shipment.label in the request;
ShipmentRoute.vehicle_label in the injected solution;
SkippedShipment.label and 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 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 (resp. 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
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

clearLabel()

public OptimizeToursRequest.Builder clearLabel()

Label that may be used to identify this request, reported back in the OptimizeToursResponse.request_label.

string label = 17;

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

clearMaxValidationErrors()

public OptimizeToursRequest.Builder 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 field. This defaults to 100 and is capped at 10,000.

optional int32 max_validation_errors = 5;

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

clearModel()

public OptimizeToursRequest.Builder clearModel()

Shipment model to solve.

.google.cloud.optimization.v1.ShipmentModel model = 3;

Returns
Type	Description
`OptimizeToursRequest.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public OptimizeToursRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`OptimizeToursRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParent()

public OptimizeToursRequest.Builder 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
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

clearPopulatePolylines()

public OptimizeToursRequest.Builder clearPopulatePolylines()

If true, polylines will be populated in response ShipmentRoutes.

bool populate_polylines = 12;

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

clearPopulateTransitionPolylines()

public OptimizeToursRequest.Builder clearPopulateTransitionPolylines()

If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated travel_steps.

bool populate_transition_polylines = 13;

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

clearPopulateTravelStepPolylines() (deprecated)

public OptimizeToursRequest.Builder clearPopulateTravelStepPolylines()

Deprecated. google.cloud.optimization.v1.OptimizeToursRequest.populate_travel_step_polylines is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=351

Deprecated: Use OptimizeToursRequest.populate_transition_polylines instead. If true, polylines will be populated in response 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
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

clearRefreshDetailsRoutes()

public OptimizeToursRequest.Builder clearRefreshDetailsRoutes()

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Returns
Type	Description
`OptimizeToursRequest.Builder`

clearSearchMode()

public OptimizeToursRequest.Builder clearSearchMode()

Search mode used to solve the request.

.google.cloud.optimization.v1.OptimizeToursRequest.SearchMode search_mode = 6;

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

clearSolvingMode()

public OptimizeToursRequest.Builder clearSolvingMode()

By default, the solving mode is DEFAULT_SOLVE (0).

.google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

clearTimeout()

public OptimizeToursRequest.Builder 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;

Returns
Type	Description
`OptimizeToursRequest.Builder`

clearUseGeodesicDistances()

public OptimizeToursRequest.Builder 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
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

clone()

public OptimizeToursRequest.Builder clone()

Returns
Type	Description
`OptimizeToursRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAllowLargeDeadlineDespiteInterruptionRisk()

public boolean getAllowLargeDeadlineDespiteInterruptionRisk()

bool allow_large_deadline_despite_interruption_risk = 14;

Returns
Type	Description
`boolean`	The allowLargeDeadlineDespiteInterruptionRisk.

getConsiderRoadTraffic()

public boolean getConsiderRoadTraffic()

bool consider_road_traffic = 11;

Returns
Type	Description
`boolean`	The considerRoadTraffic.

getDefaultInstanceForType()

public OptimizeToursRequest getDefaultInstanceForType()

Returns
Type	Description
`OptimizeToursRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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;

Returns
Type	Description
`double`	The geodesicMetersPerSecond.

getInjectedFirstSolutionRoutes(int index)

public ShipmentRoute getInjectedFirstSolutionRoutes(int index)

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 is empty or its vehicle_index is included in 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;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute`

getInjectedFirstSolutionRoutesBuilder(int index)

public ShipmentRoute.Builder getInjectedFirstSolutionRoutesBuilder(int index)

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 is empty or its vehicle_index is included in 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;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Builder`

getInjectedFirstSolutionRoutesBuilderList()

public List<ShipmentRoute.Builder> getInjectedFirstSolutionRoutesBuilderList()

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 is empty or its vehicle_index is included in 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;

Returns
Type	Description
`List<Builder>`

getInjectedFirstSolutionRoutesCount()

public int getInjectedFirstSolutionRoutesCount()

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 is empty or its vehicle_index is included in 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;

Returns
Type	Description
`int`

getInjectedFirstSolutionRoutesList()

public List<ShipmentRoute> getInjectedFirstSolutionRoutesList()

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 is empty or its vehicle_index is included in 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;

Returns
Type	Description
`List<ShipmentRoute>`

getInjectedFirstSolutionRoutesOrBuilder(int index)

public ShipmentRouteOrBuilder getInjectedFirstSolutionRoutesOrBuilder(int index)

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 is empty or its vehicle_index is included in 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;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRouteOrBuilder`

getInjectedFirstSolutionRoutesOrBuilderList()

public List<? extends ShipmentRouteOrBuilder> getInjectedFirstSolutionRoutesOrBuilderList()

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 is empty or its vehicle_index is included in 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;

Returns
Type	Description
`List<? extends com.google.cloud.optimization.v1.ShipmentRouteOrBuilder>`

getInjectedSolutionConstraint()

public InjectedSolutionConstraint getInjectedSolutionConstraint()

.google.cloud.optimization.v1.InjectedSolutionConstraint injected_solution_constraint = 8;

Returns
Type	Description
`InjectedSolutionConstraint`	The injectedSolutionConstraint.

getInjectedSolutionConstraintBuilder()

public InjectedSolutionConstraint.Builder getInjectedSolutionConstraintBuilder()

.google.cloud.optimization.v1.InjectedSolutionConstraint injected_solution_constraint = 8;

Returns
Type	Description
`InjectedSolutionConstraint.Builder`

getInjectedSolutionConstraintOrBuilder()

public InjectedSolutionConstraintOrBuilder getInjectedSolutionConstraintOrBuilder()

.google.cloud.optimization.v1.InjectedSolutionConstraint injected_solution_constraint = 8;

Returns
Type	Description
`InjectedSolutionConstraintOrBuilder`

getInterpretInjectedSolutionsUsingLabels()

public boolean getInterpretInjectedSolutionsUsingLabels()

If true:

uses 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 to new ShipmentRoute.vehicle_index to update ConstraintRelaxation.vehicle_indices if non-empty, but the mapping must be unambiguous (i.e., multiple ShipmentRoutes must not share the same original vehicle_index).
uses ShipmentRoute.Visit.shipment_label instead of shipment_index to match visits in an injected solution with shipments in the request;
uses SkippedShipment.label instead of 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 in the request;
Shipment.label in the request;
ShipmentRoute.vehicle_label in the injected solution;
SkippedShipment.label and 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 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 (resp. 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
Type	Description
`boolean`	The interpretInjectedSolutionsUsingLabels.

getLabel()

public String getLabel()

Label that may be used to identify this request, reported back in the OptimizeToursResponse.request_label.

string label = 17;

Returns
Type	Description
`String`	The label.

getLabelBytes()

public ByteString getLabelBytes()

Label that may be used to identify this request, reported back in the OptimizeToursResponse.request_label.

string label = 17;

Returns
Type	Description
`ByteString`	The bytes for label.

getMaxValidationErrors()

public int getMaxValidationErrors()

optional int32 max_validation_errors = 5;

Returns
Type	Description
`int`	The maxValidationErrors.

getModel()

public ShipmentModel getModel()

Shipment model to solve.

.google.cloud.optimization.v1.ShipmentModel model = 3;

Returns
Type	Description
`ShipmentModel`	The model.

getModelBuilder()

public ShipmentModel.Builder getModelBuilder()

Shipment model to solve.

.google.cloud.optimization.v1.ShipmentModel model = 3;

Returns
Type	Description
`ShipmentModel.Builder`

getModelOrBuilder()

public ShipmentModelOrBuilder getModelOrBuilder()

Shipment model to solve.

.google.cloud.optimization.v1.ShipmentModel model = 3;

Returns
Type	Description
`ShipmentModelOrBuilder`

getParent()

public String getParent()

Required. Target project and location to make a call. Format: projects/{project-id}/locations/{location-id}. If no location is specified, a region will be chosen automatically.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Target project and location to make a call. Format: projects/{project-id}/locations/{location-id}. If no location is specified, a region will be chosen automatically.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for parent.

getPopulatePolylines()

public boolean getPopulatePolylines()

If true, polylines will be populated in response ShipmentRoutes.

bool populate_polylines = 12;

Returns
Type	Description
`boolean`	The populatePolylines.

getPopulateTransitionPolylines()

public boolean getPopulateTransitionPolylines()

If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated travel_steps.

bool populate_transition_polylines = 13;

Returns
Type	Description
`boolean`	The populateTransitionPolylines.

getPopulateTravelStepPolylines() (deprecated)

public boolean getPopulateTravelStepPolylines()

Deprecated. google.cloud.optimization.v1.OptimizeToursRequest.populate_travel_step_polylines is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=351

bool populate_travel_step_polylines = 20 [deprecated = true];

Returns
Type	Description
`boolean`	The populateTravelStepPolylines.

getRefreshDetailsRoutes(int index)

public ShipmentRoute getRefreshDetailsRoutes(int index)

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute`

getRefreshDetailsRoutesBuilder(int index)

public ShipmentRoute.Builder getRefreshDetailsRoutesBuilder(int index)

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Builder`

getRefreshDetailsRoutesBuilderList()

public List<ShipmentRoute.Builder> getRefreshDetailsRoutesBuilderList()

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Returns
Type	Description
`List<Builder>`

getRefreshDetailsRoutesCount()

public int getRefreshDetailsRoutesCount()

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Returns
Type	Description
`int`

getRefreshDetailsRoutesList()

public List<ShipmentRoute> getRefreshDetailsRoutesList()

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Returns
Type	Description
`List<ShipmentRoute>`

getRefreshDetailsRoutesOrBuilder(int index)

public ShipmentRouteOrBuilder getRefreshDetailsRoutesOrBuilder(int index)

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRouteOrBuilder`

getRefreshDetailsRoutesOrBuilderList()

public List<? extends ShipmentRouteOrBuilder> getRefreshDetailsRoutesOrBuilderList()

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Returns
Type	Description
`List<? extends com.google.cloud.optimization.v1.ShipmentRouteOrBuilder>`

getSearchMode()

public OptimizeToursRequest.SearchMode getSearchMode()

Search mode used to solve the request.

.google.cloud.optimization.v1.OptimizeToursRequest.SearchMode search_mode = 6;

Returns
Type	Description
`OptimizeToursRequest.SearchMode`	The searchMode.

getSearchModeValue()

public int getSearchModeValue()

Search mode used to solve the request.

.google.cloud.optimization.v1.OptimizeToursRequest.SearchMode search_mode = 6;

Returns
Type	Description
`int`	The enum numeric value on the wire for searchMode.

getSolvingMode()

public OptimizeToursRequest.SolvingMode getSolvingMode()

By default, the solving mode is DEFAULT_SOLVE (0).

.google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;

Returns
Type	Description
`OptimizeToursRequest.SolvingMode`	The solvingMode.

getSolvingModeValue()

public int getSolvingModeValue()

By default, the solving mode is DEFAULT_SOLVE (0).

.google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;

Returns
Type	Description
`int`	The enum numeric value on the wire for solvingMode.

getTimeout()

public Duration getTimeout()

.google.protobuf.Duration timeout = 2;

Returns
Type	Description
`Duration`	The timeout.

getTimeoutBuilder()

public Duration.Builder getTimeoutBuilder()

.google.protobuf.Duration timeout = 2;

Returns
Type	Description
`Builder`

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

.google.protobuf.Duration timeout = 2;

Returns
Type	Description
`DurationOrBuilder`

getUseGeodesicDistances()

public boolean getUseGeodesicDistances()

bool use_geodesic_distances = 15;

Returns
Type	Description
`boolean`	The useGeodesicDistances.

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;

Returns
Type	Description
`boolean`	Whether the geodesicMetersPerSecond field is set.

hasInjectedSolutionConstraint()

public boolean hasInjectedSolutionConstraint()

.google.cloud.optimization.v1.InjectedSolutionConstraint injected_solution_constraint = 8;

Returns
Type	Description
`boolean`	Whether the injectedSolutionConstraint field is set.

hasMaxValidationErrors()

public boolean hasMaxValidationErrors()

optional int32 max_validation_errors = 5;

Returns
Type	Description
`boolean`	Whether the maxValidationErrors field is set.

hasModel()

public boolean hasModel()

Shipment model to solve.

.google.cloud.optimization.v1.ShipmentModel model = 3;

Returns
Type	Description
`boolean`	Whether the model field is set.

hasTimeout()

public boolean hasTimeout()

.google.protobuf.Duration timeout = 2;

Returns
Type	Description
`boolean`	Whether the timeout field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(OptimizeToursRequest other)

public OptimizeToursRequest.Builder mergeFrom(OptimizeToursRequest other)

Parameter
Name	Description
`other`	`OptimizeToursRequest`

Returns
Type	Description
`OptimizeToursRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public OptimizeToursRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`OptimizeToursRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public OptimizeToursRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`OptimizeToursRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeInjectedSolutionConstraint(InjectedSolutionConstraint value)

public OptimizeToursRequest.Builder mergeInjectedSolutionConstraint(InjectedSolutionConstraint value)

.google.cloud.optimization.v1.InjectedSolutionConstraint injected_solution_constraint = 8;

Parameter
Name	Description
`value`	`InjectedSolutionConstraint`

Returns
Type	Description
`OptimizeToursRequest.Builder`

mergeModel(ShipmentModel value)

public OptimizeToursRequest.Builder mergeModel(ShipmentModel value)

Shipment model to solve.

.google.cloud.optimization.v1.ShipmentModel model = 3;

Parameter
Name	Description
`value`	`ShipmentModel`

Returns
Type	Description
`OptimizeToursRequest.Builder`

mergeTimeout(Duration value)

public OptimizeToursRequest.Builder mergeTimeout(Duration value)

.google.protobuf.Duration timeout = 2;

Parameter
Name	Description
`value`	`Duration`

Returns
Type	Description
`OptimizeToursRequest.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OptimizeToursRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`OptimizeToursRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeInjectedFirstSolutionRoutes(int index)

public OptimizeToursRequest.Builder removeInjectedFirstSolutionRoutes(int index)

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 is empty or its vehicle_index is included in 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;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`OptimizeToursRequest.Builder`

removeRefreshDetailsRoutes(int index)

public OptimizeToursRequest.Builder removeRefreshDetailsRoutes(int index)

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`OptimizeToursRequest.Builder`

setAllowLargeDeadlineDespiteInterruptionRisk(boolean value)

public OptimizeToursRequest.Builder setAllowLargeDeadlineDespiteInterruptionRisk(boolean value)

bool allow_large_deadline_despite_interruption_risk = 14;

Parameter
Name	Description
`value`	`boolean` The allowLargeDeadlineDespiteInterruptionRisk to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setConsiderRoadTraffic(boolean value)

public OptimizeToursRequest.Builder setConsiderRoadTraffic(boolean value)

bool consider_road_traffic = 11;

Parameter
Name	Description
`value`	`boolean` The considerRoadTraffic to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public OptimizeToursRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`OptimizeToursRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGeodesicMetersPerSecond(double value)

public OptimizeToursRequest.Builder setGeodesicMetersPerSecond(double value)

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;

Parameter
Name	Description
`value`	`double` The geodesicMetersPerSecond to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setInjectedFirstSolutionRoutes(int index, ShipmentRoute value)

public OptimizeToursRequest.Builder setInjectedFirstSolutionRoutes(int index, ShipmentRoute value)

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 is empty or its vehicle_index is included in 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;

Parameters
Name	Description
`index`	`int`
`value`	`ShipmentRoute`

Returns
Type	Description
`OptimizeToursRequest.Builder`

setInjectedFirstSolutionRoutes(int index, ShipmentRoute.Builder builderForValue)

public OptimizeToursRequest.Builder setInjectedFirstSolutionRoutes(int index, ShipmentRoute.Builder builderForValue)

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 is empty or its vehicle_index is included in 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;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ShipmentRoute.Builder`

Returns
Type	Description
`OptimizeToursRequest.Builder`

setInjectedSolutionConstraint(InjectedSolutionConstraint value)

public OptimizeToursRequest.Builder setInjectedSolutionConstraint(InjectedSolutionConstraint value)

.google.cloud.optimization.v1.InjectedSolutionConstraint injected_solution_constraint = 8;

Parameter
Name	Description
`value`	`InjectedSolutionConstraint`

Returns
Type	Description
`OptimizeToursRequest.Builder`

setInjectedSolutionConstraint(InjectedSolutionConstraint.Builder builderForValue)

public OptimizeToursRequest.Builder setInjectedSolutionConstraint(InjectedSolutionConstraint.Builder builderForValue)

.google.cloud.optimization.v1.InjectedSolutionConstraint injected_solution_constraint = 8;

Parameter
Name	Description
`builderForValue`	`InjectedSolutionConstraint.Builder`

Returns
Type	Description
`OptimizeToursRequest.Builder`

setInterpretInjectedSolutionsUsingLabels(boolean value)

public OptimizeToursRequest.Builder setInterpretInjectedSolutionsUsingLabels(boolean value)

If true:

uses 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 to new ShipmentRoute.vehicle_index to update ConstraintRelaxation.vehicle_indices if non-empty, but the mapping must be unambiguous (i.e., multiple ShipmentRoutes must not share the same original vehicle_index).
uses ShipmentRoute.Visit.shipment_label instead of shipment_index to match visits in an injected solution with shipments in the request;
uses SkippedShipment.label instead of 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 in the request;
Shipment.label in the request;
ShipmentRoute.vehicle_label in the injected solution;
SkippedShipment.label and 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 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 (resp. 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;

Parameter
Name	Description
`value`	`boolean` The interpretInjectedSolutionsUsingLabels to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setLabel(String value)

public OptimizeToursRequest.Builder setLabel(String value)

Label that may be used to identify this request, reported back in the OptimizeToursResponse.request_label.

string label = 17;

Parameter
Name	Description
`value`	`String` The label to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setLabelBytes(ByteString value)

public OptimizeToursRequest.Builder setLabelBytes(ByteString value)

Label that may be used to identify this request, reported back in the OptimizeToursResponse.request_label.

string label = 17;

Parameter
Name	Description
`value`	`ByteString` The bytes for label to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setMaxValidationErrors(int value)

public OptimizeToursRequest.Builder setMaxValidationErrors(int value)

optional int32 max_validation_errors = 5;

Parameter
Name	Description
`value`	`int` The maxValidationErrors to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setModel(ShipmentModel value)

public OptimizeToursRequest.Builder setModel(ShipmentModel value)

Shipment model to solve.

.google.cloud.optimization.v1.ShipmentModel model = 3;

Parameter
Name	Description
`value`	`ShipmentModel`

Returns
Type	Description
`OptimizeToursRequest.Builder`

setModel(ShipmentModel.Builder builderForValue)

public OptimizeToursRequest.Builder setModel(ShipmentModel.Builder builderForValue)

Shipment model to solve.

.google.cloud.optimization.v1.ShipmentModel model = 3;

Parameter
Name	Description
`builderForValue`	`ShipmentModel.Builder`

Returns
Type	Description
`OptimizeToursRequest.Builder`

setParent(String value)

public OptimizeToursRequest.Builder setParent(String value)

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];

Parameter
Name	Description
`value`	`String` The parent to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setParentBytes(ByteString value)

public OptimizeToursRequest.Builder setParentBytes(ByteString value)

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];

Parameter
Name	Description
`value`	`ByteString` The bytes for parent to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setPopulatePolylines(boolean value)

public OptimizeToursRequest.Builder setPopulatePolylines(boolean value)

If true, polylines will be populated in response ShipmentRoutes.

bool populate_polylines = 12;

Parameter
Name	Description
`value`	`boolean` The populatePolylines to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setPopulateTransitionPolylines(boolean value)

public OptimizeToursRequest.Builder setPopulateTransitionPolylines(boolean value)

If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated travel_steps.

bool populate_transition_polylines = 13;

Parameter
Name	Description
`value`	`boolean` The populateTransitionPolylines to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setPopulateTravelStepPolylines(boolean value) (deprecated)

public OptimizeToursRequest.Builder setPopulateTravelStepPolylines(boolean value)

Deprecated. google.cloud.optimization.v1.OptimizeToursRequest.populate_travel_step_polylines is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=351

bool populate_travel_step_polylines = 20 [deprecated = true];

Parameter
Name	Description
`value`	`boolean` The populateTravelStepPolylines to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setRefreshDetailsRoutes(int index, ShipmentRoute value)

public OptimizeToursRequest.Builder setRefreshDetailsRoutes(int index, ShipmentRoute value)

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Parameters
Name	Description
`index`	`int`
`value`	`ShipmentRoute`

Returns
Type	Description
`OptimizeToursRequest.Builder`

setRefreshDetailsRoutes(int index, ShipmentRoute.Builder builderForValue)

public OptimizeToursRequest.Builder setRefreshDetailsRoutes(int index, ShipmentRoute.Builder builderForValue)

repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ShipmentRoute.Builder`

Returns
Type	Description
`OptimizeToursRequest.Builder`

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public OptimizeToursRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`OptimizeToursRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSearchMode(OptimizeToursRequest.SearchMode value)

public OptimizeToursRequest.Builder setSearchMode(OptimizeToursRequest.SearchMode value)

Search mode used to solve the request.

.google.cloud.optimization.v1.OptimizeToursRequest.SearchMode search_mode = 6;

Parameter
Name	Description
`value`	`OptimizeToursRequest.SearchMode` The searchMode to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setSearchModeValue(int value)

public OptimizeToursRequest.Builder setSearchModeValue(int value)

Search mode used to solve the request.

.google.cloud.optimization.v1.OptimizeToursRequest.SearchMode search_mode = 6;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for searchMode to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setSolvingMode(OptimizeToursRequest.SolvingMode value)

public OptimizeToursRequest.Builder setSolvingMode(OptimizeToursRequest.SolvingMode value)

By default, the solving mode is DEFAULT_SOLVE (0).

.google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;

Parameter
Name	Description
`value`	`OptimizeToursRequest.SolvingMode` The solvingMode to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setSolvingModeValue(int value)

public OptimizeToursRequest.Builder setSolvingModeValue(int value)

By default, the solving mode is DEFAULT_SOLVE (0).

.google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for solvingMode to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.

setTimeout(Duration value)

public OptimizeToursRequest.Builder setTimeout(Duration value)

.google.protobuf.Duration timeout = 2;

Parameter
Name	Description
`value`	`Duration`

Returns
Type	Description
`OptimizeToursRequest.Builder`

setTimeout(Duration.Builder builderForValue)

public OptimizeToursRequest.Builder setTimeout(Duration.Builder builderForValue)

.google.protobuf.Duration timeout = 2;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`OptimizeToursRequest.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final OptimizeToursRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`OptimizeToursRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUseGeodesicDistances(boolean value)

public OptimizeToursRequest.Builder setUseGeodesicDistances(boolean value)

bool use_geodesic_distances = 15;

Parameter
Name	Description
`value`	`boolean` The useGeodesicDistances to set.

Returns
Type	Description
`OptimizeToursRequest.Builder`	This builder for chaining.