public final class OptimizeToursRequest extends GeneratedMessageV3 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
Static Fields
ALLOW_LARGE_DEADLINE_DESPITE_INTERRUPTION_RISK_FIELD_NUMBER
public static final int ALLOW_LARGE_DEADLINE_DESPITE_INTERRUPTION_RISK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CONSIDER_ROAD_TRAFFIC_FIELD_NUMBER
public static final int CONSIDER_ROAD_TRAFFIC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
GEODESIC_METERS_PER_SECOND_FIELD_NUMBER
public static final int GEODESIC_METERS_PER_SECOND_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INJECTED_FIRST_SOLUTION_ROUTES_FIELD_NUMBER
public static final int INJECTED_FIRST_SOLUTION_ROUTES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INJECTED_SOLUTION_CONSTRAINT_FIELD_NUMBER
public static final int INJECTED_SOLUTION_CONSTRAINT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INTERPRET_INJECTED_SOLUTIONS_USING_LABELS_FIELD_NUMBER
public static final int INTERPRET_INJECTED_SOLUTIONS_USING_LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABEL_FIELD_NUMBER
public static final int LABEL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MAX_VALIDATION_ERRORS_FIELD_NUMBER
public static final int MAX_VALIDATION_ERRORS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MODEL_FIELD_NUMBER
public static final int MODEL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
POPULATE_POLYLINES_FIELD_NUMBER
public static final int POPULATE_POLYLINES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
POPULATE_TRANSITION_POLYLINES_FIELD_NUMBER
public static final int POPULATE_TRANSITION_POLYLINES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
POPULATE_TRAVEL_STEP_POLYLINES_FIELD_NUMBER
public static final int POPULATE_TRAVEL_STEP_POLYLINES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REFRESH_DETAILS_ROUTES_FIELD_NUMBER
public static final int REFRESH_DETAILS_ROUTES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SEARCH_MODE_FIELD_NUMBER
public static final int SEARCH_MODE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SOLVING_MODE_FIELD_NUMBER
public static final int SOLVING_MODE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TIMEOUT_FIELD_NUMBER
public static final int TIMEOUT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USE_GEODESIC_DISTANCES_FIELD_NUMBER
public static final int USE_GEODESIC_DISTANCES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static OptimizeToursRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static OptimizeToursRequest.Builder newBuilder()
newBuilder(OptimizeToursRequest prototype)
public static OptimizeToursRequest.Builder newBuilder(OptimizeToursRequest prototype)
public static OptimizeToursRequest parseDelimitedFrom(InputStream input)
public static OptimizeToursRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static OptimizeToursRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static OptimizeToursRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static OptimizeToursRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static OptimizeToursRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static OptimizeToursRequest parseFrom(CodedInputStream input)
public static OptimizeToursRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static OptimizeToursRequest parseFrom(InputStream input)
public static OptimizeToursRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static OptimizeToursRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static OptimizeToursRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<OptimizeToursRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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;
| Returns |
|---|
| Type | Description |
boolean | The allowLargeDeadlineDespiteInterruptionRisk.
|
getConsiderRoadTraffic()
public boolean getConsiderRoadTraffic()
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 |
boolean | The considerRoadTraffic.
|
getDefaultInstanceForType()
public OptimizeToursRequest getDefaultInstanceForType()
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)
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 |
index | int
|
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
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()
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;
getInjectedFirstSolutionRoutesOrBuilder(int index)
public ShipmentRouteOrBuilder getInjectedFirstSolutionRoutesOrBuilder(int index)
Guide the optimization algorithm in finding a first solution that is
similar to a previous solution.
The model is constrained when the first solution is built.
Any shipments not performed on a route are implicitly skipped in the first
solution, but they may be performed in successive solutions.
The solution must satisfy some basic validity assumptions:
- for all routes,
vehicle_index must be in range and not be duplicated.
- for all visits,
shipment_index and visit_request_index must be
in range.
- a shipment may only be referenced on one route.
- the pickup of a pickup-delivery shipment must be performed before
the delivery.
- no more than one pickup alternative or delivery alternative of
a shipment may be performed.
- for all routes, times are increasing (i.e.,
vehicle_start_time
<= visits[0].start_time <= visits[1].start_time ...
<= vehicle_end_time).
- a shipment may only be performed on a vehicle that is allowed. A
vehicle is allowed if
Shipment.allowed_vehicle_indices
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
|
getInjectedFirstSolutionRoutesOrBuilderList()
public List<? extends ShipmentRouteOrBuilder> getInjectedFirstSolutionRoutesOrBuilderList()
Guide the optimization algorithm in finding a first solution that is
similar to a previous solution.
The model is constrained when the first solution is built.
Any shipments not performed on a route are implicitly skipped in the first
solution, but they may be performed in successive solutions.
The solution must satisfy some basic validity assumptions:
- for all routes,
vehicle_index must be in range and not be duplicated.
- for all visits,
shipment_index and visit_request_index must be
in range.
- a shipment may only be referenced on one route.
- the pickup of a pickup-delivery shipment must be performed before
the delivery.
- no more than one pickup alternative or delivery alternative of
a shipment may be performed.
- for all routes, times are increasing (i.e.,
vehicle_start_time
<= visits[0].start_time <= visits[1].start_time ...
<= vehicle_end_time).
- a shipment may only be performed on a vehicle that is allowed. A
vehicle is allowed if
Shipment.allowed_vehicle_indices
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()
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()
public InjectedSolutionConstraintOrBuilder getInjectedSolutionConstraintOrBuilder()
Constrain the optimization algorithm to find a final solution that is
similar to a previous solution. For example, this may be used to freeze
portions of routes which have already been completed or which are to be
completed but must not be modified.
If the injected solution is not feasible, a validation error is not
necessarily returned and an error indicating infeasibility may be returned
instead.
.google.cloud.optimization.v1.InjectedSolutionConstraint injected_solution_constraint = 8;
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()
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()
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 |
int | The maxValidationErrors.
|
getModel()
public ShipmentModel getModel()
Shipment model to solve.
.google.cloud.optimization.v1.ShipmentModel model = 3;
getModelOrBuilder()
public ShipmentModelOrBuilder getModelOrBuilder()
Shipment model to solve.
.google.cloud.optimization.v1.ShipmentModel model = 3;
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.
|
getParserForType()
public Parser<OptimizeToursRequest> getParserForType()
Overrides
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
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 |
boolean | The populateTravelStepPolylines.
|
getRefreshDetailsRoutes(int index)
public ShipmentRoute getRefreshDetailsRoutes(int index)
If non-empty, the given routes will be refreshed, without modifying their
underlying sequence of visits or travel times: only other details will be
updated. This does not solve the model.
As of 2020/11, this only populates the polylines of non-empty routes and
requires that populate_polylines is true.
The route_polyline fields of the passed-in routes may be inconsistent
with route transitions.
This field must not be used together with injected_first_solution_routes
or injected_solution_constraint.
Shipment.ignore and Vehicle.ignore have no effect on the behavior.
Polylines are still populated between all visits in all non-empty routes
regardless of whether the related shipments or vehicles are ignored.
repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;
| Parameter |
|---|
| Name | Description |
index | int
|
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;
| Returns |
|---|
| Type | Description |
int | |
getRefreshDetailsRoutesList()
public List<ShipmentRoute> getRefreshDetailsRoutesList()
If non-empty, the given routes will be refreshed, without modifying their
underlying sequence of visits or travel times: only other details will be
updated. This does not solve the model.
As of 2020/11, this only populates the polylines of non-empty routes and
requires that populate_polylines is true.
The route_polyline fields of the passed-in routes may be inconsistent
with route transitions.
This field must not be used together with injected_first_solution_routes
or injected_solution_constraint.
Shipment.ignore and Vehicle.ignore have no effect on the behavior.
Polylines are still populated between all visits in all non-empty routes
regardless of whether the related shipments or vehicles are ignored.
repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;
getRefreshDetailsRoutesOrBuilder(int index)
public ShipmentRouteOrBuilder getRefreshDetailsRoutesOrBuilder(int index)
If non-empty, the given routes will be refreshed, without modifying their
underlying sequence of visits or travel times: only other details will be
updated. This does not solve the model.
As of 2020/11, this only populates the polylines of non-empty routes and
requires that populate_polylines is true.
The route_polyline fields of the passed-in routes may be inconsistent
with route transitions.
This field must not be used together with injected_first_solution_routes
or injected_solution_constraint.
Shipment.ignore and Vehicle.ignore have no effect on the behavior.
Polylines are still populated between all visits in all non-empty routes
regardless of whether the related shipments or vehicles are ignored.
repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;
| Parameter |
|---|
| Name | Description |
index | int
|
getRefreshDetailsRoutesOrBuilderList()
public List<? extends ShipmentRouteOrBuilder> getRefreshDetailsRoutesOrBuilderList()
If non-empty, the given routes will be refreshed, without modifying their
underlying sequence of visits or travel times: only other details will be
updated. This does not solve the model.
As of 2020/11, this only populates the polylines of non-empty routes and
requires that populate_polylines is true.
The route_polyline fields of the passed-in routes may be inconsistent
with route transitions.
This field must not be used together with injected_first_solution_routes
or injected_solution_constraint.
Shipment.ignore and Vehicle.ignore have no effect on the behavior.
Polylines are still populated between all visits in all non-empty routes
regardless of whether the related shipments or vehicles are ignored.
repeated .google.cloud.optimization.v1.ShipmentRoute refresh_details_routes = 9;
| 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;
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getSolvingMode()
public OptimizeToursRequest.SolvingMode getSolvingMode()
By default, the solving mode is DEFAULT_SOLVE (0).
.google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode solving_mode = 4;
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()
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 |
Duration | The timeout.
|
getTimeoutOrBuilder()
public 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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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;
| 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()
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 |
boolean | Whether the injectedSolutionConstraint field is set.
|
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
field.
This defaults to 100 and is capped at 10,000.
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()
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 |
boolean | Whether the timeout field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public OptimizeToursRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected OptimizeToursRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public OptimizeToursRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
