Constants
RouteOptimization_OptimizeTours_FullMethodName, RouteOptimization_BatchOptimizeTours_FullMethodName, RouteOptimization_OptimizeToursLongRunning_FullMethodName, RouteOptimization_OptimizeToursUri_FullMethodName
const (
RouteOptimization_OptimizeTours_FullMethodName = "/google.maps.routeoptimization.v1.RouteOptimization/OptimizeTours"
RouteOptimization_BatchOptimizeTours_FullMethodName = "/google.maps.routeoptimization.v1.RouteOptimization/BatchOptimizeTours"
RouteOptimization_OptimizeToursLongRunning_FullMethodName = "/google.maps.routeoptimization.v1.RouteOptimization/OptimizeToursLongRunning"
RouteOptimization_OptimizeToursUri_FullMethodName = "/google.maps.routeoptimization.v1.RouteOptimization/OptimizeToursUri"
)Variables
DataFormat_name, DataFormat_value
var (
DataFormat_name = map[int32]string{
0: "DATA_FORMAT_UNSPECIFIED",
1: "JSON",
2: "PROTO_TEXT",
}
DataFormat_value = map[string]int32{
"DATA_FORMAT_UNSPECIFIED": 0,
"JSON": 1,
"PROTO_TEXT": 2,
}
)Enum value maps for DataFormat.
OptimizeToursRequest_SolvingMode_name, OptimizeToursRequest_SolvingMode_value
var (
OptimizeToursRequest_SolvingMode_name = map[int32]string{
0: "DEFAULT_SOLVE",
1: "VALIDATE_ONLY",
2: "DETECT_SOME_INFEASIBLE_SHIPMENTS",
3: "TRANSFORM_AND_RETURN_REQUEST",
}
OptimizeToursRequest_SolvingMode_value = map[string]int32{
"DEFAULT_SOLVE": 0,
"VALIDATE_ONLY": 1,
"DETECT_SOME_INFEASIBLE_SHIPMENTS": 2,
"TRANSFORM_AND_RETURN_REQUEST": 3,
}
)Enum value maps for OptimizeToursRequest_SolvingMode.
OptimizeToursRequest_SearchMode_name, OptimizeToursRequest_SearchMode_value
var (
OptimizeToursRequest_SearchMode_name = map[int32]string{
0: "SEARCH_MODE_UNSPECIFIED",
1: "RETURN_FAST",
2: "CONSUME_ALL_AVAILABLE_TIME",
}
OptimizeToursRequest_SearchMode_value = map[string]int32{
"SEARCH_MODE_UNSPECIFIED": 0,
"RETURN_FAST": 1,
"CONSUME_ALL_AVAILABLE_TIME": 2,
}
)Enum value maps for OptimizeToursRequest_SearchMode.
ShipmentModel_Objective_Type_name, ShipmentModel_Objective_Type_value
var (
ShipmentModel_Objective_Type_name = map[int32]string{
0: "DEFAULT",
10: "MIN_DISTANCE",
11: "MIN_WORKING_TIME",
12: "MIN_TRAVEL_TIME",
13: "MIN_NUM_VEHICLES",
}
ShipmentModel_Objective_Type_value = map[string]int32{
"DEFAULT": 0,
"MIN_DISTANCE": 10,
"MIN_WORKING_TIME": 11,
"MIN_TRAVEL_TIME": 12,
"MIN_NUM_VEHICLES": 13,
}
)Enum value maps for ShipmentModel_Objective_Type.
ShipmentTypeIncompatibility_IncompatibilityMode_name, ShipmentTypeIncompatibility_IncompatibilityMode_value
var (
ShipmentTypeIncompatibility_IncompatibilityMode_name = map[int32]string{
0: "INCOMPATIBILITY_MODE_UNSPECIFIED",
1: "NOT_PERFORMED_BY_SAME_VEHICLE",
2: "NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY",
}
ShipmentTypeIncompatibility_IncompatibilityMode_value = map[string]int32{
"INCOMPATIBILITY_MODE_UNSPECIFIED": 0,
"NOT_PERFORMED_BY_SAME_VEHICLE": 1,
"NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY": 2,
}
)Enum value maps for ShipmentTypeIncompatibility_IncompatibilityMode.
ShipmentTypeRequirement_RequirementMode_name, ShipmentTypeRequirement_RequirementMode_value
var (
ShipmentTypeRequirement_RequirementMode_name = map[int32]string{
0: "REQUIREMENT_MODE_UNSPECIFIED",
1: "PERFORMED_BY_SAME_VEHICLE",
2: "IN_SAME_VEHICLE_AT_PICKUP_TIME",
3: "IN_SAME_VEHICLE_AT_DELIVERY_TIME",
}
ShipmentTypeRequirement_RequirementMode_value = map[string]int32{
"REQUIREMENT_MODE_UNSPECIFIED": 0,
"PERFORMED_BY_SAME_VEHICLE": 1,
"IN_SAME_VEHICLE_AT_PICKUP_TIME": 2,
"IN_SAME_VEHICLE_AT_DELIVERY_TIME": 3,
}
)Enum value maps for ShipmentTypeRequirement_RequirementMode.
Vehicle_TravelMode_name, Vehicle_TravelMode_value
var (
Vehicle_TravelMode_name = map[int32]string{
0: "TRAVEL_MODE_UNSPECIFIED",
1: "DRIVING",
2: "WALKING",
}
Vehicle_TravelMode_value = map[string]int32{
"TRAVEL_MODE_UNSPECIFIED": 0,
"DRIVING": 1,
"WALKING": 2,
}
)Enum value maps for Vehicle_TravelMode.
Vehicle_UnloadingPolicy_name, Vehicle_UnloadingPolicy_value
var (
Vehicle_UnloadingPolicy_name = map[int32]string{
0: "UNLOADING_POLICY_UNSPECIFIED",
1: "LAST_IN_FIRST_OUT",
2: "FIRST_IN_FIRST_OUT",
}
Vehicle_UnloadingPolicy_value = map[string]int32{
"UNLOADING_POLICY_UNSPECIFIED": 0,
"LAST_IN_FIRST_OUT": 1,
"FIRST_IN_FIRST_OUT": 2,
}
)Enum value maps for Vehicle_UnloadingPolicy.
SkippedShipment_Reason_Code_name, SkippedShipment_Reason_Code_value
var (
SkippedShipment_Reason_Code_name = map[int32]string{
0: "CODE_UNSPECIFIED",
1: "NO_VEHICLE",
2: "DEMAND_EXCEEDS_VEHICLE_CAPACITY",
3: "CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT",
4: "CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT",
5: "CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT",
6: "CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS",
7: "VEHICLE_NOT_ALLOWED",
8: "VEHICLE_IGNORED",
9: "SHIPMENT_IGNORED",
10: "SKIPPED_IN_INJECTED_SOLUTION_CONSTRAINT",
11: "VEHICLE_ROUTE_IS_FULLY_SEQUENCE_CONSTRAINED",
13: "ZERO_PENALTY_COST",
}
SkippedShipment_Reason_Code_value = map[string]int32{
"CODE_UNSPECIFIED": 0,
"NO_VEHICLE": 1,
"DEMAND_EXCEEDS_VEHICLE_CAPACITY": 2,
"CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT": 3,
"CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT": 4,
"CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT": 5,
"CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS": 6,
"VEHICLE_NOT_ALLOWED": 7,
"VEHICLE_IGNORED": 8,
"SHIPMENT_IGNORED": 9,
"SKIPPED_IN_INJECTED_SOLUTION_CONSTRAINT": 10,
"VEHICLE_ROUTE_IS_FULLY_SEQUENCE_CONSTRAINED": 11,
"ZERO_PENALTY_COST": 13,
}
)Enum value maps for SkippedShipment_Reason_Code.
InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level_name, InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level_value
var (
InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level_name = map[int32]string{
0: "LEVEL_UNSPECIFIED",
1: "RELAX_VISIT_TIMES_AFTER_THRESHOLD",
2: "RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD",
3: "RELAX_ALL_AFTER_THRESHOLD",
}
InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level_value = map[string]int32{
"LEVEL_UNSPECIFIED": 0,
"RELAX_VISIT_TIMES_AFTER_THRESHOLD": 1,
"RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD": 2,
"RELAX_ALL_AFTER_THRESHOLD": 3,
}
)Enum value maps for InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level.
File_google_maps_routeoptimization_v1_route_optimization_service_proto
var File_google_maps_routeoptimization_v1_route_optimization_service_proto protoreflect.FileDescriptorRouteOptimization_ServiceDesc
var RouteOptimization_ServiceDesc = grpc.ServiceDesc{
ServiceName: "google.maps.routeoptimization.v1.RouteOptimization",
HandlerType: (*RouteOptimizationServer)(nil),
Methods: []grpc.MethodDesc{
{
MethodName: "OptimizeTours",
Handler: _RouteOptimization_OptimizeTours_Handler,
},
{
MethodName: "BatchOptimizeTours",
Handler: _RouteOptimization_BatchOptimizeTours_Handler,
},
{
MethodName: "OptimizeToursLongRunning",
Handler: _RouteOptimization_OptimizeToursLongRunning_Handler,
},
{
MethodName: "OptimizeToursUri",
Handler: _RouteOptimization_OptimizeToursUri_Handler,
},
},
Streams: []grpc.StreamDesc{},
Metadata: "google/maps/routeoptimization/v1/route_optimization_service.proto",
}RouteOptimization_ServiceDesc is the grpc.ServiceDesc for RouteOptimization service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions
func RegisterRouteOptimizationServer
func RegisterRouteOptimizationServer(s grpc.ServiceRegistrar, srv RouteOptimizationServer)AggregatedMetrics
type AggregatedMetrics struct {
// Number of shipments performed. Note that a pickup and delivery pair only
// counts once.
PerformedShipmentCount int32 `protobuf:"varint,1,opt,name=performed_shipment_count,json=performedShipmentCount,proto3" json:"performed_shipment_count,omitempty"`
// Number of mandatory shipments performed.
//
// Experimental: This field's behavior or existence may change in future.
PerformedMandatoryShipmentCount *int32 `protobuf:"varint,12,opt,name=performed_mandatory_shipment_count,json=performedMandatoryShipmentCount,proto3,oneof" json:"performed_mandatory_shipment_count,omitempty"`
// The sum of the
// [Shipment.penalty_cost][google.maps.routeoptimization.v1.Shipment.penalty_cost]
// of the performed shipments.
//
// Experimental: This field's behavior or existence may change in future.
PerformedShipmentPenaltyCostSum *float64 `protobuf:"fixed64,13,opt,name=performed_shipment_penalty_cost_sum,json=performedShipmentPenaltyCostSum,proto3,oneof" json:"performed_shipment_penalty_cost_sum,omitempty"`
// Total travel duration for a route or a solution.
TravelDuration *durationpb.Duration `protobuf:"bytes,2,opt,name=travel_duration,json=travelDuration,proto3" json:"travel_duration,omitempty"`
// Total wait duration for a route or a solution.
WaitDuration *durationpb.Duration `protobuf:"bytes,3,opt,name=wait_duration,json=waitDuration,proto3" json:"wait_duration,omitempty"`
// Total delay duration for a route or a solution.
DelayDuration *durationpb.Duration `protobuf:"bytes,4,opt,name=delay_duration,json=delayDuration,proto3" json:"delay_duration,omitempty"`
// Total break duration for a route or a solution.
BreakDuration *durationpb.Duration `protobuf:"bytes,5,opt,name=break_duration,json=breakDuration,proto3" json:"break_duration,omitempty"`
// Total visit duration for a route or a solution.
VisitDuration *durationpb.Duration `protobuf:"bytes,6,opt,name=visit_duration,json=visitDuration,proto3" json:"visit_duration,omitempty"`
// The total duration should be equal to the sum of all durations above.
// For routes, it also corresponds to:
// ```
// [ShipmentRoute.vehicle_end_time][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_end_time]
// -
// [ShipmentRoute.vehicle_start_time][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_start_time]
// ```
TotalDuration *durationpb.Duration `protobuf:"bytes,7,opt,name=total_duration,json=totalDuration,proto3" json:"total_duration,omitempty"`
// Total travel distance for a route or a solution.
TravelDistanceMeters float64 `protobuf:"fixed64,8,opt,name=travel_distance_meters,json=travelDistanceMeters,proto3" json:"travel_distance_meters,omitempty"`
// Maximum load achieved over the entire route (resp. solution), for each of
// the quantities on this route (resp. solution), computed as the maximum over
// all
// [Transition.vehicle_loads][google.maps.routeoptimization.v1.ShipmentRoute.Transition.vehicle_loads]
// (resp.
// [ShipmentRoute.metrics.max_loads][google.maps.routeoptimization.v1.AggregatedMetrics.max_loads].
MaxLoads map[string]*ShipmentRoute_VehicleLoad `protobuf:"bytes,9,rep,name=max_loads,json=maxLoads,proto3" json:"max_loads,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}Aggregated metrics for [ShipmentRoute][google.maps.routeoptimization.v1.ShipmentRoute] (resp. for [OptimizeToursResponse][google.maps.routeoptimization.v1.OptimizeToursResponse] over all [Transition][google.maps.routeoptimization.v1.ShipmentRoute.Transition] and/or [Visit][google.maps.routeoptimization.v1.ShipmentRoute.Visit] (resp. over all [ShipmentRoute][google.maps.routeoptimization.v1.ShipmentRoute]) elements.
func (*AggregatedMetrics) Descriptor
func (*AggregatedMetrics) Descriptor() ([]byte, []int)Deprecated: Use AggregatedMetrics.ProtoReflect.Descriptor instead.
func (*AggregatedMetrics) GetBreakDuration
func (x *AggregatedMetrics) GetBreakDuration() *durationpb.Durationfunc (*AggregatedMetrics) GetDelayDuration
func (x *AggregatedMetrics) GetDelayDuration() *durationpb.Durationfunc (*AggregatedMetrics) GetMaxLoads
func (x *AggregatedMetrics) GetMaxLoads() map[string]*ShipmentRoute_VehicleLoadfunc (*AggregatedMetrics) GetPerformedMandatoryShipmentCount
func (x *AggregatedMetrics) GetPerformedMandatoryShipmentCount() int32func (*AggregatedMetrics) GetPerformedShipmentCount
func (x *AggregatedMetrics) GetPerformedShipmentCount() int32func (*AggregatedMetrics) GetPerformedShipmentPenaltyCostSum
func (x *AggregatedMetrics) GetPerformedShipmentPenaltyCostSum() float64func (*AggregatedMetrics) GetTotalDuration
func (x *AggregatedMetrics) GetTotalDuration() *durationpb.Durationfunc (*AggregatedMetrics) GetTravelDistanceMeters
func (x *AggregatedMetrics) GetTravelDistanceMeters() float64func (*AggregatedMetrics) GetTravelDuration
func (x *AggregatedMetrics) GetTravelDuration() *durationpb.Durationfunc (*AggregatedMetrics) GetVisitDuration
func (x *AggregatedMetrics) GetVisitDuration() *durationpb.Durationfunc (*AggregatedMetrics) GetWaitDuration
func (x *AggregatedMetrics) GetWaitDuration() *durationpb.Durationfunc (*AggregatedMetrics) ProtoMessage
func (*AggregatedMetrics) ProtoMessage()func (*AggregatedMetrics) ProtoReflect
func (x *AggregatedMetrics) ProtoReflect() protoreflect.Messagefunc (*AggregatedMetrics) Reset
func (x *AggregatedMetrics) Reset()func (*AggregatedMetrics) String
func (x *AggregatedMetrics) String() stringBatchOptimizeToursMetadata
type BatchOptimizeToursMetadata struct {
// contains filtered or unexported fields
}Operation metadata for BatchOptimizeToursRequest calls.
func (*BatchOptimizeToursMetadata) Descriptor
func (*BatchOptimizeToursMetadata) Descriptor() ([]byte, []int)Deprecated: Use BatchOptimizeToursMetadata.ProtoReflect.Descriptor instead.
func (*BatchOptimizeToursMetadata) ProtoMessage
func (*BatchOptimizeToursMetadata) ProtoMessage()func (*BatchOptimizeToursMetadata) ProtoReflect
func (x *BatchOptimizeToursMetadata) ProtoReflect() protoreflect.Messagefunc (*BatchOptimizeToursMetadata) Reset
func (x *BatchOptimizeToursMetadata) Reset()func (*BatchOptimizeToursMetadata) String
func (x *BatchOptimizeToursMetadata) String() stringBatchOptimizeToursRequest
type BatchOptimizeToursRequest struct {
// Required. Target project and location to make a call.
//
// Format:
// * `projects/{project-id}`
// * `projects/{project-id}/locations/{location-id}`
//
// If no location is specified, a region will be chosen automatically.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Input/Output information each purchase model, such as file paths
// and data formats.
ModelConfigs []*BatchOptimizeToursRequest_AsyncModelConfig `protobuf:"bytes,2,rep,name=model_configs,json=modelConfigs,proto3" json:"model_configs,omitempty"`
// contains filtered or unexported fields
}Request to batch optimize tours as an asynchronous operation.
Each input file should contain one OptimizeToursRequest, and each output
file will contain one OptimizeToursResponse. The request contains
information to read/write and parse the files. All the input and output files
should be under the same project.
func (*BatchOptimizeToursRequest) Descriptor
func (*BatchOptimizeToursRequest) Descriptor() ([]byte, []int)Deprecated: Use BatchOptimizeToursRequest.ProtoReflect.Descriptor instead.
func (*BatchOptimizeToursRequest) GetModelConfigs
func (x *BatchOptimizeToursRequest) GetModelConfigs() []*BatchOptimizeToursRequest_AsyncModelConfigfunc (*BatchOptimizeToursRequest) GetParent
func (x *BatchOptimizeToursRequest) GetParent() stringfunc (*BatchOptimizeToursRequest) ProtoMessage
func (*BatchOptimizeToursRequest) ProtoMessage()func (*BatchOptimizeToursRequest) ProtoReflect
func (x *BatchOptimizeToursRequest) ProtoReflect() protoreflect.Messagefunc (*BatchOptimizeToursRequest) Reset
func (x *BatchOptimizeToursRequest) Reset()func (*BatchOptimizeToursRequest) String
func (x *BatchOptimizeToursRequest) String() stringBatchOptimizeToursRequest_AsyncModelConfig
type BatchOptimizeToursRequest_AsyncModelConfig struct {
// Optional. User defined model name, can be used as alias by users to keep
// track of models.
DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Required. Information about the input model.
InputConfig *InputConfig `protobuf:"bytes,2,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
// Required. The desired output location information.
OutputConfig *OutputConfig `protobuf:"bytes,3,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
// contains filtered or unexported fields
}Information for solving one optimization model asynchronously.
func (*BatchOptimizeToursRequest_AsyncModelConfig) Descriptor
func (*BatchOptimizeToursRequest_AsyncModelConfig) Descriptor() ([]byte, []int)Deprecated: Use BatchOptimizeToursRequest_AsyncModelConfig.ProtoReflect.Descriptor instead.
func (*BatchOptimizeToursRequest_AsyncModelConfig) GetDisplayName
func (x *BatchOptimizeToursRequest_AsyncModelConfig) GetDisplayName() stringfunc (*BatchOptimizeToursRequest_AsyncModelConfig) GetInputConfig
func (x *BatchOptimizeToursRequest_AsyncModelConfig) GetInputConfig() *InputConfigfunc (*BatchOptimizeToursRequest_AsyncModelConfig) GetOutputConfig
func (x *BatchOptimizeToursRequest_AsyncModelConfig) GetOutputConfig() *OutputConfigfunc (*BatchOptimizeToursRequest_AsyncModelConfig) ProtoMessage
func (*BatchOptimizeToursRequest_AsyncModelConfig) ProtoMessage()func (*BatchOptimizeToursRequest_AsyncModelConfig) ProtoReflect
func (x *BatchOptimizeToursRequest_AsyncModelConfig) ProtoReflect() protoreflect.Messagefunc (*BatchOptimizeToursRequest_AsyncModelConfig) Reset
func (x *BatchOptimizeToursRequest_AsyncModelConfig) Reset()func (*BatchOptimizeToursRequest_AsyncModelConfig) String
func (x *BatchOptimizeToursRequest_AsyncModelConfig) String() stringBatchOptimizeToursResponse
type BatchOptimizeToursResponse struct {
// contains filtered or unexported fields
}Response to a BatchOptimizeToursRequest. This is returned in
the Long Running Operation after the operation is complete.
func (*BatchOptimizeToursResponse) Descriptor
func (*BatchOptimizeToursResponse) Descriptor() ([]byte, []int)Deprecated: Use BatchOptimizeToursResponse.ProtoReflect.Descriptor instead.
func (*BatchOptimizeToursResponse) ProtoMessage
func (*BatchOptimizeToursResponse) ProtoMessage()func (*BatchOptimizeToursResponse) ProtoReflect
func (x *BatchOptimizeToursResponse) ProtoReflect() protoreflect.Messagefunc (*BatchOptimizeToursResponse) Reset
func (x *BatchOptimizeToursResponse) Reset()func (*BatchOptimizeToursResponse) String
func (x *BatchOptimizeToursResponse) String() stringBreakRule
type BreakRule struct {
// Sequence of breaks. See the `BreakRequest` message.
BreakRequests []*BreakRule_BreakRequest `protobuf:"bytes,1,rep,name=break_requests,json=breakRequests,proto3" json:"break_requests,omitempty"`
// Several `FrequencyConstraint` may apply. They must all be satisfied by
// the `BreakRequest`s of this `BreakRule`. See `FrequencyConstraint`.
FrequencyConstraints []*BreakRule_FrequencyConstraint `protobuf:"bytes,2,rep,name=frequency_constraints,json=frequencyConstraints,proto3" json:"frequency_constraints,omitempty"`
// contains filtered or unexported fields
}Rules to generate time breaks for a vehicle (e.g. lunch breaks). A break is a contiguous period of time during which the vehicle remains idle at its current position and cannot perform any visit. A break may occur:
- during the travel between two visits (which includes the time right before or right after a visit, but not in the middle of a visit), in which case it extends the corresponding transit time between the visits,
- or before the vehicle start (the vehicle may not start in the middle of a break), in which case it does not affect the vehicle start time.
- or after the vehicle end (ditto, with the vehicle end time).
func (*BreakRule) Descriptor
Deprecated: Use BreakRule.ProtoReflect.Descriptor instead.
func (*BreakRule) GetBreakRequests
func (x *BreakRule) GetBreakRequests() []*BreakRule_BreakRequestfunc (*BreakRule) GetFrequencyConstraints
func (x *BreakRule) GetFrequencyConstraints() []*BreakRule_FrequencyConstraintfunc (*BreakRule) ProtoMessage
func (*BreakRule) ProtoMessage()func (*BreakRule) ProtoReflect
func (x *BreakRule) ProtoReflect() protoreflect.Messagefunc (*BreakRule) Reset
func (x *BreakRule) Reset()func (*BreakRule) String
BreakRule_BreakRequest
type BreakRule_BreakRequest struct {
// Required. Lower bound (inclusive) on the start of the break.
EarliestStartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=earliest_start_time,json=earliestStartTime,proto3" json:"earliest_start_time,omitempty"`
// Required. Upper bound (inclusive) on the start of the break.
LatestStartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=latest_start_time,json=latestStartTime,proto3" json:"latest_start_time,omitempty"`
// Required. Minimum duration of the break. Must be positive.
MinDuration *durationpb.Duration `protobuf:"bytes,3,opt,name=min_duration,json=minDuration,proto3" json:"min_duration,omitempty"`
// contains filtered or unexported fields
}The sequence of breaks (i.e. their number and order) that apply to each
vehicle must be known beforehand. The repeated BreakRequests define
that sequence, in the order in which they must occur. Their time windows
(earliest_start_time / latest_start_time) may overlap, but they must
be compatible with the order (this is checked).
func (*BreakRule_BreakRequest) Descriptor
func (*BreakRule_BreakRequest) Descriptor() ([]byte, []int)Deprecated: Use BreakRule_BreakRequest.ProtoReflect.Descriptor instead.
func (*BreakRule_BreakRequest) GetEarliestStartTime
func (x *BreakRule_BreakRequest) GetEarliestStartTime() *timestamppb.Timestampfunc (*BreakRule_BreakRequest) GetLatestStartTime
func (x *BreakRule_BreakRequest) GetLatestStartTime() *timestamppb.Timestampfunc (*BreakRule_BreakRequest) GetMinDuration
func (x *BreakRule_BreakRequest) GetMinDuration() *durationpb.Durationfunc (*BreakRule_BreakRequest) ProtoMessage
func (*BreakRule_BreakRequest) ProtoMessage()func (*BreakRule_BreakRequest) ProtoReflect
func (x *BreakRule_BreakRequest) ProtoReflect() protoreflect.Messagefunc (*BreakRule_BreakRequest) Reset
func (x *BreakRule_BreakRequest) Reset()func (*BreakRule_BreakRequest) String
func (x *BreakRule_BreakRequest) String() stringBreakRule_FrequencyConstraint
type BreakRule_FrequencyConstraint struct {
// Required. Minimum break duration for this constraint. Nonnegative.
// See description of `FrequencyConstraint`.
MinBreakDuration *durationpb.Duration `protobuf:"bytes,1,opt,name=min_break_duration,json=minBreakDuration,proto3" json:"min_break_duration,omitempty"`
// Required. Maximum allowed span of any interval of time in the route that
// does not include at least partially a break of `duration >=
// min_break_duration`. Must be positive.
MaxInterBreakDuration *durationpb.Duration `protobuf:"bytes,2,opt,name=max_inter_break_duration,json=maxInterBreakDuration,proto3" json:"max_inter_break_duration,omitempty"`
// contains filtered or unexported fields
}One may further constrain the frequency and duration of the breaks
specified above, by enforcing a minimum break frequency, such as
"There must be a break of at least 1 hour every 12 hours". Assuming that
this can be interpreted as "Within any sliding time window of 12h, there
must be at least one break of at least one hour", that example would
translate to the following FrequencyConstraint:
{
min_break_duration { seconds: 3600 } # 1 hour.
max_inter_break_duration { seconds: 39600 } # 11 hours (12 - 1 = 11).
}
The timing and duration of the breaks in the solution will respect all
such constraints, in addition to the time windows and minimum durations
already specified in the BreakRequest.
A FrequencyConstraint may in practice apply to non-consecutive breaks.
For example, the following schedule honors the "1h every 12h" example:
04:00 vehicle start
.. performing travel and visits ..
09:00 1 hour break
10:00 end of the break
.. performing travel and visits ..
12:00 20-min lunch break
12:20 end of the break
.. performing travel and visits ..
21:00 1 hour break
22:00 end of the break
.. performing travel and visits ..
23:59 vehicle end
func (*BreakRule_FrequencyConstraint) Descriptor
func (*BreakRule_FrequencyConstraint) Descriptor() ([]byte, []int)Deprecated: Use BreakRule_FrequencyConstraint.ProtoReflect.Descriptor instead.
func (*BreakRule_FrequencyConstraint) GetMaxInterBreakDuration
func (x *BreakRule_FrequencyConstraint) GetMaxInterBreakDuration() *durationpb.Durationfunc (*BreakRule_FrequencyConstraint) GetMinBreakDuration
func (x *BreakRule_FrequencyConstraint) GetMinBreakDuration() *durationpb.Durationfunc (*BreakRule_FrequencyConstraint) ProtoMessage
func (*BreakRule_FrequencyConstraint) ProtoMessage()func (*BreakRule_FrequencyConstraint) ProtoReflect
func (x *BreakRule_FrequencyConstraint) ProtoReflect() protoreflect.Messagefunc (*BreakRule_FrequencyConstraint) Reset
func (x *BreakRule_FrequencyConstraint) Reset()func (*BreakRule_FrequencyConstraint) String
func (x *BreakRule_FrequencyConstraint) String() stringDataFormat
type DataFormat int32Data formats for input and output files.
DataFormat_DATA_FORMAT_UNSPECIFIED, DataFormat_JSON, DataFormat_PROTO_TEXT
const (
// Invalid value, format must not be UNSPECIFIED.
DataFormat_DATA_FORMAT_UNSPECIFIED DataFormat = 0
// JavaScript Object Notation.
DataFormat_JSON DataFormat = 1
// Protocol Buffers text format. See
// https://protobuf.dev/reference/protobuf/textformat-spec/
DataFormat_PROTO_TEXT DataFormat = 2
)func (DataFormat) Descriptor
func (DataFormat) Descriptor() protoreflect.EnumDescriptorfunc (DataFormat) Enum
func (x DataFormat) Enum() *DataFormatfunc (DataFormat) EnumDescriptor
func (DataFormat) EnumDescriptor() ([]byte, []int)Deprecated: Use DataFormat.Descriptor instead.
func (DataFormat) Number
func (x DataFormat) Number() protoreflect.EnumNumberfunc (DataFormat) String
func (x DataFormat) String() stringfunc (DataFormat) Type
func (DataFormat) Type() protoreflect.EnumTypeDistanceLimit
type DistanceLimit struct {
// A hard limit constraining the distance to be at most max_meters. The limit
// must be nonnegative.
MaxMeters *int64 `protobuf:"varint,1,opt,name=max_meters,json=maxMeters,proto3,oneof" json:"max_meters,omitempty"`
// A soft limit not enforcing a maximum distance limit, but when violated
// results in a cost which adds up to other costs defined in the model,
// with the same unit.
//
// If defined soft_max_meters must be less than max_meters and must be
// nonnegative.
SoftMaxMeters *int64 `protobuf:"varint,2,opt,name=soft_max_meters,json=softMaxMeters,proto3,oneof" json:"soft_max_meters,omitempty"`
// Cost per kilometer incurred, increasing up to `soft_max_meters`, with
// formula:
// ```
//
// min(distance_meters, soft_max_meters) / 1000.0 *
// cost_per_kilometer_below_soft_max.
//
// ```
// This cost is not supported in `route_distance_limit`.
CostPerKilometerBelowSoftMax *float64 `protobuf:"fixed64,4,opt,name=cost_per_kilometer_below_soft_max,json=costPerKilometerBelowSoftMax,proto3,oneof" json:"cost_per_kilometer_below_soft_max,omitempty"`
// Cost per kilometer incurred if distance is above `soft_max_meters` limit.
// The additional cost is 0 if the distance is under the limit, otherwise the
// formula used to compute the cost is the following:
// ```
//
// (distance_meters - soft_max_meters) / 1000.0 *
// cost_per_kilometer_above_soft_max.
//
// ```
// The cost must be nonnegative.
CostPerKilometerAboveSoftMax *float64 `protobuf:"fixed64,3,opt,name=cost_per_kilometer_above_soft_max,json=costPerKilometerAboveSoftMax,proto3,oneof" json:"cost_per_kilometer_above_soft_max,omitempty"`
// contains filtered or unexported fields
}A limit defining a maximum distance which can be traveled. It can be either hard or soft.
If a soft limit is defined, both soft_max_meters and
cost_per_kilometer_above_soft_max must be defined and be nonnegative.
func (*DistanceLimit) Descriptor
func (*DistanceLimit) Descriptor() ([]byte, []int)Deprecated: Use DistanceLimit.ProtoReflect.Descriptor instead.
func (*DistanceLimit) GetCostPerKilometerAboveSoftMax
func (x *DistanceLimit) GetCostPerKilometerAboveSoftMax() float64func (*DistanceLimit) GetCostPerKilometerBelowSoftMax
func (x *DistanceLimit) GetCostPerKilometerBelowSoftMax() float64func (*DistanceLimit) GetMaxMeters
func (x *DistanceLimit) GetMaxMeters() int64func (*DistanceLimit) GetSoftMaxMeters
func (x *DistanceLimit) GetSoftMaxMeters() int64func (*DistanceLimit) ProtoMessage
func (*DistanceLimit) ProtoMessage()func (*DistanceLimit) ProtoReflect
func (x *DistanceLimit) ProtoReflect() protoreflect.Messagefunc (*DistanceLimit) Reset
func (x *DistanceLimit) Reset()func (*DistanceLimit) String
func (x *DistanceLimit) String() stringGcsDestination
type GcsDestination struct {
// Required. Google Cloud Storage URI.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// contains filtered or unexported fields
}The Google Cloud Storage location where the output file(s) will be written to.
func (*GcsDestination) Descriptor
func (*GcsDestination) Descriptor() ([]byte, []int)Deprecated: Use GcsDestination.ProtoReflect.Descriptor instead.
func (*GcsDestination) GetUri
func (x *GcsDestination) GetUri() stringfunc (*GcsDestination) ProtoMessage
func (*GcsDestination) ProtoMessage()func (*GcsDestination) ProtoReflect
func (x *GcsDestination) ProtoReflect() protoreflect.Messagefunc (*GcsDestination) Reset
func (x *GcsDestination) Reset()func (*GcsDestination) String
func (x *GcsDestination) String() stringGcsSource
type GcsSource struct {
// Required. URI of a Google Cloud Storage object with the format
// `gs://bucket/path/to/object`.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// contains filtered or unexported fields
}The Google Cloud Storage location where the input file will be read from.
func (*GcsSource) Descriptor
Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.
func (*GcsSource) GetUri
func (*GcsSource) ProtoMessage
func (*GcsSource) ProtoMessage()func (*GcsSource) ProtoReflect
func (x *GcsSource) ProtoReflect() protoreflect.Messagefunc (*GcsSource) Reset
func (x *GcsSource) Reset()func (*GcsSource) String
InjectedSolutionConstraint
type InjectedSolutionConstraint struct {
// Routes of the solution to inject. Some routes may be omitted from the
// original solution. The routes and skipped shipments must satisfy the basic
// validity assumptions listed for `injected_first_solution_routes`.
Routes []*ShipmentRoute `protobuf:"bytes,1,rep,name=routes,proto3" json:"routes,omitempty"`
// Skipped shipments of the solution to inject. Some may be omitted from the
// original solution. See the `routes` field.
SkippedShipments []*SkippedShipment `protobuf:"bytes,2,rep,name=skipped_shipments,json=skippedShipments,proto3" json:"skipped_shipments,omitempty"`
// For zero or more groups of vehicles, specifies when and how much to relax
// constraints. If this field is empty, all non-empty vehicle routes are
// fully constrained.
ConstraintRelaxations []*InjectedSolutionConstraint_ConstraintRelaxation `protobuf:"bytes,3,rep,name=constraint_relaxations,json=constraintRelaxations,proto3" json:"constraint_relaxations,omitempty"`
// contains filtered or unexported fields
}Solution injected in the request including information about which visits must be constrained and how they must be constrained.
func (*InjectedSolutionConstraint) Descriptor
func (*InjectedSolutionConstraint) Descriptor() ([]byte, []int)Deprecated: Use InjectedSolutionConstraint.ProtoReflect.Descriptor instead.
func (*InjectedSolutionConstraint) GetConstraintRelaxations
func (x *InjectedSolutionConstraint) GetConstraintRelaxations() []*InjectedSolutionConstraint_ConstraintRelaxationfunc (*InjectedSolutionConstraint) GetRoutes
func (x *InjectedSolutionConstraint) GetRoutes() []*ShipmentRoutefunc (*InjectedSolutionConstraint) GetSkippedShipments
func (x *InjectedSolutionConstraint) GetSkippedShipments() []*SkippedShipmentfunc (*InjectedSolutionConstraint) ProtoMessage
func (*InjectedSolutionConstraint) ProtoMessage()func (*InjectedSolutionConstraint) ProtoReflect
func (x *InjectedSolutionConstraint) ProtoReflect() protoreflect.Messagefunc (*InjectedSolutionConstraint) Reset
func (x *InjectedSolutionConstraint) Reset()func (*InjectedSolutionConstraint) String
func (x *InjectedSolutionConstraint) String() stringInjectedSolutionConstraint_ConstraintRelaxation
type InjectedSolutionConstraint_ConstraintRelaxation struct {
// All the visit constraint relaxations that will apply to visits on
// routes with vehicles in `vehicle_indices`.
Relaxations []*InjectedSolutionConstraint_ConstraintRelaxation_Relaxation `protobuf:"bytes,1,rep,name=relaxations,proto3" json:"relaxations,omitempty"`
// Specifies the vehicle indices to which the visit constraint
// `relaxations` apply. If empty, this is considered the default and the
// `relaxations` apply to all vehicles that are not specified in other
// `constraint_relaxations`. There can be at most one default, i.e., at
// most one constraint relaxation field is allowed empty
// `vehicle_indices`. A vehicle index can only be listed once, even within
// several `constraint_relaxations`.
//
// A vehicle index is mapped the same as
// [ShipmentRoute.vehicle_index][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_index],
// if `interpret_injected_solutions_using_labels` is true (see `fields`
// comment).
VehicleIndices []int32 `protobuf:"varint,2,rep,packed,name=vehicle_indices,json=vehicleIndices,proto3" json:"vehicle_indices,omitempty"`
// contains filtered or unexported fields
}For a group of vehicles, specifies at what threshold(s) constraints on
visits will be relaxed and to which level. Shipments listed in
the skipped_shipment field are constrained to be skipped; i.e., they
cannot be performed.
func (*InjectedSolutionConstraint_ConstraintRelaxation) Descriptor
func (*InjectedSolutionConstraint_ConstraintRelaxation) Descriptor() ([]byte, []int)Deprecated: Use InjectedSolutionConstraint_ConstraintRelaxation.ProtoReflect.Descriptor instead.
func (*InjectedSolutionConstraint_ConstraintRelaxation) GetRelaxations
func (x *InjectedSolutionConstraint_ConstraintRelaxation) GetRelaxations() []*InjectedSolutionConstraint_ConstraintRelaxation_Relaxationfunc (*InjectedSolutionConstraint_ConstraintRelaxation) GetVehicleIndices
func (x *InjectedSolutionConstraint_ConstraintRelaxation) GetVehicleIndices() []int32func (*InjectedSolutionConstraint_ConstraintRelaxation) ProtoMessage
func (*InjectedSolutionConstraint_ConstraintRelaxation) ProtoMessage()func (*InjectedSolutionConstraint_ConstraintRelaxation) ProtoReflect
func (x *InjectedSolutionConstraint_ConstraintRelaxation) ProtoReflect() protoreflect.Messagefunc (*InjectedSolutionConstraint_ConstraintRelaxation) Reset
func (x *InjectedSolutionConstraint_ConstraintRelaxation) Reset()func (*InjectedSolutionConstraint_ConstraintRelaxation) String
func (x *InjectedSolutionConstraint_ConstraintRelaxation) String() stringInjectedSolutionConstraint_ConstraintRelaxation_Relaxation
type InjectedSolutionConstraint_ConstraintRelaxation_Relaxation struct {
// The constraint relaxation level that applies when the conditions
// at or after `threshold_time` AND at least `threshold_visit_count` are
// satisfied.
Level InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level `protobuf:"varint,1,opt,name=level,proto3,enum=google.maps.routeoptimization.v1.InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level" json:"level,omitempty"`
// The time at or after which the relaxation `level` may be applied.
ThresholdTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=threshold_time,json=thresholdTime,proto3" json:"threshold_time,omitempty"`
// The number of visits at or after which the relaxation `level` may be
// applied. If `threshold_visit_count` is 0 (or unset), the `level` may be
// applied directly at the vehicle start.
//
// If it is `route.visits_size() + 1`, the `level` may only be applied to
// the vehicle end. If it is more than `route.visits_size() + 1`,
// `level` is not applied at all for that route.
ThresholdVisitCount int32 `protobuf:"varint,3,opt,name=threshold_visit_count,json=thresholdVisitCount,proto3" json:"threshold_visit_count,omitempty"`
// contains filtered or unexported fields
}If relaxations is empty, the start time and sequence of all visits
on routes are fully constrained and no new visits may be inserted or
added to those routes. Also, a vehicle's start and end time in
routes is fully constrained, unless the vehicle is empty (i.e., has no
visits and has used_if_route_is_empty set to false in the model).
relaxations(i).level specifies the constraint relaxation level applied
to a visit #j that satisfies:
route.visits(j).start_time >= relaxations(i).threshold_timeANDj + 1 >= relaxations(i).threshold_visit_count
Similarly, the vehicle start is relaxed to relaxations(i).level if it
satisfies:
vehicle_start_time >= relaxations(i).threshold_timeANDrelaxations(i).threshold_visit_count == 0
and the vehicle end is relaxed to relaxations(i).level if it satisfies:
vehicle_end_time >= relaxations(i).threshold_timeANDroute.visits_size() + 1 >= relaxations(i).threshold_visit_count
To apply a relaxation level if a visit meets the threshold_visit_count
OR the threshold_time add two relaxations with the same level:
one with only threshold_visit_count set and the other with only
threshold_time set. If a visit satisfies the conditions of multiple
relaxations, the most relaxed level applies. As a result, from the
vehicle start through the route visits in order to the vehicle end, the
relaxation level becomes more relaxed: i.e., the relaxation level is
non-decreasing as the route progresses.
The timing and sequence of route visits that do not satisfy the
threshold conditions of any relaxations are fully constrained
and no visits may be inserted into these sequences. Also, if a
vehicle start or end does not satisfy the conditions of any
relaxation the time is fixed, unless the vehicle is empty.
func (*InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) Descriptor
func (*InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) Descriptor() ([]byte, []int)Deprecated: Use InjectedSolutionConstraint_ConstraintRelaxation_Relaxation.ProtoReflect.Descriptor instead.
func (*InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) GetLevel
func (x *InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) GetLevel() InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Levelfunc (*InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) GetThresholdTime
func (x *InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) GetThresholdTime() *timestamppb.Timestampfunc (*InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) GetThresholdVisitCount
func (x *InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) GetThresholdVisitCount() int32func (*InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) ProtoMessage
func (*InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) ProtoMessage()func (*InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) ProtoReflect
func (x *InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) ProtoReflect() protoreflect.Messagefunc (*InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) Reset
func (x *InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) Reset()func (*InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) String
func (x *InjectedSolutionConstraint_ConstraintRelaxation_Relaxation) String() stringInjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level
type InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level int32Expresses the different constraint relaxation levels, which are applied for a visit and those that follow when it satisfies the threshold conditions.
The enumeration below is in order of increasing relaxation.
InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_LEVEL_UNSPECIFIED, InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_RELAX_VISIT_TIMES_AFTER_THRESHOLD, InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD, InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_RELAX_ALL_AFTER_THRESHOLD
const (
// Implicit default relaxation level: no constraints are relaxed,
// i.e., all visits are fully constrained.
//
// This value must not be explicitly used in `level`.
InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_LEVEL_UNSPECIFIED InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level = 0
// Visit start times and vehicle start/end times will be relaxed, but
// each visit remains bound to the same vehicle and the visit sequence
// must be observed: no visit can be inserted between them or before
// them.
InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_RELAX_VISIT_TIMES_AFTER_THRESHOLD InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level = 1
// Same as `RELAX_VISIT_TIMES_AFTER_THRESHOLD`, but the visit sequence
// is also relaxed: visits can only be performed by this vehicle, but
// can potentially become unperformed.
InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level = 2
// Same as `RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD`, but the
// vehicle is also relaxed: visits are completely free at or after the
// threshold time and can potentially become unperformed.
InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_RELAX_ALL_AFTER_THRESHOLD InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level = 3
)func (InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level) Descriptor
func (InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level) Descriptor() protoreflect.EnumDescriptorfunc (InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level) Enum
func (x InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level) Enum() *InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Levelfunc (InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level) EnumDescriptor
func (InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level) EnumDescriptor() ([]byte, []int)Deprecated: Use InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level.Descriptor instead.
func (InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level) Number
func (x InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level) Number() protoreflect.EnumNumberfunc (InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level) String
func (x InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level) String() stringfunc (InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level) Type
func (InjectedSolutionConstraint_ConstraintRelaxation_Relaxation_Level) Type() protoreflect.EnumTypeInputConfig
type InputConfig struct {
// Required.
//
// Types that are assignable to Source:
//
// *InputConfig_GcsSource
Source isInputConfig_Source `protobuf_oneof:"source"`
// Required. The input data format.
DataFormat DataFormat `protobuf:"varint,2,opt,name=data_format,json=dataFormat,proto3,enum=google.maps.routeoptimization.v1.DataFormat" json:"data_format,omitempty"`
// contains filtered or unexported fields
}Specify an input for [BatchOptimizeTours][google.maps.routeoptimization.v1.RouteOptimizationService.BatchOptimizeTours].
func (*InputConfig) Descriptor
func (*InputConfig) Descriptor() ([]byte, []int)Deprecated: Use InputConfig.ProtoReflect.Descriptor instead.
func (*InputConfig) GetDataFormat
func (x *InputConfig) GetDataFormat() DataFormatfunc (*InputConfig) GetGcsSource
func (x *InputConfig) GetGcsSource() *GcsSourcefunc (*InputConfig) GetSource
func (m *InputConfig) GetSource() isInputConfig_Sourcefunc (*InputConfig) ProtoMessage
func (*InputConfig) ProtoMessage()func (*InputConfig) ProtoReflect
func (x *InputConfig) ProtoReflect() protoreflect.Messagefunc (*InputConfig) Reset
func (x *InputConfig) Reset()func (*InputConfig) String
func (x *InputConfig) String() stringInputConfig_GcsSource
type InputConfig_GcsSource struct {
// A Google Cloud Storage location. This must be a single object (file).
GcsSource *GcsSource `protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}Location
type Location struct {
// The waypoint's geographic coordinates.
LatLng *latlng.LatLng `protobuf:"bytes,1,opt,name=lat_lng,json=latLng,proto3" json:"lat_lng,omitempty"`
// The compass heading associated with the direction of the flow of traffic.
// This value is used to specify the side of the road to use for pickup and
// drop-off. Heading values can be from 0 to 360, where 0 specifies a heading
// of due North, 90 specifies a heading of due East, etc.
Heading *int32 `protobuf:"varint,2,opt,name=heading,proto3,oneof" json:"heading,omitempty"`
// contains filtered or unexported fields
}Encapsulates a location (a geographic point, and an optional heading).
func (*Location) Descriptor
Deprecated: Use Location.ProtoReflect.Descriptor instead.
func (*Location) GetHeading
func (*Location) GetLatLng
func (*Location) ProtoMessage
func (*Location) ProtoMessage()func (*Location) ProtoReflect
func (x *Location) ProtoReflect() protoreflect.Messagefunc (*Location) Reset
func (x *Location) Reset()func (*Location) String
OptimizeToursLongRunningMetadata
type OptimizeToursLongRunningMetadata struct {
// contains filtered or unexported fields
}Operation metadata for OptimizeToursLongRunning calls.
func (*OptimizeToursLongRunningMetadata) Descriptor
func (*OptimizeToursLongRunningMetadata) Descriptor() ([]byte, []int)Deprecated: Use OptimizeToursLongRunningMetadata.ProtoReflect.Descriptor instead.
func (*OptimizeToursLongRunningMetadata) ProtoMessage
func (*OptimizeToursLongRunningMetadata) ProtoMessage()func (*OptimizeToursLongRunningMetadata) ProtoReflect
func (x *OptimizeToursLongRunningMetadata) ProtoReflect() protoreflect.Messagefunc (*OptimizeToursLongRunningMetadata) Reset
func (x *OptimizeToursLongRunningMetadata) Reset()func (*OptimizeToursLongRunningMetadata) String
func (x *OptimizeToursLongRunningMetadata) String() stringOptimizeToursRequest
type OptimizeToursRequest struct {
// Required. Target project or location to make a call.
//
// Format:
// * `projects/{project-id}`
// * `projects/{project-id}/locations/{location-id}`
//
// If no location is specified, a region will be chosen automatically.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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.
Timeout *durationpb.Duration `protobuf:"bytes,2,opt,name=timeout,proto3" json:"timeout,omitempty"`
// Shipment model to solve.
Model *ShipmentModel `protobuf:"bytes,3,opt,name=model,proto3" json:"model,omitempty"`
// By default, the solving mode is `DEFAULT_SOLVE` (0).
SolvingMode OptimizeToursRequest_SolvingMode `protobuf:"varint,4,opt,name=solving_mode,json=solvingMode,proto3,enum=google.maps.routeoptimization.v1.OptimizeToursRequest_SolvingMode" json:"solving_mode,omitempty"`
// Search mode used to solve the request.
SearchMode OptimizeToursRequest_SearchMode `protobuf:"varint,6,opt,name=search_mode,json=searchMode,proto3,enum=google.maps.routeoptimization.v1.OptimizeToursRequest_SearchMode" json:"search_mode,omitempty"`
// Guide the optimization algorithm in finding a first solution that is
// similar to a previous solution.
//
// The model is constrained when the first solution is built.
// Any shipments not performed on a route are implicitly skipped in the first
// solution, but they may be performed in successive solutions.
//
// The solution must satisfy some basic validity assumptions:
//
// - for all routes, `vehicle_index` must be in range and not be duplicated.
// - for all visits, `shipment_index` and `visit_request_index` must be
// in range.
// - a shipment may only be referenced on one route.
// - the pickup of a pickup-delivery shipment must be performed before
// the delivery.
// - no more than one pickup alternative or delivery alternative of
// a shipment may be performed.
// - for all routes, times are increasing (i.e., `vehicle_start_time
// <= visits[0].start_time=""><= visits[1].start_time="" ...=""><= vehicle_end_time`).="" -="" a="" shipment="" may="" only="" be="" performed="" on="" a="" vehicle="" that="" is="" allowed.="" a="" vehicle="" is="" allowed="" if="" [shipment.allowed_vehicle_indices][google.maps.routeoptimization.v1.shipment.allowed_vehicle_indices]="" is="" empty="" or="" its="" `vehicle_index`="" is="" included="" in="" [shipment.allowed_vehicle_indices][google.maps.routeoptimization.v1.shipment.allowed_vehicle_indices].="" if="" the="" injected="" solution="" is="" not="" feasible,="" a="" validation="" error="" is="" not="" necessarily="" returned="" and="" an="" error="" indicating="" infeasibility="" may="" be="" returned="" instead.="" injectedfirstsolutionroutes="">ShipmentRoute `protobuf:"bytes,7,rep,name=injected_first_solution_routes,json=injectedFirstSolutionRoutes,proto3" json:"injected_first_solution_routes,omitempty"`
// 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.
InjectedSolutionConstraint *InjectedSolutionConstraint `protobuf:"bytes,8,opt,name=injected_solution_constraint,json=injectedSolutionConstraint,proto3" json:"injected_solution_constraint,omitempty"`
// 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.
RefreshDetailsRoutes []*ShipmentRoute `protobuf:"bytes,9,rep,name=refresh_details_routes,json=refreshDetailsRoutes,proto3" json:"refresh_details_routes,omitempty"`
// If true:
//
// - uses
// [ShipmentRoute.vehicle_label][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_label]
// instead of `vehicle_index` to
// match routes in an injected solution with vehicles in the request;
// reuses the mapping of original
// [ShipmentRoute.vehicle_index][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_index]
// to new
// [ShipmentRoute.vehicle_index][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_index]
// to update
// [ConstraintRelaxation.vehicle_indices][google.maps.routeoptimization.v1.InjectedSolutionConstraint.ConstraintRelaxation.vehicle_indices]
// if non-empty, but the mapping must be unambiguous (i.e., multiple
// `ShipmentRoute`s must not share the same original `vehicle_index`).
// - uses
// [ShipmentRoute.Visit.shipment_label][google.maps.routeoptimization.v1.ShipmentRoute.Visit.shipment_label]
// instead of `shipment_index`
// to match visits in an injected solution with shipments in the request;
// - uses
// [SkippedShipment.label][google.maps.routeoptimization.v1.SkippedShipment.label]
// instead of
// [SkippedShipment.index][google.maps.routeoptimization.v1.SkippedShipment.index]
// to
// match skipped shipments in the injected solution with request
// shipments.
//
// This interpretation applies to the `injected_first_solution_routes`,
// `injected_solution_constraint`, and `refresh_details_routes` fields.
// It can be used when shipment or vehicle indices in the request have
// changed since the solution was created, perhaps because shipments or
// vehicles have been removed from or added to the request.
//
// If true, labels in the following categories must appear at most once in
// their category:
//
// - [Vehicle.label][google.maps.routeoptimization.v1.Vehicle.label] in the
// request;
// - [Shipment.label][google.maps.routeoptimization.v1.Shipment.label] in
// the request;
// - [ShipmentRoute.vehicle_label][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_label] in the injected solution;
// - [SkippedShipment.label][google.maps.routeoptimization.v1.SkippedShipment.label] and [ShipmentRoute.Visit.shipment_label][google.maps.routeoptimization.v1.ShipmentRoute.Visit.shipment_label] in
// the injected solution (except pickup/delivery visit pairs, whose
// `shipment_label` must appear twice).
//
// If a `vehicle_label` in the injected solution does not correspond to a
// request vehicle, the corresponding route is removed from the solution
// along with its visits. If a `shipment_label` in the injected solution does
// not correspond to a request shipment, the corresponding visit is removed
// from the solution. If a
// [SkippedShipment.label][google.maps.routeoptimization.v1.SkippedShipment.label]
// in the injected solution does not correspond to a request shipment, the
// `SkippedShipment` is removed from the solution.
//
// Removing route visits or entire routes from an injected solution may
// have an effect on the implied constraints, which may lead to change in
// solution, validation errors, or infeasibility.
//
// NOTE: The caller must ensure that each
// [Vehicle.label][google.maps.routeoptimization.v1.Vehicle.label] (resp.
// [Shipment.label][google.maps.routeoptimization.v1.Shipment.label]) uniquely
// identifies a vehicle (resp. shipment) entity used across the two relevant
// requests: the past request that produced the `OptimizeToursResponse` used
// in the injected solution and the current request that includes the injected
// solution. The uniqueness checks described above are not enough to guarantee
// this requirement.
InterpretInjectedSolutionsUsingLabels bool `protobuf:"varint,10,opt,name=interpret_injected_solutions_using_labels,json=interpretInjectedSolutionsUsingLabels,proto3" json:"interpret_injected_solutions_using_labels,omitempty"`
// Consider traffic estimation in calculating `ShipmentRoute` fields
// [Transition.travel_duration][google.maps.routeoptimization.v1.ShipmentRoute.Transition.travel_duration],
// [Visit.start_time][google.maps.routeoptimization.v1.ShipmentRoute.Visit.start_time],
// and `vehicle_end_time`; in setting the
// [ShipmentRoute.has_traffic_infeasibilities][google.maps.routeoptimization.v1.ShipmentRoute.has_traffic_infeasibilities]
// field, and in calculating the
// [OptimizeToursResponse.total_cost][google.maps.routeoptimization.v1.OptimizeToursResponse.total_cost]
// field.
ConsiderRoadTraffic bool `protobuf:"varint,11,opt,name=consider_road_traffic,json=considerRoadTraffic,proto3" json:"consider_road_traffic,omitempty"`
// If true, polylines will be populated in response `ShipmentRoute`s.
PopulatePolylines bool `protobuf:"varint,12,opt,name=populate_polylines,json=populatePolylines,proto3" json:"populate_polylines,omitempty"`
// If true, polylines and route tokens will be populated in response
// [ShipmentRoute.transitions][google.maps.routeoptimization.v1.ShipmentRoute.transitions].
PopulateTransitionPolylines bool `protobuf:"varint,13,opt,name=populate_transition_polylines,json=populateTransitionPolylines,proto3" json:"populate_transition_polylines,omitempty"`
// 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.
AllowLargeDeadlineDespiteInterruptionRisk bool `protobuf:"varint,14,opt,name=allow_large_deadline_despite_interruption_risk,json=allowLargeDeadlineDespiteInterruptionRisk,proto3" json:"allow_large_deadline_despite_interruption_risk,omitempty"`
// 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`.
UseGeodesicDistances bool `protobuf:"varint,15,opt,name=use_geodesic_distances,json=useGeodesicDistances,proto3" json:"use_geodesic_distances,omitempty"`
// 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.
GeodesicMetersPerSecond *float64 `protobuf:"fixed64,16,opt,name=geodesic_meters_per_second,json=geodesicMetersPerSecond,proto3,oneof" json:"geodesic_meters_per_second,omitempty"`
// Truncates the number of validation errors returned. These errors are
// typically attached to an INVALID_ARGUMENT error payload as a BadRequest
// error detail (https://cloud.google.com/apis/design/errors#error_details),
// unless solving_mode=VALIDATE_ONLY: see the
// [OptimizeToursResponse.validation_errors][google.maps.routeoptimization.v1.OptimizeToursResponse.validation_errors]
// field.
// This defaults to 100 and is capped at 10,000.
MaxValidationErrors *int32 `protobuf:"varint,5,opt,name=max_validation_errors,json=maxValidationErrors,proto3,oneof" json:"max_validation_errors,omitempty"`
// Label that may be used to identify this request, reported back in the
// [OptimizeToursResponse.request_label][google.maps.routeoptimization.v1.OptimizeToursResponse.request_label].
Label string `protobuf:"bytes,17,opt,name=label,proto3" json:"label,omitempty"`
// contains filtered or unexported fields
}Request to be given to a tour optimization solver which defines the shipment model to solve as well as optimization parameters.
func (*OptimizeToursRequest) Descriptor
func (*OptimizeToursRequest) Descriptor() ([]byte, []int)Deprecated: Use OptimizeToursRequest.ProtoReflect.Descriptor instead.
func (*OptimizeToursRequest) GetAllowLargeDeadlineDespiteInterruptionRisk
func (x *OptimizeToursRequest) GetAllowLargeDeadlineDespiteInterruptionRisk() boolfunc (*OptimizeToursRequest) GetConsiderRoadTraffic
func (x *OptimizeToursRequest) GetConsiderRoadTraffic() boolfunc (*OptimizeToursRequest) GetGeodesicMetersPerSecond
func (x *OptimizeToursRequest) GetGeodesicMetersPerSecond() float64func (*OptimizeToursRequest) GetInjectedFirstSolutionRoutes
func (x *OptimizeToursRequest) GetInjectedFirstSolutionRoutes() []*ShipmentRoutefunc (*OptimizeToursRequest) GetInjectedSolutionConstraint
func (x *OptimizeToursRequest) GetInjectedSolutionConstraint() *InjectedSolutionConstraintfunc (*OptimizeToursRequest) GetInterpretInjectedSolutionsUsingLabels
func (x *OptimizeToursRequest) GetInterpretInjectedSolutionsUsingLabels() boolfunc (*OptimizeToursRequest) GetLabel
func (x *OptimizeToursRequest) GetLabel() stringfunc (*OptimizeToursRequest) GetMaxValidationErrors
func (x *OptimizeToursRequest) GetMaxValidationErrors() int32func (*OptimizeToursRequest) GetModel
func (x *OptimizeToursRequest) GetModel() *ShipmentModelfunc (*OptimizeToursRequest) GetParent
func (x *OptimizeToursRequest) GetParent() stringfunc (*OptimizeToursRequest) GetPopulatePolylines
func (x *OptimizeToursRequest) GetPopulatePolylines() boolfunc (*OptimizeToursRequest) GetPopulateTransitionPolylines
func (x *OptimizeToursRequest) GetPopulateTransitionPolylines() boolfunc (*OptimizeToursRequest) GetRefreshDetailsRoutes
func (x *OptimizeToursRequest) GetRefreshDetailsRoutes() []*ShipmentRoutefunc (*OptimizeToursRequest) GetSearchMode
func (x *OptimizeToursRequest) GetSearchMode() OptimizeToursRequest_SearchModefunc (*OptimizeToursRequest) GetSolvingMode
func (x *OptimizeToursRequest) GetSolvingMode() OptimizeToursRequest_SolvingModefunc (*OptimizeToursRequest) GetTimeout
func (x *OptimizeToursRequest) GetTimeout() *durationpb.Durationfunc (*OptimizeToursRequest) GetUseGeodesicDistances
func (x *OptimizeToursRequest) GetUseGeodesicDistances() boolfunc (*OptimizeToursRequest) ProtoMessage
func (*OptimizeToursRequest) ProtoMessage()func (*OptimizeToursRequest) ProtoReflect
func (x *OptimizeToursRequest) ProtoReflect() protoreflect.Messagefunc (*OptimizeToursRequest) Reset
func (x *OptimizeToursRequest) Reset()func (*OptimizeToursRequest) String
func (x *OptimizeToursRequest) String() stringOptimizeToursRequest_SearchMode
type OptimizeToursRequest_SearchMode int32Mode defining the behavior of the search, trading off latency versus solution quality. In all modes, the global request deadline is enforced.
OptimizeToursRequest_SEARCH_MODE_UNSPECIFIED, OptimizeToursRequest_RETURN_FAST, OptimizeToursRequest_CONSUME_ALL_AVAILABLE_TIME
const (
// Unspecified search mode, equivalent to `RETURN_FAST`.
OptimizeToursRequest_SEARCH_MODE_UNSPECIFIED OptimizeToursRequest_SearchMode = 0
// Stop the search after finding the first good solution.
OptimizeToursRequest_RETURN_FAST OptimizeToursRequest_SearchMode = 1
// Spend all the available time to search for better solutions.
OptimizeToursRequest_CONSUME_ALL_AVAILABLE_TIME OptimizeToursRequest_SearchMode = 2
)func (OptimizeToursRequest_SearchMode) Descriptor
func (OptimizeToursRequest_SearchMode) Descriptor() protoreflect.EnumDescriptorfunc (OptimizeToursRequest_SearchMode) Enum
func (x OptimizeToursRequest_SearchMode) Enum() *OptimizeToursRequest_SearchModefunc (OptimizeToursRequest_SearchMode) EnumDescriptor
func (OptimizeToursRequest_SearchMode) EnumDescriptor() ([]byte, []int)Deprecated: Use OptimizeToursRequest_SearchMode.Descriptor instead.
func (OptimizeToursRequest_SearchMode) Number
func (x OptimizeToursRequest_SearchMode) Number() protoreflect.EnumNumberfunc (OptimizeToursRequest_SearchMode) String
func (x OptimizeToursRequest_SearchMode) String() stringfunc (OptimizeToursRequest_SearchMode) Type
func (OptimizeToursRequest_SearchMode) Type() protoreflect.EnumTypeOptimizeToursRequest_SolvingMode
type OptimizeToursRequest_SolvingMode int32Defines how the solver should handle the request. In all modes but
VALIDATE_ONLY, if the request is invalid, you will receive an
INVALID_REQUEST error. See
[max_validation_errors][google.maps.routeoptimization.v1.OptimizeToursRequest.max_validation_errors]
to cap the number of errors returned.
OptimizeToursRequest_DEFAULT_SOLVE, OptimizeToursRequest_VALIDATE_ONLY, OptimizeToursRequest_DETECT_SOME_INFEASIBLE_SHIPMENTS, OptimizeToursRequest_TRANSFORM_AND_RETURN_REQUEST
const (
// Solve the model. Warnings may be issued in
// [OptimizeToursResponse.validation_errors][google.cloud.optimization.v1.OptimizeToursResponse.validation_errors].
OptimizeToursRequest_DEFAULT_SOLVE OptimizeToursRequest_SolvingMode = 0
// Only validates the model without solving it: populates as many
// [OptimizeToursResponse.validation_errors][google.maps.routeoptimization.v1.OptimizeToursResponse.validation_errors]
// as possible.
OptimizeToursRequest_VALIDATE_ONLY OptimizeToursRequest_SolvingMode = 1
// Only populates
// [OptimizeToursResponse.validation_errors][google.maps.routeoptimization.v1.OptimizeToursResponse.validation_errors]
// or
// [OptimizeToursResponse.skipped_shipments][google.maps.routeoptimization.v1.OptimizeToursResponse.skipped_shipments],
// and doesn't actually solve the rest of the request (`status` and `routes`
// are unset in the response).
// If infeasibilities in `injected_solution_constraint` routes are detected
// they are populated in the
// [OptimizeToursResponse.validation_errors][google.maps.routeoptimization.v1.OptimizeToursResponse.validation_errors]
// field and
// [OptimizeToursResponse.skipped_shipments][google.maps.routeoptimization.v1.OptimizeToursResponse.skipped_shipments]
// is left empty.
//
// *IMPORTANT*: not all infeasible shipments are returned here, but only the
// ones that are detected as infeasible during preprocessing.
OptimizeToursRequest_DETECT_SOME_INFEASIBLE_SHIPMENTS OptimizeToursRequest_SolvingMode = 2
// This mode only works if `ShipmentModel.objectives` is not empty. The
// request is not solved. It is only validated and filled with costs
// corresponding to the given objectives. Also see the documentation of
// `ShipmentModel.objectives`. The resulting request is returned as
// `OptimizeToursResponse.processed_request`.
//
// Experimental: See
// https://developers.google.com/maps/tt/route-optimization/experimental/objectives/make-request
// for more details.
OptimizeToursRequest_TRANSFORM_AND_RETURN_REQUEST OptimizeToursRequest_SolvingMode = 3
)func (OptimizeToursRequest_SolvingMode) Descriptor
func (OptimizeToursRequest_SolvingMode) Descriptor() protoreflect.EnumDescriptorfunc (OptimizeToursRequest_SolvingMode) Enum
func (x OptimizeToursRequest_SolvingMode) Enum() *OptimizeToursRequest_SolvingModefunc (OptimizeToursRequest_SolvingMode) EnumDescriptor
func (OptimizeToursRequest_SolvingMode) EnumDescriptor() ([]byte, []int)Deprecated: Use OptimizeToursRequest_SolvingMode.Descriptor instead.
func (OptimizeToursRequest_SolvingMode) Number
func (x OptimizeToursRequest_SolvingMode) Number() protoreflect.EnumNumberfunc (OptimizeToursRequest_SolvingMode) String
func (x OptimizeToursRequest_SolvingMode) String() stringfunc (OptimizeToursRequest_SolvingMode) Type
func (OptimizeToursRequest_SolvingMode) Type() protoreflect.EnumTypeOptimizeToursResponse
type OptimizeToursResponse struct {
// Routes computed for each vehicle; the i-th route corresponds to the i-th
// vehicle in the model.
Routes []*ShipmentRoute `protobuf:"bytes,1,rep,name=routes,proto3" json:"routes,omitempty"`
// Copy of the
// [OptimizeToursRequest.label][google.maps.routeoptimization.v1.OptimizeToursRequest.label],
// if a label was specified in the request.
RequestLabel string `protobuf:"bytes,3,opt,name=request_label,json=requestLabel,proto3" json:"request_label,omitempty"`
// The list of all shipments skipped.
SkippedShipments []*SkippedShipment `protobuf:"bytes,4,rep,name=skipped_shipments,json=skippedShipments,proto3" json:"skipped_shipments,omitempty"`
// List of all the validation errors that we were able to detect
// independently. See the "MULTIPLE ERRORS" explanation for the
// [OptimizeToursValidationError][google.maps.routeoptimization.v1.OptimizeToursValidationError]
// message. Instead of errors, this will include warnings in the case
// `solving_mode` is `DEFAULT_SOLVE`.
ValidationErrors []*OptimizeToursValidationError `protobuf:"bytes,5,rep,name=validation_errors,json=validationErrors,proto3" json:"validation_errors,omitempty"`
// In some cases we modify the incoming request before solving it, i.e. adding
// costs. If solving_mode == TRANSFORM_AND_RETURN_REQUEST, the
// modified request is returned here.
//
// Experimental: See
// https://developers.google.com/maps/tt/route-optimization/experimental/objectives/make-request
// for more details.
ProcessedRequest *OptimizeToursRequest `protobuf:"bytes,21,opt,name=processed_request,json=processedRequest,proto3" json:"processed_request,omitempty"`
// Duration, distance and usage metrics for this solution.
Metrics *OptimizeToursResponse_Metrics `protobuf:"bytes,6,opt,name=metrics,proto3" json:"metrics,omitempty"`
// contains filtered or unexported fields
}Response after solving a tour optimization problem containing the routes followed by each vehicle, the shipments which have been skipped and the overall cost of the solution.
func (*OptimizeToursResponse) Descriptor
func (*OptimizeToursResponse) Descriptor() ([]byte, []int)Deprecated: Use OptimizeToursResponse.ProtoReflect.Descriptor instead.
func (*OptimizeToursResponse) GetMetrics
func (x *OptimizeToursResponse) GetMetrics() *OptimizeToursResponse_Metricsfunc (*OptimizeToursResponse) GetProcessedRequest
func (x *OptimizeToursResponse) GetProcessedRequest() *OptimizeToursRequestfunc (*OptimizeToursResponse) GetRequestLabel
func (x *OptimizeToursResponse) GetRequestLabel() stringfunc (*OptimizeToursResponse) GetRoutes
func (x *OptimizeToursResponse) GetRoutes() []*ShipmentRoutefunc (*OptimizeToursResponse) GetSkippedShipments
func (x *OptimizeToursResponse) GetSkippedShipments() []*SkippedShipmentfunc (*OptimizeToursResponse) GetValidationErrors
func (x *OptimizeToursResponse) GetValidationErrors() []*OptimizeToursValidationErrorfunc (*OptimizeToursResponse) ProtoMessage
func (*OptimizeToursResponse) ProtoMessage()func (*OptimizeToursResponse) ProtoReflect
func (x *OptimizeToursResponse) ProtoReflect() protoreflect.Messagefunc (*OptimizeToursResponse) Reset
func (x *OptimizeToursResponse) Reset()func (*OptimizeToursResponse) String
func (x *OptimizeToursResponse) String() stringOptimizeToursResponse_Metrics
type OptimizeToursResponse_Metrics struct {
// Aggregated over the routes. Each metric is the sum (or max, for loads)
// over all
// [ShipmentRoute.metrics][google.maps.routeoptimization.v1.ShipmentRoute.metrics]
// fields of the same name.
AggregatedRouteMetrics *AggregatedMetrics `protobuf:"bytes,1,opt,name=aggregated_route_metrics,json=aggregatedRouteMetrics,proto3" json:"aggregated_route_metrics,omitempty"`
// Number of mandatory shipments skipped.
SkippedMandatoryShipmentCount int32 `protobuf:"varint,2,opt,name=skipped_mandatory_shipment_count,json=skippedMandatoryShipmentCount,proto3" json:"skipped_mandatory_shipment_count,omitempty"`
// Number of vehicles used. Note: if a vehicle route is empty and
// [Vehicle.used_if_route_is_empty][google.maps.routeoptimization.v1.Vehicle.used_if_route_is_empty]
// is true, the vehicle is considered used.
UsedVehicleCount int32 `protobuf:"varint,3,opt,name=used_vehicle_count,json=usedVehicleCount,proto3" json:"used_vehicle_count,omitempty"`
// The earliest start time for a used vehicle, computed as the minimum over
// all used vehicles of
// [ShipmentRoute.vehicle_start_time][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_start_time].
EarliestVehicleStartTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=earliest_vehicle_start_time,json=earliestVehicleStartTime,proto3" json:"earliest_vehicle_start_time,omitempty"`
// The latest end time for a used vehicle, computed as the maximum over all
// used vehicles of
// [ShipmentRoute.vehicle_end_time][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_end_time].
LatestVehicleEndTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=latest_vehicle_end_time,json=latestVehicleEndTime,proto3" json:"latest_vehicle_end_time,omitempty"`
// Cost of the solution, broken down by cost-related request fields.
// The keys are proto paths, relative to the input OptimizeToursRequest,
// e.g. "model.shipments.pickups.cost", and the values are the total cost
// generated by the corresponding cost field, aggregated over the whole
// solution. In other words, costs["model.shipments.pickups.cost"] is the
// sum of all pickup costs over the solution. All costs defined in the model
// are reported in detail here with the exception of costs related to
// TransitionAttributes that are only reported in an aggregated way as of
// 2022/01.
Costs map[string]float64 `protobuf:"bytes,10,rep,name=costs,proto3" json:"costs,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"fixed64,2,opt,name=value,proto3"`
// Total cost of the solution. The sum of all values in the costs map.
TotalCost float64 `protobuf:"fixed64,6,opt,name=total_cost,json=totalCost,proto3" json:"total_cost,omitempty"`
// contains filtered or unexported fields
}Overall metrics, aggregated over all routes.
func (*OptimizeToursResponse_Metrics) Descriptor
func (*OptimizeToursResponse_Metrics) Descriptor() ([]byte, []int)Deprecated: Use OptimizeToursResponse_Metrics.ProtoReflect.Descriptor instead.
func (*OptimizeToursResponse_Metrics) GetAggregatedRouteMetrics
func (x *OptimizeToursResponse_Metrics) GetAggregatedRouteMetrics() *AggregatedMetricsfunc (*OptimizeToursResponse_Metrics) GetCosts
func (x *OptimizeToursResponse_Metrics) GetCosts() map[string]float64func (*OptimizeToursResponse_Metrics) GetEarliestVehicleStartTime
func (x *OptimizeToursResponse_Metrics) GetEarliestVehicleStartTime() *timestamppb.Timestampfunc (*OptimizeToursResponse_Metrics) GetLatestVehicleEndTime
func (x *OptimizeToursResponse_Metrics) GetLatestVehicleEndTime() *timestamppb.Timestampfunc (*OptimizeToursResponse_Metrics) GetSkippedMandatoryShipmentCount
func (x *OptimizeToursResponse_Metrics) GetSkippedMandatoryShipmentCount() int32func (*OptimizeToursResponse_Metrics) GetTotalCost
func (x *OptimizeToursResponse_Metrics) GetTotalCost() float64func (*OptimizeToursResponse_Metrics) GetUsedVehicleCount
func (x *OptimizeToursResponse_Metrics) GetUsedVehicleCount() int32func (*OptimizeToursResponse_Metrics) ProtoMessage
func (*OptimizeToursResponse_Metrics) ProtoMessage()func (*OptimizeToursResponse_Metrics) ProtoReflect
func (x *OptimizeToursResponse_Metrics) ProtoReflect() protoreflect.Messagefunc (*OptimizeToursResponse_Metrics) Reset
func (x *OptimizeToursResponse_Metrics) Reset()func (*OptimizeToursResponse_Metrics) String
func (x *OptimizeToursResponse_Metrics) String() stringOptimizeToursUriMetadata
type OptimizeToursUriMetadata struct {
// contains filtered or unexported fields
}Operation metadata for OptimizeToursUri calls.
func (*OptimizeToursUriMetadata) Descriptor
func (*OptimizeToursUriMetadata) Descriptor() ([]byte, []int)Deprecated: Use OptimizeToursUriMetadata.ProtoReflect.Descriptor instead.
func (*OptimizeToursUriMetadata) ProtoMessage
func (*OptimizeToursUriMetadata) ProtoMessage()func (*OptimizeToursUriMetadata) ProtoReflect
func (x *OptimizeToursUriMetadata) ProtoReflect() protoreflect.Messagefunc (*OptimizeToursUriMetadata) Reset
func (x *OptimizeToursUriMetadata) Reset()func (*OptimizeToursUriMetadata) String
func (x *OptimizeToursUriMetadata) String() stringOptimizeToursUriRequest
type OptimizeToursUriRequest struct {
// Required. Target project or location to make a call.
//
// Format:
// * `projects/{project-id}`
// * `projects/{project-id}/locations/{location-id}`
//
// If no location is specified, a region will be chosen automatically.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The URI of the Cloud Storage object containing the
// `OptimizeToursRequest`.
Input *Uri `protobuf:"bytes,2,opt,name=input,proto3" json:"input,omitempty"`
// Required. The URI of the Cloud Storage object that will contain the
// `OptimizeToursResponse`.
Output *Uri `protobuf:"bytes,3,opt,name=output,proto3" json:"output,omitempty"`
// contains filtered or unexported fields
}A request used by the OptimizeToursUri method.
func (*OptimizeToursUriRequest) Descriptor
func (*OptimizeToursUriRequest) Descriptor() ([]byte, []int)Deprecated: Use OptimizeToursUriRequest.ProtoReflect.Descriptor instead.
func (*OptimizeToursUriRequest) GetInput
func (x *OptimizeToursUriRequest) GetInput() *Urifunc (*OptimizeToursUriRequest) GetOutput
func (x *OptimizeToursUriRequest) GetOutput() *Urifunc (*OptimizeToursUriRequest) GetParent
func (x *OptimizeToursUriRequest) GetParent() stringfunc (*OptimizeToursUriRequest) ProtoMessage
func (*OptimizeToursUriRequest) ProtoMessage()func (*OptimizeToursUriRequest) ProtoReflect
func (x *OptimizeToursUriRequest) ProtoReflect() protoreflect.Messagefunc (*OptimizeToursUriRequest) Reset
func (x *OptimizeToursUriRequest) Reset()func (*OptimizeToursUriRequest) String
func (x *OptimizeToursUriRequest) String() stringOptimizeToursUriResponse
type OptimizeToursUriResponse struct {
// Optional. The URI of the Cloud Storage object containing the
// `OptimizeToursResponse` encoded as either JSON or textproto. If the object
// was encoded as JSON, the extension of the object name will be
// `.json`. If the object was encoded as textproto, the extension of the
// object name will be `.txtpb`.
//
// The `crc32_checksum` of the resource can be used to verify the contents of
// the resource have not been modified.
Output *Uri `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
// contains filtered or unexported fields
}A response returned by the OptimizeToursUri method.
func (*OptimizeToursUriResponse) Descriptor
func (*OptimizeToursUriResponse) Descriptor() ([]byte, []int)Deprecated: Use OptimizeToursUriResponse.ProtoReflect.Descriptor instead.
func (*OptimizeToursUriResponse) GetOutput
func (x *OptimizeToursUriResponse) GetOutput() *Urifunc (*OptimizeToursUriResponse) ProtoMessage
func (*OptimizeToursUriResponse) ProtoMessage()func (*OptimizeToursUriResponse) ProtoReflect
func (x *OptimizeToursUriResponse) ProtoReflect() protoreflect.Messagefunc (*OptimizeToursUriResponse) Reset
func (x *OptimizeToursUriResponse) Reset()func (*OptimizeToursUriResponse) String
func (x *OptimizeToursUriResponse) String() stringOptimizeToursValidationError
type OptimizeToursValidationError struct {
// A validation error is defined by the pair (`code`, `display_name`) which
// are always present.
//
// The fields following this section provide more context about the error.
//
// *MULTIPLE ERRORS*:
// When there are multiple errors, the validation process tries to output
// several of them. Much like a compiler, this is an imperfect process. Some
// validation errors will be "fatal", meaning that they stop the entire
// validation process. This is the case for `display_name="UNSPECIFIED"`
// errors, among others. Some errors may cause the validation process to skip
// other errors.
//
// *STABILITY*:
// `code` and `display_name` should be very stable. But new codes and
// display names may appear over time, which may cause a given (invalid)
// request to yield a different (`code`, `display_name`) pair because the new
// error hid the old one. For example, see "MULTIPLE ERRORS".
Code int32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
// The error display name.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// An error context may involve 0, 1 (most of the time) or more fields. For
// example, referring to vehicle #4 and shipment #2's first pickup can be
// done as follows:
// ```
// fields { name: "vehicles" index: 4}
// fields { name: "shipments" index: 2 sub_field {name: "pickups" index: 0} }
// ```
// Note, however, that the cardinality of `fields` should not change for a
// given error code.
Fields []*OptimizeToursValidationError_FieldReference `protobuf:"bytes,3,rep,name=fields,proto3" json:"fields,omitempty"`
// Human-readable string describing the error. There is a 1:1 mapping
// between `code` and `error_message` (when code != "UNSPECIFIED").
//
// *STABILITY*: Not stable: the error message associated to a given `code` may
// change (hopefully to clarify it) over time. Please rely on the
// `display_name` and `code` instead.
ErrorMessage string `protobuf:"bytes,4,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
// May contain the value(s) of the field(s). This is not always available. You
// should absolutely not rely on it and use it only for manual model
// debugging.
OffendingValues string `protobuf:"bytes,5,opt,name=offending_values,json=offendingValues,proto3" json:"offending_values,omitempty"`
// contains filtered or unexported fields
}Describes an error or warning encountered when validating an
OptimizeToursRequest.
func (*OptimizeToursValidationError) Descriptor
func (*OptimizeToursValidationError) Descriptor() ([]byte, []int)Deprecated: Use OptimizeToursValidationError.ProtoReflect.Descriptor instead.
func (*OptimizeToursValidationError) GetCode
func (x *OptimizeToursValidationError) GetCode() int32func (*OptimizeToursValidationError) GetDisplayName
func (x *OptimizeToursValidationError) GetDisplayName() stringfunc (*OptimizeToursValidationError) GetErrorMessage
func (x *OptimizeToursValidationError) GetErrorMessage() stringfunc (*OptimizeToursValidationError) GetFields
func (x *OptimizeToursValidationError) GetFields() []*OptimizeToursValidationError_FieldReferencefunc (*OptimizeToursValidationError) GetOffendingValues
func (x *OptimizeToursValidationError) GetOffendingValues() stringfunc (*OptimizeToursValidationError) ProtoMessage
func (*OptimizeToursValidationError) ProtoMessage()func (*OptimizeToursValidationError) ProtoReflect
func (x *OptimizeToursValidationError) ProtoReflect() protoreflect.Messagefunc (*OptimizeToursValidationError) Reset
func (x *OptimizeToursValidationError) Reset()func (*OptimizeToursValidationError) String
func (x *OptimizeToursValidationError) String() stringOptimizeToursValidationError_FieldReference
type OptimizeToursValidationError_FieldReference struct {
// Name of the field, e.g., "vehicles".
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Types that are assignable to IndexOrKey:
//
// *OptimizeToursValidationError_FieldReference_Index
// *OptimizeToursValidationError_FieldReference_Key
IndexOrKey isOptimizeToursValidationError_FieldReference_IndexOrKey `protobuf_oneof:"index_or_key"`
// Recursively nested sub-field, if needed.
SubField *OptimizeToursValidationError_FieldReference `protobuf:"bytes,3,opt,name=sub_field,json=subField,proto3" json:"sub_field,omitempty"`
// contains filtered or unexported fields
}Specifies a context for the validation error. A FieldReference always
refers to a given field in this file and follows the same hierarchical
structure. For example, we may specify element #2 of start_time_windows
of vehicle #5 using:
name: "vehicles" index: 5 sub_field { name: "end_time_windows" index: 2 }
We however omit top-level entities such as OptimizeToursRequest or
ShipmentModel to avoid crowding the message.
func (*OptimizeToursValidationError_FieldReference) Descriptor
func (*OptimizeToursValidationError_FieldReference) Descriptor() ([]byte, []int)Deprecated: Use OptimizeToursValidationError_FieldReference.ProtoReflect.Descriptor instead.
func (*OptimizeToursValidationError_FieldReference) GetIndex
func (x *OptimizeToursValidationError_FieldReference) GetIndex() int32func (*OptimizeToursValidationError_FieldReference) GetIndexOrKey
func (m *OptimizeToursValidationError_FieldReference) GetIndexOrKey() isOptimizeToursValidationError_FieldReference_IndexOrKeyfunc (*OptimizeToursValidationError_FieldReference) GetKey
func (x *OptimizeToursValidationError_FieldReference) GetKey() stringfunc (*OptimizeToursValidationError_FieldReference) GetName
func (x *OptimizeToursValidationError_FieldReference) GetName() stringfunc (*OptimizeToursValidationError_FieldReference) GetSubField
func (x *OptimizeToursValidationError_FieldReference) GetSubField() *OptimizeToursValidationError_FieldReferencefunc (*OptimizeToursValidationError_FieldReference) ProtoMessage
func (*OptimizeToursValidationError_FieldReference) ProtoMessage()func (*OptimizeToursValidationError_FieldReference) ProtoReflect
func (x *OptimizeToursValidationError_FieldReference) ProtoReflect() protoreflect.Messagefunc (*OptimizeToursValidationError_FieldReference) Reset
func (x *OptimizeToursValidationError_FieldReference) Reset()func (*OptimizeToursValidationError_FieldReference) String
func (x *OptimizeToursValidationError_FieldReference) String() stringOptimizeToursValidationError_FieldReference_Index
type OptimizeToursValidationError_FieldReference_Index struct {
// Index of the field if repeated.
Index int32 `protobuf:"varint,2,opt,name=index,proto3,oneof"`
}OptimizeToursValidationError_FieldReference_Key
type OptimizeToursValidationError_FieldReference_Key struct {
// Key if the field is a map.
Key string `protobuf:"bytes,4,opt,name=key,proto3,oneof"`
}OutputConfig
type OutputConfig struct {
// Required.
//
// Types that are assignable to Destination:
//
// *OutputConfig_GcsDestination
Destination isOutputConfig_Destination `protobuf_oneof:"destination"`
// Required. The output data format.
DataFormat DataFormat `protobuf:"varint,2,opt,name=data_format,json=dataFormat,proto3,enum=google.maps.routeoptimization.v1.DataFormat" json:"data_format,omitempty"`
// contains filtered or unexported fields
}Specify a destination for [BatchOptimizeTours][google.maps.routeoptimization.v1.RouteOptimizationService.BatchOptimizeTours] results.
func (*OutputConfig) Descriptor
func (*OutputConfig) Descriptor() ([]byte, []int)Deprecated: Use OutputConfig.ProtoReflect.Descriptor instead.
func (*OutputConfig) GetDataFormat
func (x *OutputConfig) GetDataFormat() DataFormatfunc (*OutputConfig) GetDestination
func (m *OutputConfig) GetDestination() isOutputConfig_Destinationfunc (*OutputConfig) GetGcsDestination
func (x *OutputConfig) GetGcsDestination() *GcsDestinationfunc (*OutputConfig) ProtoMessage
func (*OutputConfig) ProtoMessage()func (*OutputConfig) ProtoReflect
func (x *OutputConfig) ProtoReflect() protoreflect.Messagefunc (*OutputConfig) Reset
func (x *OutputConfig) Reset()func (*OutputConfig) String
func (x *OutputConfig) String() stringOutputConfig_GcsDestination
type OutputConfig_GcsDestination struct {
// The Google Cloud Storage location to write the output to.
GcsDestination *GcsDestination `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3,oneof"`
}RouteModifiers
type RouteModifiers struct {
// Specifies whether to avoid toll roads where reasonable. Preference will be
// given to routes not containing toll roads. Applies only to motorized travel
// modes.
AvoidTolls bool `protobuf:"varint,2,opt,name=avoid_tolls,json=avoidTolls,proto3" json:"avoid_tolls,omitempty"`
// Specifies whether to avoid highways where reasonable. Preference will be
// given to routes not containing highways. Applies only to motorized travel
// modes.
AvoidHighways bool `protobuf:"varint,3,opt,name=avoid_highways,json=avoidHighways,proto3" json:"avoid_highways,omitempty"`
// Specifies whether to avoid ferries where reasonable. Preference will be
// given to routes not containing travel by ferries. Applies only to motorized
// travel modes.
AvoidFerries bool `protobuf:"varint,4,opt,name=avoid_ferries,json=avoidFerries,proto3" json:"avoid_ferries,omitempty"`
// Optional. Specifies whether to avoid navigating indoors where reasonable.
// Preference will be given to routes not containing indoor navigation.
// Applies only to the `WALKING` travel mode.
AvoidIndoor bool `protobuf:"varint,5,opt,name=avoid_indoor,json=avoidIndoor,proto3" json:"avoid_indoor,omitempty"`
// contains filtered or unexported fields
}Encapsulates a set of optional conditions to satisfy when calculating
vehicle routes. This is similar to RouteModifiers in the Google Maps
Platform Routes Preferred API; see:
https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteModifiers.
func (*RouteModifiers) Descriptor
func (*RouteModifiers) Descriptor() ([]byte, []int)Deprecated: Use RouteModifiers.ProtoReflect.Descriptor instead.
func (*RouteModifiers) GetAvoidFerries
func (x *RouteModifiers) GetAvoidFerries() boolfunc (*RouteModifiers) GetAvoidHighways
func (x *RouteModifiers) GetAvoidHighways() boolfunc (*RouteModifiers) GetAvoidIndoor
func (x *RouteModifiers) GetAvoidIndoor() boolfunc (*RouteModifiers) GetAvoidTolls
func (x *RouteModifiers) GetAvoidTolls() boolfunc (*RouteModifiers) ProtoMessage
func (*RouteModifiers) ProtoMessage()func (*RouteModifiers) ProtoReflect
func (x *RouteModifiers) ProtoReflect() protoreflect.Messagefunc (*RouteModifiers) Reset
func (x *RouteModifiers) Reset()func (*RouteModifiers) String
func (x *RouteModifiers) String() stringRouteOptimizationClient
type RouteOptimizationClient interface {
// Sends an `OptimizeToursRequest` containing a `ShipmentModel` and returns an
// `OptimizeToursResponse` containing `ShipmentRoute`s, which are a set of
// routes to be performed by vehicles minimizing the overall cost.
//
// A `ShipmentModel` model consists mainly of `Shipment`s that need to be
// carried out and `Vehicle`s that can be used to transport the `Shipment`s.
// The `ShipmentRoute`s assign `Shipment`s to `Vehicle`s. More specifically,
// they assign a series of `Visit`s to each vehicle, where a `Visit`
// corresponds to a `VisitRequest`, which is a pickup or delivery for a
// `Shipment`.
//
// The goal is to provide an assignment of `ShipmentRoute`s to `Vehicle`s that
// minimizes the total cost where cost has many components defined in the
// `ShipmentModel`.
OptimizeTours(ctx context.Context, in *OptimizeToursRequest, opts ...grpc.CallOption) (*OptimizeToursResponse, error)
// Optimizes vehicle tours for one or more `OptimizeToursRequest`
// messages as a batch.
//
// This method is a Long Running Operation (LRO). The inputs for optimization
// (`OptimizeToursRequest` messages) and outputs (`OptimizeToursResponse`
// messages) are read from and written to Cloud Storage in user-specified
// format. Like the `OptimizeTours` method, each `OptimizeToursRequest`
// contains a `ShipmentModel` and returns an `OptimizeToursResponse`
// containing `ShipmentRoute` fields, which are a set of routes to be
// performed by vehicles minimizing the overall cost.
//
// The user can poll `operations.get` to check the status of the LRO:
//
// If the LRO `done` field is false, then at least one request is still
// being processed. Other requests may have completed successfully and their
// results are available in Cloud Storage.
//
// If the LRO's `done` field is true, then all requests have been processed.
// Any successfully processed requests will have their results available in
// Cloud Storage. Any requests that failed will not have their results
// available in Cloud Storage. If the LRO's `error` field is set, then it
// contains the error from one of the failed requests.
BatchOptimizeTours(ctx context.Context, in *BatchOptimizeToursRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// This is a variant of the
// [OptimizeTours][google.maps.routeoptimization.v1.RouteOptimization.OptimizeTours]
// method designed for
// optimizations with large timeout values. It should be preferred over the
// `OptimizeTours` method for optimizations that take longer than
// a few minutes.
//
// The returned [long-running operation][google.longrunning.Operation] (LRO)
// will have a name of the format
// `RouteOptimizationClient is the client API for RouteOptimization service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewRouteOptimizationClient
func NewRouteOptimizationClient(cc grpc.ClientConnInterface) RouteOptimizationClientRouteOptimizationServer
type RouteOptimizationServer interface {
// Sends an `OptimizeToursRequest` containing a `ShipmentModel` and returns an
// `OptimizeToursResponse` containing `ShipmentRoute`s, which are a set of
// routes to be performed by vehicles minimizing the overall cost.
//
// A `ShipmentModel` model consists mainly of `Shipment`s that need to be
// carried out and `Vehicle`s that can be used to transport the `Shipment`s.
// The `ShipmentRoute`s assign `Shipment`s to `Vehicle`s. More specifically,
// they assign a series of `Visit`s to each vehicle, where a `Visit`
// corresponds to a `VisitRequest`, which is a pickup or delivery for a
// `Shipment`.
//
// The goal is to provide an assignment of `ShipmentRoute`s to `Vehicle`s that
// minimizes the total cost where cost has many components defined in the
// `ShipmentModel`.
OptimizeTours(context.Context, *OptimizeToursRequest) (*OptimizeToursResponse, error)
// Optimizes vehicle tours for one or more `OptimizeToursRequest`
// messages as a batch.
//
// This method is a Long Running Operation (LRO). The inputs for optimization
// (`OptimizeToursRequest` messages) and outputs (`OptimizeToursResponse`
// messages) are read from and written to Cloud Storage in user-specified
// format. Like the `OptimizeTours` method, each `OptimizeToursRequest`
// contains a `ShipmentModel` and returns an `OptimizeToursResponse`
// containing `ShipmentRoute` fields, which are a set of routes to be
// performed by vehicles minimizing the overall cost.
//
// The user can poll `operations.get` to check the status of the LRO:
//
// If the LRO `done` field is false, then at least one request is still
// being processed. Other requests may have completed successfully and their
// results are available in Cloud Storage.
//
// If the LRO's `done` field is true, then all requests have been processed.
// Any successfully processed requests will have their results available in
// Cloud Storage. Any requests that failed will not have their results
// available in Cloud Storage. If the LRO's `error` field is set, then it
// contains the error from one of the failed requests.
BatchOptimizeTours(context.Context, *BatchOptimizeToursRequest) (*longrunningpb.Operation, error)
// This is a variant of the
// [OptimizeTours][google.maps.routeoptimization.v1.RouteOptimization.OptimizeTours]
// method designed for
// optimizations with large timeout values. It should be preferred over the
// `OptimizeTours` method for optimizations that take longer than
// a few minutes.
//
// The returned [long-running operation][google.longrunning.Operation] (LRO)
// will have a name of the format
// `RouteOptimizationServer is the server API for RouteOptimization service. All implementations should embed UnimplementedRouteOptimizationServer for forward compatibility
Shipment
type Shipment struct {
// The user-defined display name of the shipment.
// It can be up to 63 characters long and may use UTF-8 characters.
DisplayName string `protobuf:"bytes,16,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Set of pickup alternatives associated to the shipment. If not specified,
// the vehicle only needs to visit a location corresponding to the deliveries.
Pickups []*Shipment_VisitRequest `protobuf:"bytes,1,rep,name=pickups,proto3" json:"pickups,omitempty"`
// Set of delivery alternatives associated to the shipment. If not specified,
// the vehicle only needs to visit a location corresponding to the pickups.
Deliveries []*Shipment_VisitRequest `protobuf:"bytes,2,rep,name=deliveries,proto3" json:"deliveries,omitempty"`
// Load demands of the shipment (for example weight, volume, number of
// pallets etc). The keys in the map should be identifiers describing the type
// of the corresponding load, ideally also including the units.
// For example: "weight_kg", "volume_gallons", "pallet_count", etc.
// If a given key does not appear in the map, the corresponding load is
// considered as null.
LoadDemands map[string]*Shipment_Load `protobuf:"bytes,14,rep,name=load_demands,json=loadDemands,proto3" json:"load_demands,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// If the shipment is not completed, this penalty is added to the overall
// cost of the routes. A shipment is considered completed if one of its pickup
// and delivery alternatives is visited. The cost may be expressed in the
// same unit used for all other cost-related fields in the model and must be
// positive.
//
// *IMPORTANT*: If this penalty is not specified, it is considered infinite,
// i.e. the shipment must be completed.
PenaltyCost *float64 `protobuf:"fixed64,4,opt,name=penalty_cost,json=penaltyCost,proto3,oneof" json:"penalty_cost,omitempty"`
// The set of vehicles that may perform this shipment. If empty, all vehicles
// may perform it. Vehicles are given by their index in the `ShipmentModel`'s
// `vehicles` list.
AllowedVehicleIndices []int32 `protobuf:"varint,5,rep,packed,name=allowed_vehicle_indices,json=allowedVehicleIndices,proto3" json:"allowed_vehicle_indices,omitempty"`
// Specifies the cost that is incurred when this shipment is delivered by each
// vehicle. If specified, it must have EITHER:
//
// - the same number of elements as `costs_per_vehicle_indices`.
// `costs_per_vehicle[i]` corresponds to vehicle
// `costs_per_vehicle_indices[i]` of the model.
// - the same number of elements as there are vehicles in the model. The
// i-th element corresponds to vehicle #i of the model.
//
// These costs must be in the same unit as `penalty_cost` and must not be
// negative. Leave this field empty, if there are no such costs.
CostsPerVehicle []float64 `protobuf:"fixed64,6,rep,packed,name=costs_per_vehicle,json=costsPerVehicle,proto3" json:"costs_per_vehicle,omitempty"`
// Indices of the vehicles to which `costs_per_vehicle` applies. If non-empty,
// it must have the same number of elements as `costs_per_vehicle`. A vehicle
// index may not be specified more than once. If a vehicle is excluded from
// `costs_per_vehicle_indices`, its cost is zero.
CostsPerVehicleIndices []int32 `protobuf:"varint,7,rep,packed,name=costs_per_vehicle_indices,json=costsPerVehicleIndices,proto3" json:"costs_per_vehicle_indices,omitempty"`
// Specifies the maximum relative detour time compared to the shortest path
// from pickup to delivery. If specified, it must be nonnegative, and the
// shipment must contain at least a pickup and a delivery.
//
// For example, let t be the shortest time taken to go from the selected
// pickup alternative directly to the selected delivery alternative. Then
// setting `pickup_to_delivery_relative_detour_limit` enforces:
//
// ```
// start_time(delivery) - start_time(pickup) <= std::ceil(t="" *="" (1.0="" +="" pickup_to_delivery_relative_detour_limit))="" ```="" if="" both="" relative="" and="" absolute="" limits="" are="" specified="" on="" the="" same="" shipment,="" the="" more="" constraining="" limit="" is="" used="" for="" each="" possible="" pickup/delivery="" pair.="" as="" of="" 2017/10,="" detours="" are="" only="" supported="" when="" travel="" durations="" do="" not="" depend="" on="" vehicles.="" pickuptodeliveryrelativedetourlimit="">float64 `protobuf:"fixed64,8,opt,name=pickup_to_delivery_relative_detour_limit,json=pickupToDeliveryRelativeDetourLimit,proto3,oneof" json:"pickup_to_delivery_relative_detour_limit,omitempty"`
// Specifies the maximum absolute detour time compared to the shortest path
// from pickup to delivery. If specified, it must be nonnegative, and the
// shipment must contain at least a pickup and a delivery.
//
// For example, let t be the shortest time taken to go from the selected
// pickup alternative directly to the selected delivery alternative. Then
// setting `pickup_to_delivery_absolute_detour_limit` enforces:
//
// ```
// start_time(delivery) - start_time(pickup) <= t="" +="" pickup_to_delivery_absolute_detour_limit="" ```="" if="" both="" relative="" and="" absolute="" limits="" are="" specified="" on="" the="" same="" shipment,="" the="" more="" constraining="" limit="" is="" used="" for="" each="" possible="" pickup/delivery="" pair.="" as="" of="" 2017/10,="" detours="" are="" only="" supported="" when="" travel="" durations="" do="" not="" depend="" on="" vehicles.="" pickuptodeliveryabsolutedetourlimit="">durationpb.Duration `protobuf:"bytes,9,opt,name=pickup_to_delivery_absolute_detour_limit,json=pickupToDeliveryAbsoluteDetourLimit,proto3" json:"pickup_to_delivery_absolute_detour_limit,omitempty"`
// Specifies the maximum duration from start of pickup to start of delivery of
// a shipment. If specified, it must be nonnegative, and the shipment must
// contain at least a pickup and a delivery. This does not depend on which
// alternatives are selected for pickup and delivery, nor on vehicle speed.
// This can be specified alongside maximum detour constraints: the solution
// will respect both specifications.
PickupToDeliveryTimeLimit *durationpb.Duration `protobuf:"bytes,10,opt,name=pickup_to_delivery_time_limit,json=pickupToDeliveryTimeLimit,proto3" json:"pickup_to_delivery_time_limit,omitempty"`
// Non-empty string specifying a "type" for this shipment.
// This feature can be used to define incompatibilities or requirements
// between `shipment_types` (see `shipment_type_incompatibilities` and
// `shipment_type_requirements` in `ShipmentModel`).
//
// Differs from `visit_types` which is specified for a single visit: All
// pickup/deliveries belonging to the same shipment share the same
// `shipment_type`.
ShipmentType string `protobuf:"bytes,11,opt,name=shipment_type,json=shipmentType,proto3" json:"shipment_type,omitempty"`
// Specifies a label for this shipment. This label is reported in the response
// in the `shipment_label` of the corresponding
// [ShipmentRoute.Visit][google.maps.routeoptimization.v1.ShipmentRoute.Visit].
Label string `protobuf:"bytes,12,opt,name=label,proto3" json:"label,omitempty"`
// If true, skip this shipment, but don't apply a `penalty_cost`.
//
// Ignoring a shipment results in a validation error when there are any
// `shipment_type_requirements` in the model.
//
// Ignoring a shipment that is performed in `injected_first_solution_routes`
// or `injected_solution_constraint` is permitted; the solver removes the
// related pickup/delivery visits from the performing route.
// `precedence_rules` that reference ignored shipments will also be ignored.
Ignore bool `protobuf:"varint,13,opt,name=ignore,proto3" json:"ignore,omitempty"`
// contains filtered or unexported fields
}The shipment of a single item, from one of its pickups to one of its deliveries. For the shipment to be considered as performed, a unique vehicle must visit one of its pickup locations (and decrease its spare capacities accordingly), then visit one of its delivery locations later on (and therefore re-increase its spare capacities accordingly).
func (*Shipment) Descriptor
Deprecated: Use Shipment.ProtoReflect.Descriptor instead.
func (*Shipment) GetAllowedVehicleIndices
func (*Shipment) GetCostsPerVehicle
func (*Shipment) GetCostsPerVehicleIndices
func (*Shipment) GetDeliveries
func (x *Shipment) GetDeliveries() []*Shipment_VisitRequestfunc (*Shipment) GetDisplayName
func (*Shipment) GetIgnore
func (*Shipment) GetLabel
func (*Shipment) GetLoadDemands
func (x *Shipment) GetLoadDemands() map[string]*Shipment_Loadfunc (*Shipment) GetPenaltyCost
func (*Shipment) GetPickupToDeliveryAbsoluteDetourLimit
func (x *Shipment) GetPickupToDeliveryAbsoluteDetourLimit() *durationpb.Durationfunc (*Shipment) GetPickupToDeliveryRelativeDetourLimit
func (*Shipment) GetPickupToDeliveryTimeLimit
func (x *Shipment) GetPickupToDeliveryTimeLimit() *durationpb.Durationfunc (*Shipment) GetPickups
func (x *Shipment) GetPickups() []*Shipment_VisitRequestfunc (*Shipment) GetShipmentType
func (*Shipment) ProtoMessage
func (*Shipment) ProtoMessage()func (*Shipment) ProtoReflect
func (x *Shipment) ProtoReflect() protoreflect.Messagefunc (*Shipment) Reset
func (x *Shipment) Reset()func (*Shipment) String
ShipmentModel
type ShipmentModel struct {
// Set of shipments which must be performed in the model.
Shipments []*Shipment `protobuf:"bytes,1,rep,name=shipments,proto3" json:"shipments,omitempty"`
// Set of vehicles which can be used to perform visits.
Vehicles []*Vehicle `protobuf:"bytes,2,rep,name=vehicles,proto3" json:"vehicles,omitempty"`
// The set of objectives for this model, that we will transform into costs.
// If not empty, the input model has to be costless.
// To obtain the modified request, please use `solving_mode` =
// TRANSFORM_AND_RETURN_REQUEST. Note that the request will not
// be solved in this case. See corresponding documentation.
//
// Experimental: See
// https://developers.google.com/maps/tt/route-optimization/experimental/objectives/make-request
// for more details.
Objectives []*ShipmentModel_Objective `protobuf:"bytes,17,rep,name=objectives,proto3" json:"objectives,omitempty"`
// Constrains the maximum number of active vehicles. A vehicle is active if
// its route performs at least one shipment. This can be used to limit the
// number of routes in the case where there are fewer drivers than
// vehicles and that the fleet of vehicles is heterogeneous. The optimization
// will then select the best subset of vehicles to use.
// Must be strictly positive.
MaxActiveVehicles *int32 `protobuf:"varint,4,opt,name=max_active_vehicles,json=maxActiveVehicles,proto3,oneof" json:"max_active_vehicles,omitempty"`
// Global start and end time of the model: no times outside of this range
// can be considered valid.
//
// The model's time span must be less than a year, i.e. the `global_end_time`
// and the `global_start_time` must be within 31536000 seconds of each other.
//
// When using `cost_per_*hour` fields, you might want to set this window to a
// smaller interval to increase performance (eg. if you model a single day,
// you should set the global time limits to that day).
// If unset, 00:00:00 UTC, January 1, 1970 (i.e. seconds: 0, nanos: 0) is used
// as default.
GlobalStartTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=global_start_time,json=globalStartTime,proto3" json:"global_start_time,omitempty"`
// If unset, 00:00:00 UTC, January 1, 1971 (i.e. seconds: 31536000, nanos: 0)
// is used as default.
GlobalEndTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=global_end_time,json=globalEndTime,proto3" json:"global_end_time,omitempty"`
// The "global duration" of the overall plan is the difference between the
// earliest effective start time and the latest effective end time of
// all vehicles. Users can assign a cost per hour to that quantity to try
// and optimize for earliest job completion, for example. This cost must be in
// the same unit as
// [Shipment.penalty_cost][google.maps.routeoptimization.v1.Shipment.penalty_cost].
GlobalDurationCostPerHour float64 `protobuf:"fixed64,7,opt,name=global_duration_cost_per_hour,json=globalDurationCostPerHour,proto3" json:"global_duration_cost_per_hour,omitempty"`
// Specifies duration and distance matrices used in the model. If this field
// is empty, Google Maps or geodesic distances will be used instead, depending
// on the value of the `use_geodesic_distances` field. If it is not empty,
// `use_geodesic_distances` cannot be true and neither
// `duration_distance_matrix_src_tags` nor `duration_distance_matrix_dst_tags`
// can be empty.
//
// Usage examples:
//
// * There are two locations: locA and locB.
// * 1 vehicle starting its route at locA and ending it at locA.
// * 1 pickup visit request at locB.
//
// ```
//
// model {
// vehicles { start_tags: "locA" end_tags: "locA" }
// shipments { pickups { tags: "locB" } }
// duration_distance_matrix_src_tags: "locA"
// duration_distance_matrix_src_tags: "locB"
// duration_distance_matrix_dst_tags: "locA"
// duration_distance_matrix_dst_tags: "locB"
// duration_distance_matrices {
// rows { # from: locA
// durations { seconds: 0 } meters: 0 # to: locA
// durations { seconds: 100 } meters: 1000 # to: locB
// }
// rows { # from: locB
// durations { seconds: 102 } meters: 990 # to: locA
// durations { seconds: 0 } meters: 0 # to: locB
// }
// }
// }
//
// ```
//
// - There are three locations: locA, locB and locC.
// - 1 vehicle starting its route at locA and ending it at locB, using
// matrix "fast".
// - 1 vehicle starting its route at locB and ending it at locB, using
// matrix "slow".
// - 1 vehicle starting its route at locB and ending it at locB, using
// matrix "fast".
// - 1 pickup visit request at locC.
//
// ```
//
// model {
// vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" }
// vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" }
// vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" }
// shipments { pickups { tags: "locC" } }
// duration_distance_matrix_src_tags: "locA"
// duration_distance_matrix_src_tags: "locB"
// duration_distance_matrix_src_tags: "locC"
// duration_distance_matrix_dst_tags: "locB"
// duration_distance_matrix_dst_tags: "locC"
// duration_distance_matrices {
// vehicle_start_tag: "fast"
// rows { # from: locA
// durations { seconds: 1000 } meters: 2000 # to: locB
// durations { seconds: 600 } meters: 1000 # to: locC
// }
// rows { # from: locB
// durations { seconds: 0 } meters: 0 # to: locB
// durations { seconds: 700 } meters: 1200 # to: locC
// }
// rows { # from: locC
// durations { seconds: 702 } meters: 1190 # to: locB
// durations { seconds: 0 } meters: 0 # to: locC
// }
// }
// duration_distance_matrices {
// vehicle_start_tag: "slow"
// rows { # from: locA
// durations { seconds: 1800 } meters: 2001 # to: locB
// durations { seconds: 900 } meters: 1002 # to: locC
// }
// rows { # from: locB
// durations { seconds: 0 } meters: 0 # to: locB
// durations { seconds: 1000 } meters: 1202 # to: locC
// }
// rows { # from: locC
// durations { seconds: 1001 } meters: 1195 # to: locB
// durations { seconds: 0 } meters: 0 # to: locC
// }
// }
// }
//
// ```
DurationDistanceMatrices []*ShipmentModel_DurationDistanceMatrix `protobuf:"bytes,8,rep,name=duration_distance_matrices,json=durationDistanceMatrices,proto3" json:"duration_distance_matrices,omitempty"`
// Tags defining the sources of the duration and distance matrices;
// `duration_distance_matrices(i).rows(j)` defines durations and distances
// from visits with tag `duration_distance_matrix_src_tags(j)` to other visits
// in matrix i.
//
// Tags correspond to
// [VisitRequest.tags][google.maps.routeoptimization.v1.Shipment.VisitRequest.tags]
// or
// [Vehicle.start_tags][google.maps.routeoptimization.v1.Vehicle.start_tags].
// A given `VisitRequest` or `Vehicle` must match exactly one tag in this
// field. Note that a `Vehicle`'s source, destination and matrix tags may be
// the same; similarly a `VisitRequest`'s source and destination tags may be
// the same. All tags must be different and cannot be empty strings. If this
// field is not empty, then `duration_distance_matrices` must not be empty.
DurationDistanceMatrixSrcTags []string `protobuf:"bytes,9,rep,name=duration_distance_matrix_src_tags,json=durationDistanceMatrixSrcTags,proto3" json:"duration_distance_matrix_src_tags,omitempty"`
// Tags defining the destinations of the duration and distance matrices;
// `duration_distance_matrices(i).rows(j).durations(k)` (resp.
// `duration_distance_matrices(i).rows(j).meters(k))` defines the duration
// (resp. the distance) of the travel from visits with tag
// `duration_distance_matrix_src_tags(j)` to visits with tag
// `duration_distance_matrix_dst_tags(k)` in matrix i.
//
// Tags correspond to
// [VisitRequest.tags][google.maps.routeoptimization.v1.Shipment.VisitRequest.tags]
// or
// [Vehicle.start_tags][google.maps.routeoptimization.v1.Vehicle.start_tags].
// A given `VisitRequest` or `Vehicle` must match exactly one tag in this
// field. Note that a `Vehicle`'s source, destination and matrix tags may be
// the same; similarly a `VisitRequest`'s source and destination tags may be
// the same. All tags must be different and cannot be empty strings. If this
// field is not empty, then `duration_distance_matrices` must not be empty.
DurationDistanceMatrixDstTags []string `protobuf:"bytes,10,rep,name=duration_distance_matrix_dst_tags,json=durationDistanceMatrixDstTags,proto3" json:"duration_distance_matrix_dst_tags,omitempty"`
// Transition attributes added to the model.
TransitionAttributes []*TransitionAttributes `protobuf:"bytes,11,rep,name=transition_attributes,json=transitionAttributes,proto3" json:"transition_attributes,omitempty"`
// Sets of incompatible shipment_types (see `ShipmentTypeIncompatibility`).
ShipmentTypeIncompatibilities []*ShipmentTypeIncompatibility `protobuf:"bytes,12,rep,name=shipment_type_incompatibilities,json=shipmentTypeIncompatibilities,proto3" json:"shipment_type_incompatibilities,omitempty"`
// Sets of `shipment_type` requirements (see `ShipmentTypeRequirement`).
ShipmentTypeRequirements []*ShipmentTypeRequirement `protobuf:"bytes,13,rep,name=shipment_type_requirements,json=shipmentTypeRequirements,proto3" json:"shipment_type_requirements,omitempty"`
// Set of precedence rules which must be enforced in the model.
//
// *IMPORTANT*: Use of precedence rules limits the size of problem that can be
// optimized. Requests using precedence rules that include many shipments may
// be rejected.
PrecedenceRules []*ShipmentModel_PrecedenceRule `protobuf:"bytes,14,rep,name=precedence_rules,json=precedenceRules,proto3" json:"precedence_rules,omitempty"`
// contains filtered or unexported fields
}A shipment model contains a set of shipments which must be performed by a set of vehicles, while minimizing the overall cost, which is the sum of:
- the cost of routing the vehicles (sum of cost per total time, cost per travel time, and fixed cost over all vehicles).
- the unperformed shipment penalties.
- the cost of the global duration of the shipments
func (*ShipmentModel) Descriptor
func (*ShipmentModel) Descriptor() ([]byte, []int)Deprecated: Use ShipmentModel.ProtoReflect.Descriptor instead.
func (*ShipmentModel) GetDurationDistanceMatrices
func (x *ShipmentModel) GetDurationDistanceMatrices() []*ShipmentModel_DurationDistanceMatrixfunc (*ShipmentModel) GetDurationDistanceMatrixDstTags
func (x *ShipmentModel) GetDurationDistanceMatrixDstTags() []stringfunc (*ShipmentModel) GetDurationDistanceMatrixSrcTags
func (x *ShipmentModel) GetDurationDistanceMatrixSrcTags() []stringfunc (*ShipmentModel) GetGlobalDurationCostPerHour
func (x *ShipmentModel) GetGlobalDurationCostPerHour() float64func (*ShipmentModel) GetGlobalEndTime
func (x *ShipmentModel) GetGlobalEndTime() *timestamppb.Timestampfunc (*ShipmentModel) GetGlobalStartTime
func (x *ShipmentModel) GetGlobalStartTime() *timestamppb.Timestampfunc (*ShipmentModel) GetMaxActiveVehicles
func (x *ShipmentModel) GetMaxActiveVehicles() int32func (*ShipmentModel) GetObjectives
func (x *ShipmentModel) GetObjectives() []*ShipmentModel_Objectivefunc (*ShipmentModel) GetPrecedenceRules
func (x *ShipmentModel) GetPrecedenceRules() []*ShipmentModel_PrecedenceRulefunc (*ShipmentModel) GetShipmentTypeIncompatibilities
func (x *ShipmentModel) GetShipmentTypeIncompatibilities() []*ShipmentTypeIncompatibilityfunc (*ShipmentModel) GetShipmentTypeRequirements
func (x *ShipmentModel) GetShipmentTypeRequirements() []*ShipmentTypeRequirementfunc (*ShipmentModel) GetShipments
func (x *ShipmentModel) GetShipments() []*Shipmentfunc (*ShipmentModel) GetTransitionAttributes
func (x *ShipmentModel) GetTransitionAttributes() []*TransitionAttributesfunc (*ShipmentModel) GetVehicles
func (x *ShipmentModel) GetVehicles() []*Vehiclefunc (*ShipmentModel) ProtoMessage
func (*ShipmentModel) ProtoMessage()func (*ShipmentModel) ProtoReflect
func (x *ShipmentModel) ProtoReflect() protoreflect.Messagefunc (*ShipmentModel) Reset
func (x *ShipmentModel) Reset()func (*ShipmentModel) String
func (x *ShipmentModel) String() stringShipmentModel_DurationDistanceMatrix
type ShipmentModel_DurationDistanceMatrix struct {
// Specifies the rows of the duration and distance matrix. It must have as
// many elements as
// [ShipmentModel.duration_distance_matrix_src_tags][google.maps.routeoptimization.v1.ShipmentModel.duration_distance_matrix_src_tags].
Rows []*ShipmentModel_DurationDistanceMatrix_Row `protobuf:"bytes,1,rep,name=rows,proto3" json:"rows,omitempty"`
// Tag defining to which vehicles this duration and distance matrix applies.
// If empty, this applies to all vehicles, and there can only be a single
// matrix.
//
// Each vehicle start must match exactly one matrix, i.e. exactly one of
// their `start_tags` field must match the `vehicle_start_tag` of a matrix
// (and of that matrix only).
//
// All matrices must have a different `vehicle_start_tag`.
VehicleStartTag string `protobuf:"bytes,2,opt,name=vehicle_start_tag,json=vehicleStartTag,proto3" json:"vehicle_start_tag,omitempty"`
// contains filtered or unexported fields
}Specifies a duration and distance matrix from visit and vehicle start locations to visit and vehicle end locations.
func (*ShipmentModel_DurationDistanceMatrix) Descriptor
func (*ShipmentModel_DurationDistanceMatrix) Descriptor() ([]byte, []int)Deprecated: Use ShipmentModel_DurationDistanceMatrix.ProtoReflect.Descriptor instead.
func (*ShipmentModel_DurationDistanceMatrix) GetRows
func (x *ShipmentModel_DurationDistanceMatrix) GetRows() []*ShipmentModel_DurationDistanceMatrix_Rowfunc (*ShipmentModel_DurationDistanceMatrix) GetVehicleStartTag
func (x *ShipmentModel_DurationDistanceMatrix) GetVehicleStartTag() stringfunc (*ShipmentModel_DurationDistanceMatrix) ProtoMessage
func (*ShipmentModel_DurationDistanceMatrix) ProtoMessage()func (*ShipmentModel_DurationDistanceMatrix) ProtoReflect
func (x *ShipmentModel_DurationDistanceMatrix) ProtoReflect() protoreflect.Messagefunc (*ShipmentModel_DurationDistanceMatrix) Reset
func (x *ShipmentModel_DurationDistanceMatrix) Reset()func (*ShipmentModel_DurationDistanceMatrix) String
func (x *ShipmentModel_DurationDistanceMatrix) String() stringShipmentModel_DurationDistanceMatrix_Row
type ShipmentModel_DurationDistanceMatrix_Row struct {
// Duration values for a given row. It must have as many elements as
// [ShipmentModel.duration_distance_matrix_dst_tags][google.maps.routeoptimization.v1.ShipmentModel.duration_distance_matrix_dst_tags].
Durations []*durationpb.Duration `protobuf:"bytes,1,rep,name=durations,proto3" json:"durations,omitempty"`
// Distance values for a given row. If no costs or constraints refer to
// distances in the model, this can be left empty; otherwise it must have
// as many elements as `durations`.
Meters []float64 `protobuf:"fixed64,2,rep,packed,name=meters,proto3" json:"meters,omitempty"`
// contains filtered or unexported fields
}Specifies a row of the duration and distance matrix.
func (*ShipmentModel_DurationDistanceMatrix_Row) Descriptor
func (*ShipmentModel_DurationDistanceMatrix_Row) Descriptor() ([]byte, []int)Deprecated: Use ShipmentModel_DurationDistanceMatrix_Row.ProtoReflect.Descriptor instead.
func (*ShipmentModel_DurationDistanceMatrix_Row) GetDurations
func (x *ShipmentModel_DurationDistanceMatrix_Row) GetDurations() []*durationpb.Durationfunc (*ShipmentModel_DurationDistanceMatrix_Row) GetMeters
func (x *ShipmentModel_DurationDistanceMatrix_Row) GetMeters() []float64func (*ShipmentModel_DurationDistanceMatrix_Row) ProtoMessage
func (*ShipmentModel_DurationDistanceMatrix_Row) ProtoMessage()func (*ShipmentModel_DurationDistanceMatrix_Row) ProtoReflect
func (x *ShipmentModel_DurationDistanceMatrix_Row) ProtoReflect() protoreflect.Messagefunc (*ShipmentModel_DurationDistanceMatrix_Row) Reset
func (x *ShipmentModel_DurationDistanceMatrix_Row) Reset()func (*ShipmentModel_DurationDistanceMatrix_Row) String
func (x *ShipmentModel_DurationDistanceMatrix_Row) String() stringShipmentModel_Objective
type ShipmentModel_Objective struct {
// The type of the objective.
Type *ShipmentModel_Objective_Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.maps.routeoptimization.v1.ShipmentModel_Objective_Type,oneof" json:"type,omitempty"`
// How much this objective should count relatively to the others. This can
// be any non-negative number, weights do not have to sum to 1. Weights
// default to 1.0.
Weight *float64 `protobuf:"fixed64,2,opt,name=weight,proto3,oneof" json:"weight,omitempty"`
// contains filtered or unexported fields
}Objectives replace the cost model completely, and are therefore incompatible with pre-existing costs. Each objective maps to a number of pre-defined costs for, e.g., vehicles, shipments or transition attributes.
Experimental: See https://developers.google.com/maps/tt/route-optimization/experimental/objectives/make-request for more details.
func (*ShipmentModel_Objective) Descriptor
func (*ShipmentModel_Objective) Descriptor() ([]byte, []int)Deprecated: Use ShipmentModel_Objective.ProtoReflect.Descriptor instead.
func (*ShipmentModel_Objective) GetType
func (x *ShipmentModel_Objective) GetType() ShipmentModel_Objective_Typefunc (*ShipmentModel_Objective) GetWeight
func (x *ShipmentModel_Objective) GetWeight() float64func (*ShipmentModel_Objective) ProtoMessage
func (*ShipmentModel_Objective) ProtoMessage()func (*ShipmentModel_Objective) ProtoReflect
func (x *ShipmentModel_Objective) ProtoReflect() protoreflect.Messagefunc (*ShipmentModel_Objective) Reset
func (x *ShipmentModel_Objective) Reset()func (*ShipmentModel_Objective) String
func (x *ShipmentModel_Objective) String() stringShipmentModel_Objective_Type
type ShipmentModel_Objective_Type int32The objective type that will be mapped to a set of costs.
ShipmentModel_Objective_DEFAULT, ShipmentModel_Objective_MIN_DISTANCE, ShipmentModel_Objective_MIN_WORKING_TIME, ShipmentModel_Objective_MIN_TRAVEL_TIME, ShipmentModel_Objective_MIN_NUM_VEHICLES
const (
// A default set of costs will be used, to ensure a reasonable solution.
// Note: this objective can be used on its own, but will also always be
// added with weight 1.0, as a baseline, to the objectives specified by
// the user, if it's not already present.
ShipmentModel_Objective_DEFAULT ShipmentModel_Objective_Type = 0
// "MIN" objectives.
// Minimize the total distance traveled.
ShipmentModel_Objective_MIN_DISTANCE ShipmentModel_Objective_Type = 10
// Minimize the total working time, summed over all vehicles.
ShipmentModel_Objective_MIN_WORKING_TIME ShipmentModel_Objective_Type = 11
// Same as above but focusing on travel time only.
ShipmentModel_Objective_MIN_TRAVEL_TIME ShipmentModel_Objective_Type = 12
// Minimize the number of vehicles used.
ShipmentModel_Objective_MIN_NUM_VEHICLES ShipmentModel_Objective_Type = 13
)func (ShipmentModel_Objective_Type) Descriptor
func (ShipmentModel_Objective_Type) Descriptor() protoreflect.EnumDescriptorfunc (ShipmentModel_Objective_Type) Enum
func (x ShipmentModel_Objective_Type) Enum() *ShipmentModel_Objective_Typefunc (ShipmentModel_Objective_Type) EnumDescriptor
func (ShipmentModel_Objective_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use ShipmentModel_Objective_Type.Descriptor instead.
func (ShipmentModel_Objective_Type) Number
func (x ShipmentModel_Objective_Type) Number() protoreflect.EnumNumberfunc (ShipmentModel_Objective_Type) String
func (x ShipmentModel_Objective_Type) String() stringfunc (ShipmentModel_Objective_Type) Type
func (ShipmentModel_Objective_Type) Type() protoreflect.EnumTypeShipmentModel_PrecedenceRule
type ShipmentModel_PrecedenceRule struct {
// Shipment index of the "first" event. This field must be specified.
FirstIndex *int32 `protobuf:"varint,1,opt,name=first_index,json=firstIndex,proto3,oneof" json:"first_index,omitempty"`
// Indicates if the "first" event is a delivery.
FirstIsDelivery bool `protobuf:"varint,3,opt,name=first_is_delivery,json=firstIsDelivery,proto3" json:"first_is_delivery,omitempty"`
// Shipment index of the "second" event. This field must be specified.
SecondIndex *int32 `protobuf:"varint,2,opt,name=second_index,json=secondIndex,proto3,oneof" json:"second_index,omitempty"`
// Indicates if the "second" event is a delivery.
SecondIsDelivery bool `protobuf:"varint,4,opt,name=second_is_delivery,json=secondIsDelivery,proto3" json:"second_is_delivery,omitempty"`
// The offset between the "first" and "second" event. It can be negative.
OffsetDuration *durationpb.Duration `protobuf:"bytes,5,opt,name=offset_duration,json=offsetDuration,proto3" json:"offset_duration,omitempty"`
// contains filtered or unexported fields
}A precedence rule between two events (each event is the pickup or the
delivery of a shipment): the "second" event has to start at least
offset_duration after "first" has started.
Several precedences can refer to the same (or related) events, e.g., "pickup of B happens after delivery of A" and "pickup of C happens after pickup of B".
Furthermore, precedences only apply when both shipments are performed and are otherwise ignored.
func (*ShipmentModel_PrecedenceRule) Descriptor
func (*ShipmentModel_PrecedenceRule) Descriptor() ([]byte, []int)Deprecated: Use ShipmentModel_PrecedenceRule.ProtoReflect.Descriptor instead.
func (*ShipmentModel_PrecedenceRule) GetFirstIndex
func (x *ShipmentModel_PrecedenceRule) GetFirstIndex() int32func (*ShipmentModel_PrecedenceRule) GetFirstIsDelivery
func (x *ShipmentModel_PrecedenceRule) GetFirstIsDelivery() boolfunc (*ShipmentModel_PrecedenceRule) GetOffsetDuration
func (x *ShipmentModel_PrecedenceRule) GetOffsetDuration() *durationpb.Durationfunc (*ShipmentModel_PrecedenceRule) GetSecondIndex
func (x *ShipmentModel_PrecedenceRule) GetSecondIndex() int32func (*ShipmentModel_PrecedenceRule) GetSecondIsDelivery
func (x *ShipmentModel_PrecedenceRule) GetSecondIsDelivery() boolfunc (*ShipmentModel_PrecedenceRule) ProtoMessage
func (*ShipmentModel_PrecedenceRule) ProtoMessage()func (*ShipmentModel_PrecedenceRule) ProtoReflect
func (x *ShipmentModel_PrecedenceRule) ProtoReflect() protoreflect.Messagefunc (*ShipmentModel_PrecedenceRule) Reset
func (x *ShipmentModel_PrecedenceRule) Reset()func (*ShipmentModel_PrecedenceRule) String
func (x *ShipmentModel_PrecedenceRule) String() stringShipmentRoute
type ShipmentRoute struct {
// Vehicle performing the route, identified by its index in the source
// `ShipmentModel`.
VehicleIndex int32 `protobuf:"varint,1,opt,name=vehicle_index,json=vehicleIndex,proto3" json:"vehicle_index,omitempty"`
// Label of the vehicle performing this route, equal to
// `ShipmentModel.vehicles(vehicle_index).label`, if specified.
VehicleLabel string `protobuf:"bytes,2,opt,name=vehicle_label,json=vehicleLabel,proto3" json:"vehicle_label,omitempty"`
// Time at which the vehicle starts its route.
VehicleStartTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=vehicle_start_time,json=vehicleStartTime,proto3" json:"vehicle_start_time,omitempty"`
// Time at which the vehicle finishes its route.
VehicleEndTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=vehicle_end_time,json=vehicleEndTime,proto3" json:"vehicle_end_time,omitempty"`
// Ordered sequence of visits representing a route.
// visits[i] is the i-th visit in the route.
// If this field is empty, the vehicle is considered as unused.
Visits []*ShipmentRoute_Visit `protobuf:"bytes,7,rep,name=visits,proto3" json:"visits,omitempty"`
// Ordered list of transitions for the route.
Transitions []*ShipmentRoute_Transition `protobuf:"bytes,8,rep,name=transitions,proto3" json:"transitions,omitempty"`
// When
// [OptimizeToursRequest.consider_road_traffic][google.maps.routeoptimization.v1.OptimizeToursRequest.consider_road_traffic],
// is set to true, this field indicates that inconsistencies in route timings
// are predicted using traffic-based travel duration estimates. There may be
// insufficient time to complete traffic-adjusted travel, delays, and breaks
// between visits, before the first visit, or after the last visit, while
// still satisfying the visit and vehicle time windows. For example,
//
// ```
//
// start_time(previous_visit) + duration(previous_visit) +
// travel_duration(previous_visit, next_visit) > start_time(next_visit)
//
// ```
//
// Arrival at next_visit will likely happen later than its current
// time window due the increased estimate of travel time
// `travel_duration(previous_visit, next_visit)` due to traffic. Also, a break
// may be forced to overlap with a visit due to an increase in travel time
// estimates and visit or break time window restrictions.
HasTrafficInfeasibilities bool `protobuf:"varint,9,opt,name=has_traffic_infeasibilities,json=hasTrafficInfeasibilities,proto3" json:"has_traffic_infeasibilities,omitempty"`
// The encoded polyline representation of the route.
// This field is only populated if
// [OptimizeToursRequest.populate_polylines][google.maps.routeoptimization.v1.OptimizeToursRequest.populate_polylines]
// is set to true.
RoutePolyline *ShipmentRoute_EncodedPolyline `protobuf:"bytes,10,opt,name=route_polyline,json=routePolyline,proto3" json:"route_polyline,omitempty"`
// Breaks scheduled for the vehicle performing this route.
// The `breaks` sequence represents time intervals, each starting at the
// corresponding `start_time` and lasting `duration` seconds.
Breaks []*ShipmentRoute_Break `protobuf:"bytes,11,rep,name=breaks,proto3" json:"breaks,omitempty"`
// Duration, distance and load metrics for this route. The fields of
// [AggregatedMetrics][google.maps.routeoptimization.v1.AggregatedMetrics] are
// summed over all
// [ShipmentRoute.transitions][google.maps.routeoptimization.v1.ShipmentRoute.transitions]
// or
// [ShipmentRoute.visits][google.maps.routeoptimization.v1.ShipmentRoute.visits],
// depending on the context.
Metrics *AggregatedMetrics `protobuf:"bytes,12,opt,name=metrics,proto3" json:"metrics,omitempty"`
// [VehicleFullness][google.maps.routeoptimization.v1.VehicleFullness] field
// for computing how close the capped metrics are to their respective vehicle
// limits. Its fields are ratios between a capped metric field (e.g.
// [AggregatedMetrics.travel_distance_meters][google.maps.routeoptimization.v1.AggregatedMetrics.travel_distance_meters])
// and the related vehicle limit (e.g.
// [Vehicle.route_distance_limit][google.maps.routeoptimization.v1.Vehicle.route_distance_limit]).
//
// Experimental: This field's behavior or existence may change in future.
VehicleFullness *VehicleFullness `protobuf:"bytes,20,opt,name=vehicle_fullness,json=vehicleFullness,proto3" json:"vehicle_fullness,omitempty"`
// Cost of the route, broken down by cost-related request fields.
// The keys are proto paths, relative to the input OptimizeToursRequest, e.g.
// "model.shipments.pickups.cost", and the values are the total cost
// generated by the corresponding cost field, aggregated over the whole route.
// In other words, costs["model.shipments.pickups.cost"] is the sum of all
// pickup costs over the route. All costs defined in the model are reported in
// detail here with the exception of costs related to TransitionAttributes
// that are only reported in an aggregated way as of 2022/01.
RouteCosts map[string]float64 `protobuf:"bytes,17,rep,name=route_costs,json=routeCosts,proto3" json:"route_costs,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"fixed64,2,opt,name=value,proto3"`
// Total cost of the route. The sum of all costs in the cost map.
RouteTotalCost float64 `protobuf:"fixed64,18,opt,name=route_total_cost,json=routeTotalCost,proto3" json:"route_total_cost,omitempty"`
// contains filtered or unexported fields
}A vehicle's route can be decomposed, along the time axis, like this (we assume there are n visits):
| | | | | T[2], | | |
| Transition | Visit #0 | | | V[2], | | |
| #0 | aka | T[1] | V[1] | ... | V[n-1] | T[n] |
| aka T[0] | V[0] | | | V[n-2],| | |
| | | | | T[n-1] | | |
^ ^ ^ ^ ^ ^ ^ ^
vehicle V[0].start V[0].end V[1]. V[1]. V[n]. V[n]. vehicle
start (arrival) (departure) start end start end end
Note that we make a difference between:
- "punctual events", such as the vehicle start and end and each visit's start and end (aka arrival and departure). They happen at a given second.
- "time intervals", such as the visits themselves, and the transition between visits. Though time intervals can sometimes have zero duration, i.e. start and end at the same second, they often have a positive duration.
Invariants:
- If there are n visits, there are n+1 transitions.
- A visit is always surrounded by a transition before it (same index) and a transition after it (index + 1).
- The vehicle start is always followed by transition #0.
- The vehicle end is always preceded by transition #n.
Zooming in, here is what happens during a Transition and a Visit:
---+-------------------------------------+-----------------------------+-->
| TRANSITION[i] | VISIT[i] |
| | |
| * TRAVEL: the vehicle moves from | PERFORM the visit: |
| VISIT[i-1].departure_location to | |
| VISIT[i].arrival_location, which | * Spend some time: |
| takes a given travel duration | the "visit duration". |
| and distance | |
| | * Load or unload |
| * BREAKS: the driver may have | some quantities from the |
| breaks (e.g. lunch break). | vehicle: the "demand". |
| | |
| * WAIT: the driver/vehicle does | |
| nothing. This can happen for | |
| many reasons, for example when | |
| the vehicle reaches the next | |
| event's destination before the | |
| start of its time window | |
| | |
| * DELAY: *right before* the next | |
| arrival. E.g. the vehicle and/or | |
| driver spends time unloading. | |
| | |
---+-------------------------------------+-----------------------------+-->
^ ^ ^
V[i-1].end V[i].start V[i].end
Lastly, here is how the TRAVEL, BREAKS, DELAY and WAIT can be arranged during a transition.
- They don't overlap.
- The DELAY is unique and must be a contiguous period of time right before the next visit (or vehicle end). Thus, it suffice to know the delay duration to know its start and end time.
- The BREAKS are contiguous, non-overlapping periods of time. The response specifies the start time and duration of each break.
- TRAVEL and WAIT are "preemptable": they can be interrupted several times during this transition. Clients can assume that travel happens "as soon as possible" and that "wait" fills the remaining time.
A (complex) example:
TRANSITION[i]
--++-----+-----------------------------------------------------------++-->
|| | | | | | | ||
|| T | B | T | | B | | D ||
|| r | r | r | W | r | W | e ||
|| a | e | a | a | e | a | l ||
|| v | a | v | i | a | i | a ||
|| e | k | e | t | k | t | y ||
|| l | | l | | | | ||
|| | | | | | | ||
--++-----------------------------------------------------------------++-->
func (*ShipmentRoute) Descriptor
func (*ShipmentRoute) Descriptor() ([]byte, []int)Deprecated: Use ShipmentRoute.ProtoReflect.Descriptor instead.
func (*ShipmentRoute) GetBreaks
func (x *ShipmentRoute) GetBreaks() []*ShipmentRoute_Breakfunc (*ShipmentRoute) GetHasTrafficInfeasibilities
func (x *ShipmentRoute) GetHasTrafficInfeasibilities() boolfunc (*ShipmentRoute) GetMetrics
func (x *ShipmentRoute) GetMetrics() *AggregatedMetricsfunc (*ShipmentRoute) GetRouteCosts
func (x *ShipmentRoute) GetRouteCosts() map[string]float64func (*ShipmentRoute) GetRoutePolyline
func (x *ShipmentRoute) GetRoutePolyline() *ShipmentRoute_EncodedPolylinefunc (*ShipmentRoute) GetRouteTotalCost
func (x *ShipmentRoute) GetRouteTotalCost() float64func (*ShipmentRoute) GetTransitions
func (x *ShipmentRoute) GetTransitions() []*ShipmentRoute_Transitionfunc (*ShipmentRoute) GetVehicleEndTime
func (x *ShipmentRoute) GetVehicleEndTime() *timestamppb.Timestampfunc (*ShipmentRoute) GetVehicleFullness
func (x *ShipmentRoute) GetVehicleFullness() *VehicleFullnessfunc (*ShipmentRoute) GetVehicleIndex
func (x *ShipmentRoute) GetVehicleIndex() int32func (*ShipmentRoute) GetVehicleLabel
func (x *ShipmentRoute) GetVehicleLabel() stringfunc (*ShipmentRoute) GetVehicleStartTime
func (x *ShipmentRoute) GetVehicleStartTime() *timestamppb.Timestampfunc (*ShipmentRoute) GetVisits
func (x *ShipmentRoute) GetVisits() []*ShipmentRoute_Visitfunc (*ShipmentRoute) ProtoMessage
func (*ShipmentRoute) ProtoMessage()func (*ShipmentRoute) ProtoReflect
func (x *ShipmentRoute) ProtoReflect() protoreflect.Messagefunc (*ShipmentRoute) Reset
func (x *ShipmentRoute) Reset()func (*ShipmentRoute) String
func (x *ShipmentRoute) String() stringShipmentRoute_Break
type ShipmentRoute_Break struct {
// Start time of a break.
StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Duration of a break.
Duration *durationpb.Duration `protobuf:"bytes,2,opt,name=duration,proto3" json:"duration,omitempty"`
// contains filtered or unexported fields
}Data representing the execution of a break.
func (*ShipmentRoute_Break) Descriptor
func (*ShipmentRoute_Break) Descriptor() ([]byte, []int)Deprecated: Use ShipmentRoute_Break.ProtoReflect.Descriptor instead.
func (*ShipmentRoute_Break) GetDuration
func (x *ShipmentRoute_Break) GetDuration() *durationpb.Durationfunc (*ShipmentRoute_Break) GetStartTime
func (x *ShipmentRoute_Break) GetStartTime() *timestamppb.Timestampfunc (*ShipmentRoute_Break) ProtoMessage
func (*ShipmentRoute_Break) ProtoMessage()func (*ShipmentRoute_Break) ProtoReflect
func (x *ShipmentRoute_Break) ProtoReflect() protoreflect.Messagefunc (*ShipmentRoute_Break) Reset
func (x *ShipmentRoute_Break) Reset()func (*ShipmentRoute_Break) String
func (x *ShipmentRoute_Break) String() stringShipmentRoute_EncodedPolyline
type ShipmentRoute_EncodedPolyline struct {
// String representing encoded points of the polyline.
Points string `protobuf:"bytes,1,opt,name=points,proto3" json:"points,omitempty"`
// contains filtered or unexported fields
}The encoded representation of a polyline. More information on polyline encoding can be found here: https://developers.google.com/maps/documentation/utilities/polylinealgorithm https://developers.google.com/maps/documentation/javascript/reference/geometry#encoding.
func (*ShipmentRoute_EncodedPolyline) Descriptor
func (*ShipmentRoute_EncodedPolyline) Descriptor() ([]byte, []int)Deprecated: Use ShipmentRoute_EncodedPolyline.ProtoReflect.Descriptor instead.
func (*ShipmentRoute_EncodedPolyline) GetPoints
func (x *ShipmentRoute_EncodedPolyline) GetPoints() stringfunc (*ShipmentRoute_EncodedPolyline) ProtoMessage
func (*ShipmentRoute_EncodedPolyline) ProtoMessage()func (*ShipmentRoute_EncodedPolyline) ProtoReflect
func (x *ShipmentRoute_EncodedPolyline) ProtoReflect() protoreflect.Messagefunc (*ShipmentRoute_EncodedPolyline) Reset
func (x *ShipmentRoute_EncodedPolyline) Reset()func (*ShipmentRoute_EncodedPolyline) String
func (x *ShipmentRoute_EncodedPolyline) String() stringShipmentRoute_Transition
type ShipmentRoute_Transition struct {
// Travel duration during this transition.
TravelDuration *durationpb.Duration `protobuf:"bytes,1,opt,name=travel_duration,json=travelDuration,proto3" json:"travel_duration,omitempty"`
// Distance traveled during the transition.
TravelDistanceMeters float64 `protobuf:"fixed64,2,opt,name=travel_distance_meters,json=travelDistanceMeters,proto3" json:"travel_distance_meters,omitempty"`
// When traffic is requested via
// [OptimizeToursRequest.consider_road_traffic]
// [google.maps.routeoptimization.v1.OptimizeToursRequest.consider_road_traffic],
// and the traffic info couldn't be retrieved for a `Transition`, this
// boolean is set to true. This may be temporary (rare hiccup in the
// realtime traffic servers) or permanent (no data for this location).
TrafficInfoUnavailable bool `protobuf:"varint,3,opt,name=traffic_info_unavailable,json=trafficInfoUnavailable,proto3" json:"traffic_info_unavailable,omitempty"`
// Sum of the delay durations applied to this transition. If any, the delay
// starts exactly `delay_duration` seconds before the next event (visit or
// vehicle end). See
// [TransitionAttributes.delay][google.maps.routeoptimization.v1.TransitionAttributes.delay].
DelayDuration *durationpb.Duration `protobuf:"bytes,4,opt,name=delay_duration,json=delayDuration,proto3" json:"delay_duration,omitempty"`
// Sum of the duration of the breaks occurring during this transition, if
// any. Details about each break's start time and duration are stored in
// [ShipmentRoute.breaks][google.maps.routeoptimization.v1.ShipmentRoute.breaks].
BreakDuration *durationpb.Duration `protobuf:"bytes,5,opt,name=break_duration,json=breakDuration,proto3" json:"break_duration,omitempty"`
// Time spent waiting during this transition. Wait duration corresponds to
// idle time and does not include break time. Also note that this wait time
// may be split into several non-contiguous intervals.
WaitDuration *durationpb.Duration `protobuf:"bytes,6,opt,name=wait_duration,json=waitDuration,proto3" json:"wait_duration,omitempty"`
// Total duration of the transition, provided for convenience. It is equal
// to:
//
// * next visit `start_time` (or `vehicle_end_time` if this is the last
// transition) - this transition's `start_time`;
// * if `ShipmentRoute.has_traffic_infeasibilities` is false, the following
// additionally holds: `total_duration = travel_duration + delay_duration
// + break_duration + wait_duration`.
TotalDuration *durationpb.Duration `protobuf:"bytes,7,opt,name=total_duration,json=totalDuration,proto3" json:"total_duration,omitempty"`
// Start time of this transition.
StartTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// The encoded polyline representation of the route followed during the
// transition.
// This field is only populated if [populate_transition_polylines]
// [google.maps.routeoptimization.v1.OptimizeToursRequest.populate_transition_polylines]
// is set to true.
RoutePolyline *ShipmentRoute_EncodedPolyline `protobuf:"bytes,9,opt,name=route_polyline,json=routePolyline,proto3" json:"route_polyline,omitempty"`
// Output only. An opaque token that can be passed to [Navigation
// SDK](https://developers.google.com/maps/documentation/navigation) to
// reconstruct the route during navigation, and, in the event of rerouting,
// honor the original intention when the route was created. Treat this token
// as an opaque blob. Don't compare its value across requests as its value
// may change even if the service returns the exact same route. This field
// is only populated if [populate_transition_polylines]
// [google.maps.routeoptimization.v1.OptimizeToursRequest.populate_transition_polylines]
// is set to true.
RouteToken string `protobuf:"bytes,12,opt,name=route_token,json=routeToken,proto3" json:"route_token,omitempty"`
// Vehicle loads during this transition, for each type that either appears
// in this vehicle's
// [Vehicle.load_limits][google.maps.routeoptimization.v1.Vehicle.load_limits],
// or that have non-zero
// [Shipment.load_demands][google.maps.routeoptimization.v1.Shipment.load_demands]
// on some shipment performed on this route.
//
// The loads during the first transition are the starting loads of the
// vehicle route. Then, after each visit, the visit's `load_demands` are
// either added or subtracted to get the next transition's loads, depending
// on whether the visit was a pickup or a delivery.
VehicleLoads map[string]*ShipmentRoute_VehicleLoad `protobuf:"bytes,11,rep,name=vehicle_loads,json=vehicleLoads,proto3" json:"vehicle_loads,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}Transition between two events on the route. See the description of [ShipmentRoute][google.maps.routeoptimization.v1.ShipmentRoute].
If the vehicle does not have a start_location and/or end_location, the
corresponding travel metrics are 0.
func (*ShipmentRoute_Transition) Descriptor
func (*ShipmentRoute_Transition) Descriptor() ([]byte, []int)Deprecated: Use ShipmentRoute_Transition.ProtoReflect.Descriptor instead.
func (*ShipmentRoute_Transition) GetBreakDuration
func (x *ShipmentRoute_Transition) GetBreakDuration() *durationpb.Durationfunc (*ShipmentRoute_Transition) GetDelayDuration
func (x *ShipmentRoute_Transition) GetDelayDuration() *durationpb.Durationfunc (*ShipmentRoute_Transition) GetRoutePolyline
func (x *ShipmentRoute_Transition) GetRoutePolyline() *ShipmentRoute_EncodedPolylinefunc (*ShipmentRoute_Transition) GetRouteToken
func (x *ShipmentRoute_Transition) GetRouteToken() stringfunc (*ShipmentRoute_Transition) GetStartTime
func (x *ShipmentRoute_Transition) GetStartTime() *timestamppb.Timestampfunc (*ShipmentRoute_Transition) GetTotalDuration
func (x *ShipmentRoute_Transition) GetTotalDuration() *durationpb.Durationfunc (*ShipmentRoute_Transition) GetTrafficInfoUnavailable
func (x *ShipmentRoute_Transition) GetTrafficInfoUnavailable() boolfunc (*ShipmentRoute_Transition) GetTravelDistanceMeters
func (x *ShipmentRoute_Transition) GetTravelDistanceMeters() float64func (*ShipmentRoute_Transition) GetTravelDuration
func (x *ShipmentRoute_Transition) GetTravelDuration() *durationpb.Durationfunc (*ShipmentRoute_Transition) GetVehicleLoads
func (x *ShipmentRoute_Transition) GetVehicleLoads() map[string]*ShipmentRoute_VehicleLoadfunc (*ShipmentRoute_Transition) GetWaitDuration
func (x *ShipmentRoute_Transition) GetWaitDuration() *durationpb.Durationfunc (*ShipmentRoute_Transition) ProtoMessage
func (*ShipmentRoute_Transition) ProtoMessage()func (*ShipmentRoute_Transition) ProtoReflect
func (x *ShipmentRoute_Transition) ProtoReflect() protoreflect.Messagefunc (*ShipmentRoute_Transition) Reset
func (x *ShipmentRoute_Transition) Reset()func (*ShipmentRoute_Transition) String
func (x *ShipmentRoute_Transition) String() stringShipmentRoute_VehicleLoad
type ShipmentRoute_VehicleLoad struct {
// The amount of load on the vehicle, for the given type. The unit of load
// is usually indicated by the type. See
// [Transition.vehicle_loads][google.maps.routeoptimization.v1.ShipmentRoute.Transition.vehicle_loads].
Amount int64 `protobuf:"varint,1,opt,name=amount,proto3" json:"amount,omitempty"`
// contains filtered or unexported fields
}Reports the actual load of the vehicle at some point along the route, for a given type (see [Transition.vehicle_loads][google.maps.routeoptimization.v1.ShipmentRoute.Transition.vehicle_loads]).
func (*ShipmentRoute_VehicleLoad) Descriptor
func (*ShipmentRoute_VehicleLoad) Descriptor() ([]byte, []int)Deprecated: Use ShipmentRoute_VehicleLoad.ProtoReflect.Descriptor instead.
func (*ShipmentRoute_VehicleLoad) GetAmount
func (x *ShipmentRoute_VehicleLoad) GetAmount() int64func (*ShipmentRoute_VehicleLoad) ProtoMessage
func (*ShipmentRoute_VehicleLoad) ProtoMessage()func (*ShipmentRoute_VehicleLoad) ProtoReflect
func (x *ShipmentRoute_VehicleLoad) ProtoReflect() protoreflect.Messagefunc (*ShipmentRoute_VehicleLoad) Reset
func (x *ShipmentRoute_VehicleLoad) Reset()func (*ShipmentRoute_VehicleLoad) String
func (x *ShipmentRoute_VehicleLoad) String() stringShipmentRoute_Visit
type ShipmentRoute_Visit struct {
// Index of the `shipments` field in the source
// [ShipmentModel][google.maps.routeoptimization.v1.ShipmentModel].
ShipmentIndex int32 `protobuf:"varint,1,opt,name=shipment_index,json=shipmentIndex,proto3" json:"shipment_index,omitempty"`
// If true the visit corresponds to a pickup of a `Shipment`. Otherwise, it
// corresponds to a delivery.
IsPickup bool `protobuf:"varint,2,opt,name=is_pickup,json=isPickup,proto3" json:"is_pickup,omitempty"`
// Index of `VisitRequest` in either the pickup or delivery field of the
// `Shipment` (see `is_pickup`).
VisitRequestIndex int32 `protobuf:"varint,3,opt,name=visit_request_index,json=visitRequestIndex,proto3" json:"visit_request_index,omitempty"`
// Time at which the visit starts. Note that the vehicle may arrive earlier
// than this at the visit location. Times are consistent with the
// `ShipmentModel`.
StartTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Total visit load demand as the sum of the shipment and the visit request
// `load_demands`. The values are negative if the visit is a delivery.
// Demands are reported for the same types as the
// [Transition.loads][google.maps.routeoptimization.v1.ShipmentRoute.Transition]
// (see this field).
LoadDemands map[string]*Shipment_Load `protobuf:"bytes,11,rep,name=load_demands,json=loadDemands,proto3" json:"load_demands,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Extra detour time due to the shipments visited on the route before the
// visit and to the potential waiting time induced by time windows.
// If the visit is a delivery, the detour is computed from the corresponding
// pickup visit and is equal to:
// ```
// start_time(delivery) - start_time(pickup)
// - (duration(pickup) + travel duration from the pickup location
// to the delivery location).
// ```
// Otherwise, it is computed from the vehicle `start_location` and is equal
// to:
// ```
// start_time - vehicle_start_time - travel duration from
// the vehicle's `start_location` to the visit.
// ```
Detour *durationpb.Duration `protobuf:"bytes,6,opt,name=detour,proto3" json:"detour,omitempty"`
// Copy of the corresponding `Shipment.label`, if specified in the
// `Shipment`.
ShipmentLabel string `protobuf:"bytes,7,opt,name=shipment_label,json=shipmentLabel,proto3" json:"shipment_label,omitempty"`
// Copy of the corresponding
// [VisitRequest.label][google.maps.routeoptimization.v1.Shipment.VisitRequest.label],
// if specified in the `VisitRequest`.
VisitLabel string `protobuf:"bytes,8,opt,name=visit_label,json=visitLabel,proto3" json:"visit_label,omitempty"`
// An opaque token representing information about a visit location.
//
// This field may be populated in the result routes' visits when
// [VisitRequest.avoid_u_turns][google.maps.routeoptimization.v1.Shipment.VisitRequest.avoid_u_turns]
// was set to true for this visit or if
// [ShipmentModel.avoid_u_turns][google.maps.routeoptimization.v1.ShipmentModel.avoid_u_turns]
// was set to true in the request
// [OptimizeToursRequest][google.maps.routeoptimization.v1.OptimizeToursRequest].
//
// Experimental: See
// https://developers.google.com/maps/tt/route-optimization/experimental/u-turn-avoidance/make-request
// for more details.
InjectedSolutionLocationToken *int32 `protobuf:"varint,13,opt,name=injected_solution_location_token,json=injectedSolutionLocationToken,proto3,oneof" json:"injected_solution_location_token,omitempty"`
// contains filtered or unexported fields
}A visit performed during a route. This visit corresponds to a pickup or a
delivery of a Shipment.
func (*ShipmentRoute_Visit) Descriptor
func (*ShipmentRoute_Visit) Descriptor() ([]byte, []int)Deprecated: Use ShipmentRoute_Visit.ProtoReflect.Descriptor instead.
func (*ShipmentRoute_Visit) GetDetour
func (x *ShipmentRoute_Visit) GetDetour() *durationpb.Durationfunc (*ShipmentRoute_Visit) GetInjectedSolutionLocationToken
func (x *ShipmentRoute_Visit) GetInjectedSolutionLocationToken() int32func (*ShipmentRoute_Visit) GetIsPickup
func (x *ShipmentRoute_Visit) GetIsPickup() boolfunc (*ShipmentRoute_Visit) GetLoadDemands
func (x *ShipmentRoute_Visit) GetLoadDemands() map[string]*Shipment_Loadfunc (*ShipmentRoute_Visit) GetShipmentIndex
func (x *ShipmentRoute_Visit) GetShipmentIndex() int32func (*ShipmentRoute_Visit) GetShipmentLabel
func (x *ShipmentRoute_Visit) GetShipmentLabel() stringfunc (*ShipmentRoute_Visit) GetStartTime
func (x *ShipmentRoute_Visit) GetStartTime() *timestamppb.Timestampfunc (*ShipmentRoute_Visit) GetVisitLabel
func (x *ShipmentRoute_Visit) GetVisitLabel() stringfunc (*ShipmentRoute_Visit) GetVisitRequestIndex
func (x *ShipmentRoute_Visit) GetVisitRequestIndex() int32func (*ShipmentRoute_Visit) ProtoMessage
func (*ShipmentRoute_Visit) ProtoMessage()func (*ShipmentRoute_Visit) ProtoReflect
func (x *ShipmentRoute_Visit) ProtoReflect() protoreflect.Messagefunc (*ShipmentRoute_Visit) Reset
func (x *ShipmentRoute_Visit) Reset()func (*ShipmentRoute_Visit) String
func (x *ShipmentRoute_Visit) String() stringShipmentTypeIncompatibility
type ShipmentTypeIncompatibility struct {
// List of incompatible types. Two shipments having different `shipment_types`
// among those listed are "incompatible".
Types []string `protobuf:"bytes,1,rep,name=types,proto3" json:"types,omitempty"`
// Mode applied to the incompatibility.
IncompatibilityMode ShipmentTypeIncompatibility_IncompatibilityMode `protobuf:"varint,2,opt,name=incompatibility_mode,json=incompatibilityMode,proto3,enum=google.maps.routeoptimization.v1.ShipmentTypeIncompatibility_IncompatibilityMode" json:"incompatibility_mode,omitempty"`
// contains filtered or unexported fields
}Specifies incompatibilties between shipments depending on their shipment_type. The appearance of incompatible shipments on the same route is restricted based on the incompatibility mode.
func (*ShipmentTypeIncompatibility) Descriptor
func (*ShipmentTypeIncompatibility) Descriptor() ([]byte, []int)Deprecated: Use ShipmentTypeIncompatibility.ProtoReflect.Descriptor instead.
func (*ShipmentTypeIncompatibility) GetIncompatibilityMode
func (x *ShipmentTypeIncompatibility) GetIncompatibilityMode() ShipmentTypeIncompatibility_IncompatibilityModefunc (*ShipmentTypeIncompatibility) GetTypes
func (x *ShipmentTypeIncompatibility) GetTypes() []stringfunc (*ShipmentTypeIncompatibility) ProtoMessage
func (*ShipmentTypeIncompatibility) ProtoMessage()func (*ShipmentTypeIncompatibility) ProtoReflect
func (x *ShipmentTypeIncompatibility) ProtoReflect() protoreflect.Messagefunc (*ShipmentTypeIncompatibility) Reset
func (x *ShipmentTypeIncompatibility) Reset()func (*ShipmentTypeIncompatibility) String
func (x *ShipmentTypeIncompatibility) String() stringShipmentTypeIncompatibility_IncompatibilityMode
type ShipmentTypeIncompatibility_IncompatibilityMode int32Modes defining how the appearance of incompatible shipments are restricted on the same route.
ShipmentTypeIncompatibility_INCOMPATIBILITY_MODE_UNSPECIFIED, ShipmentTypeIncompatibility_NOT_PERFORMED_BY_SAME_VEHICLE, ShipmentTypeIncompatibility_NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY
const (
// Unspecified incompatibility mode. This value should never be used.
ShipmentTypeIncompatibility_INCOMPATIBILITY_MODE_UNSPECIFIED ShipmentTypeIncompatibility_IncompatibilityMode = 0
// In this mode, two shipments with incompatible types can never share the
// same vehicle.
ShipmentTypeIncompatibility_NOT_PERFORMED_BY_SAME_VEHICLE ShipmentTypeIncompatibility_IncompatibilityMode = 1
// In this mode, two shipments with incompatible types can never be on the
// same vehicle at the same time:
// - They can share the same vehicle only if one is delivered before the
// other is picked up.
// - When both shipments are pickups-only (no deliveries) or deliveries-only
// (no pickups), they can't share the same vehicle at all.
ShipmentTypeIncompatibility_NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY ShipmentTypeIncompatibility_IncompatibilityMode = 2
)func (ShipmentTypeIncompatibility_IncompatibilityMode) Descriptor
func (ShipmentTypeIncompatibility_IncompatibilityMode) Descriptor() protoreflect.EnumDescriptorfunc (ShipmentTypeIncompatibility_IncompatibilityMode) Enum
func (x ShipmentTypeIncompatibility_IncompatibilityMode) Enum() *ShipmentTypeIncompatibility_IncompatibilityModefunc (ShipmentTypeIncompatibility_IncompatibilityMode) EnumDescriptor
func (ShipmentTypeIncompatibility_IncompatibilityMode) EnumDescriptor() ([]byte, []int)Deprecated: Use ShipmentTypeIncompatibility_IncompatibilityMode.Descriptor instead.
func (ShipmentTypeIncompatibility_IncompatibilityMode) Number
func (x ShipmentTypeIncompatibility_IncompatibilityMode) Number() protoreflect.EnumNumberfunc (ShipmentTypeIncompatibility_IncompatibilityMode) String
func (x ShipmentTypeIncompatibility_IncompatibilityMode) String() stringfunc (ShipmentTypeIncompatibility_IncompatibilityMode) Type
ShipmentTypeRequirement
type ShipmentTypeRequirement struct {
// List of alternative shipment types required by the
// `dependent_shipment_types`.
RequiredShipmentTypeAlternatives []string `protobuf:"bytes,1,rep,name=required_shipment_type_alternatives,json=requiredShipmentTypeAlternatives,proto3" json:"required_shipment_type_alternatives,omitempty"`
// All shipments with a type in the `dependent_shipment_types` field require
// at least one shipment of type `required_shipment_type_alternatives` to be
// visited on the same route.
//
// NOTE: Chains of requirements such that a `shipment_type` depends on itself
// are not allowed.
DependentShipmentTypes []string `protobuf:"bytes,2,rep,name=dependent_shipment_types,json=dependentShipmentTypes,proto3" json:"dependent_shipment_types,omitempty"`
// Mode applied to the requirement.
RequirementMode ShipmentTypeRequirement_RequirementMode `protobuf:"varint,3,opt,name=requirement_mode,json=requirementMode,proto3,enum=google.maps.routeoptimization.v1.ShipmentTypeRequirement_RequirementMode" json:"requirement_mode,omitempty"`
// contains filtered or unexported fields
}Specifies requirements between shipments based on their shipment_type. The specifics of the requirement are defined by the requirement mode.
func (*ShipmentTypeRequirement) Descriptor
func (*ShipmentTypeRequirement) Descriptor() ([]byte, []int)Deprecated: Use ShipmentTypeRequirement.ProtoReflect.Descriptor instead.
func (*ShipmentTypeRequirement) GetDependentShipmentTypes
func (x *ShipmentTypeRequirement) GetDependentShipmentTypes() []stringfunc (*ShipmentTypeRequirement) GetRequiredShipmentTypeAlternatives
func (x *ShipmentTypeRequirement) GetRequiredShipmentTypeAlternatives() []stringfunc (*ShipmentTypeRequirement) GetRequirementMode
func (x *ShipmentTypeRequirement) GetRequirementMode() ShipmentTypeRequirement_RequirementModefunc (*ShipmentTypeRequirement) ProtoMessage
func (*ShipmentTypeRequirement) ProtoMessage()func (*ShipmentTypeRequirement) ProtoReflect
func (x *ShipmentTypeRequirement) ProtoReflect() protoreflect.Messagefunc (*ShipmentTypeRequirement) Reset
func (x *ShipmentTypeRequirement) Reset()func (*ShipmentTypeRequirement) String
func (x *ShipmentTypeRequirement) String() stringShipmentTypeRequirement_RequirementMode
type ShipmentTypeRequirement_RequirementMode int32Modes defining the appearance of dependent shipments on a route.
ShipmentTypeRequirement_REQUIREMENT_MODE_UNSPECIFIED, ShipmentTypeRequirement_PERFORMED_BY_SAME_VEHICLE, ShipmentTypeRequirement_IN_SAME_VEHICLE_AT_PICKUP_TIME, ShipmentTypeRequirement_IN_SAME_VEHICLE_AT_DELIVERY_TIME
const (
// Unspecified requirement mode. This value should never be used.
ShipmentTypeRequirement_REQUIREMENT_MODE_UNSPECIFIED ShipmentTypeRequirement_RequirementMode = 0
// In this mode, all "dependent" shipments must share the same vehicle as at
// least one of their "required" shipments.
ShipmentTypeRequirement_PERFORMED_BY_SAME_VEHICLE ShipmentTypeRequirement_RequirementMode = 1
// With the `IN_SAME_VEHICLE_AT_PICKUP_TIME` mode, all "dependent"
// shipments need to have at least one "required" shipment on their vehicle
// at the time of their pickup.
//
// A "dependent" shipment pickup must therefore have either:
//
// - A delivery-only "required" shipment delivered on the route after, or
// - A "required" shipment picked up on the route before it, and if the
// "required" shipment has a delivery, this delivery must be performed
// after the "dependent" shipment's pickup.
ShipmentTypeRequirement_IN_SAME_VEHICLE_AT_PICKUP_TIME ShipmentTypeRequirement_RequirementMode = 2
// Same as before, except the "dependent" shipments need to have a
// "required" shipment on their vehicle at the time of their *delivery*.
ShipmentTypeRequirement_IN_SAME_VEHICLE_AT_DELIVERY_TIME ShipmentTypeRequirement_RequirementMode = 3
)func (ShipmentTypeRequirement_RequirementMode) Descriptor
func (ShipmentTypeRequirement_RequirementMode) Descriptor() protoreflect.EnumDescriptorfunc (ShipmentTypeRequirement_RequirementMode) Enum
func (ShipmentTypeRequirement_RequirementMode) EnumDescriptor
func (ShipmentTypeRequirement_RequirementMode) EnumDescriptor() ([]byte, []int)Deprecated: Use ShipmentTypeRequirement_RequirementMode.Descriptor instead.
func (ShipmentTypeRequirement_RequirementMode) Number
func (x ShipmentTypeRequirement_RequirementMode) Number() protoreflect.EnumNumberfunc (ShipmentTypeRequirement_RequirementMode) String
func (x ShipmentTypeRequirement_RequirementMode) String() stringfunc (ShipmentTypeRequirement_RequirementMode) Type
func (ShipmentTypeRequirement_RequirementMode) Type() protoreflect.EnumTypeShipment_Load
type Shipment_Load struct {
// The amount by which the load of the vehicle performing the corresponding
// visit will vary. Since it is an integer, users are advised to choose an
// appropriate unit to avoid loss of precision. Must be ≥ 0.
Amount int64 `protobuf:"varint,2,opt,name=amount,proto3" json:"amount,omitempty"`
// contains filtered or unexported fields
}When performing a visit, a predefined amount may be added to the vehicle load if it's a pickup, or subtracted if it's a delivery. This message defines such amount. See [load_demands][google.maps.routeoptimization.v1.Shipment.load_demands].
func (*Shipment_Load) Descriptor
func (*Shipment_Load) Descriptor() ([]byte, []int)Deprecated: Use Shipment_Load.ProtoReflect.Descriptor instead.
func (*Shipment_Load) GetAmount
func (x *Shipment_Load) GetAmount() int64func (*Shipment_Load) ProtoMessage
func (*Shipment_Load) ProtoMessage()func (*Shipment_Load) ProtoReflect
func (x *Shipment_Load) ProtoReflect() protoreflect.Messagefunc (*Shipment_Load) Reset
func (x *Shipment_Load) Reset()func (*Shipment_Load) String
func (x *Shipment_Load) String() stringShipment_VisitRequest
type Shipment_VisitRequest struct {
// The geo-location where the vehicle arrives when performing this
// `VisitRequest`. If the shipment model has duration distance matrices,
// `arrival_location` must not be specified.
ArrivalLocation *latlng.LatLng `protobuf:"bytes,1,opt,name=arrival_location,json=arrivalLocation,proto3" json:"arrival_location,omitempty"`
// The waypoint where the vehicle arrives when performing this
// `VisitRequest`. If the shipment model has duration distance matrices,
// `arrival_waypoint` must not be specified.
ArrivalWaypoint *Waypoint `protobuf:"bytes,2,opt,name=arrival_waypoint,json=arrivalWaypoint,proto3" json:"arrival_waypoint,omitempty"`
// The geo-location where the vehicle departs after completing this
// `VisitRequest`. Can be omitted if it is the same as `arrival_location`.
// If the shipment model has duration distance matrices,
// `departure_location` must not be specified.
DepartureLocation *latlng.LatLng `protobuf:"bytes,3,opt,name=departure_location,json=departureLocation,proto3" json:"departure_location,omitempty"`
// The waypoint where the vehicle departs after completing this
// `VisitRequest`. Can be omitted if it is the same as `arrival_waypoint`.
// If the shipment model has duration distance matrices,
// `departure_waypoint` must not be specified.
DepartureWaypoint *Waypoint `protobuf:"bytes,4,opt,name=departure_waypoint,json=departureWaypoint,proto3" json:"departure_waypoint,omitempty"`
// Specifies tags attached to the visit request.
// Empty or duplicate strings are not allowed.
Tags []string `protobuf:"bytes,5,rep,name=tags,proto3" json:"tags,omitempty"`
// Time windows which constrain the arrival time at a visit.
// Note that a vehicle may depart outside of the arrival time window, i.e.
// arrival time + duration do not need to be inside a time window. This can
// result in waiting time if the vehicle arrives before
// [TimeWindow.start_time][google.maps.routeoptimization.v1.TimeWindow.start_time].
//
// The absence of `TimeWindow` means that the vehicle can perform this visit
// at any time.
//
// Time windows must be disjoint, i.e. no time window must overlap with or
// be adjacent to another, and they must be in increasing order.
//
// `cost_per_hour_after_soft_end_time` and `soft_end_time` can only
// be set if there is a single time window.
TimeWindows []*TimeWindow `protobuf:"bytes,6,rep,name=time_windows,json=timeWindows,proto3" json:"time_windows,omitempty"`
// Duration of the visit, i.e. time spent by the vehicle between arrival
// and departure (to be added to the possible waiting time; see
// `time_windows`).
Duration *durationpb.Duration `protobuf:"bytes,7,opt,name=duration,proto3" json:"duration,omitempty"`
// Cost to service this visit request on a vehicle route. This can be used
// to pay different costs for each alternative pickup or delivery of a
// shipment. This cost must be in the same unit as `Shipment.penalty_cost`
// and must not be negative.
Cost float64 `protobuf:"fixed64,8,opt,name=cost,proto3" json:"cost,omitempty"`
// Load demands of this visit request. This is just like
// [Shipment.load_demands][google.maps.routeoptimization.v1.Shipment.load_demands]
// field, except that it only applies to this
// [VisitRequest][google.maps.routeoptimization.v1.Shipment.VisitRequest]
// instead of the whole
// [Shipment][google.maps.routeoptimization.v1.Shipment]. The demands listed
// here are added to the demands listed in
// [Shipment.load_demands][google.maps.routeoptimization.v1.Shipment.load_demands].
LoadDemands map[string]*Shipment_Load `protobuf:"bytes,12,rep,name=load_demands,json=loadDemands,proto3" json:"load_demands,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Specifies the types of the visit. This may be used to allocate additional
// time required for a vehicle to complete this visit (see
// [Vehicle.extra_visit_duration_for_visit_type][google.maps.routeoptimization.v1.Vehicle.extra_visit_duration_for_visit_type]).
//
// A type can only appear once.
VisitTypes []string `protobuf:"bytes,10,rep,name=visit_types,json=visitTypes,proto3" json:"visit_types,omitempty"`
// Specifies a label for this `VisitRequest`. This label is reported in the
// response as `visit_label` in the corresponding
// [ShipmentRoute.Visit][google.maps.routeoptimization.v1.ShipmentRoute.Visit].
Label string `protobuf:"bytes,11,opt,name=label,proto3" json:"label,omitempty"`
// Specifies whether U-turns should be avoided in driving routes at this
// location.
// U-turn avoidance is best effort and complete avoidance is not guaranteed.
// This is an experimental feature and behavior is subject to change.
//
// Experimental: See
// https://developers.google.com/maps/tt/route-optimization/experimental/u-turn-avoidance/make-request
// for more details.
AvoidUTurns *bool `protobuf:"varint,13,opt,name=avoid_u_turns,json=avoidUTurns,proto3,oneof" json:"avoid_u_turns,omitempty"`
// contains filtered or unexported fields
}Request for a visit which can be done by a vehicle: it has a geo-location (or two, see below), opening and closing times represented by time windows, and a service duration time (time spent by the vehicle once it has arrived to pickup or drop off goods).
func (*Shipment_VisitRequest) Descriptor
func (*Shipment_VisitRequest) Descriptor() ([]byte, []int)Deprecated: Use Shipment_VisitRequest.ProtoReflect.Descriptor instead.
func (*Shipment_VisitRequest) GetArrivalLocation
func (x *Shipment_VisitRequest) GetArrivalLocation() *latlng.LatLngfunc (*Shipment_VisitRequest) GetArrivalWaypoint
func (x *Shipment_VisitRequest) GetArrivalWaypoint() *Waypointfunc (*Shipment_VisitRequest) GetAvoidUTurns
func (x *Shipment_VisitRequest) GetAvoidUTurns() boolfunc (*Shipment_VisitRequest) GetCost
func (x *Shipment_VisitRequest) GetCost() float64func (*Shipment_VisitRequest) GetDepartureLocation
func (x *Shipment_VisitRequest) GetDepartureLocation() *latlng.LatLngfunc (*Shipment_VisitRequest) GetDepartureWaypoint
func (x *Shipment_VisitRequest) GetDepartureWaypoint() *Waypointfunc (*Shipment_VisitRequest) GetDuration
func (x *Shipment_VisitRequest) GetDuration() *durationpb.Durationfunc (*Shipment_VisitRequest) GetLabel
func (x *Shipment_VisitRequest) GetLabel() stringfunc (*Shipment_VisitRequest) GetLoadDemands
func (x *Shipment_VisitRequest) GetLoadDemands() map[string]*Shipment_Loadfunc (*Shipment_VisitRequest) GetTags
func (x *Shipment_VisitRequest) GetTags() []stringfunc (*Shipment_VisitRequest) GetTimeWindows
func (x *Shipment_VisitRequest) GetTimeWindows() []*TimeWindowfunc (*Shipment_VisitRequest) GetVisitTypes
func (x *Shipment_VisitRequest) GetVisitTypes() []stringfunc (*Shipment_VisitRequest) ProtoMessage
func (*Shipment_VisitRequest) ProtoMessage()func (*Shipment_VisitRequest) ProtoReflect
func (x *Shipment_VisitRequest) ProtoReflect() protoreflect.Messagefunc (*Shipment_VisitRequest) Reset
func (x *Shipment_VisitRequest) Reset()func (*Shipment_VisitRequest) String
func (x *Shipment_VisitRequest) String() stringSkippedShipment
type SkippedShipment struct {
// The index corresponds to the index of the shipment in the source
// `ShipmentModel`.
Index int32 `protobuf:"varint,1,opt,name=index,proto3" json:"index,omitempty"`
// Copy of the corresponding
// [Shipment.label][google.maps.routeoptimization.v1.Shipment.label], if
// specified in the `Shipment`.
Label string `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"`
// This is a copy of the
// [Shipment.penalty_cost][google.maps.routeoptimization.v1.Shipment.penalty_cost],
// included here to make it easier to see the severity of a skipped shipment.
//
// Experimental: This field's behavior or existence may change in future.
PenaltyCost *float64 `protobuf:"fixed64,6,opt,name=penalty_cost,json=penaltyCost,proto3,oneof" json:"penalty_cost,omitempty"`
// Estimated ratio of vehicles that cannot perform this shipment for at least
// one of the reasons below.
// Note: this is only filled when reasons involve a vehicle.
//
// Experimental: This field's behavior or existence may change in future.
EstimatedIncompatibleVehicleRatio *float64 `protobuf:"fixed64,5,opt,name=estimated_incompatible_vehicle_ratio,json=estimatedIncompatibleVehicleRatio,proto3,oneof" json:"estimated_incompatible_vehicle_ratio,omitempty"`
// A list of reasons that explain why the shipment was skipped. See comment
// above `Reason`. If we are unable to understand why a shipment was skipped,
// reasons will not be set.
Reasons []*SkippedShipment_Reason `protobuf:"bytes,3,rep,name=reasons,proto3" json:"reasons,omitempty"`
// contains filtered or unexported fields
}Specifies details of unperformed shipments in a solution. For trivial cases and/or if we are able to identify the cause for skipping, we report the reason here.
func (*SkippedShipment) Descriptor
func (*SkippedShipment) Descriptor() ([]byte, []int)Deprecated: Use SkippedShipment.ProtoReflect.Descriptor instead.
func (*SkippedShipment) GetEstimatedIncompatibleVehicleRatio
func (x *SkippedShipment) GetEstimatedIncompatibleVehicleRatio() float64func (*SkippedShipment) GetIndex
func (x *SkippedShipment) GetIndex() int32func (*SkippedShipment) GetLabel
func (x *SkippedShipment) GetLabel() stringfunc (*SkippedShipment) GetPenaltyCost
func (x *SkippedShipment) GetPenaltyCost() float64func (*SkippedShipment) GetReasons
func (x *SkippedShipment) GetReasons() []*SkippedShipment_Reasonfunc (*SkippedShipment) ProtoMessage
func (*SkippedShipment) ProtoMessage()func (*SkippedShipment) ProtoReflect
func (x *SkippedShipment) ProtoReflect() protoreflect.Messagefunc (*SkippedShipment) Reset
func (x *SkippedShipment) Reset()func (*SkippedShipment) String
func (x *SkippedShipment) String() stringSkippedShipment_Reason
type SkippedShipment_Reason struct {
// Refer to the comments of Code.
Code SkippedShipment_Reason_Code `protobuf:"varint,1,opt,name=code,proto3,enum=google.maps.routeoptimization.v1.SkippedShipment_Reason_Code" json:"code,omitempty"`
// If the reason is related to a shipment-vehicle incompatibility, this
// field provides the index of one relevant vehicle.
ExampleVehicleIndex *int32 `protobuf:"varint,2,opt,name=example_vehicle_index,json=exampleVehicleIndex,proto3,oneof" json:"example_vehicle_index,omitempty"`
// Same as
// [example_vehicle_index][google.maps.routeoptimization.v1.SkippedShipment.Reason.example_vehicle_index]
// except that we provide the list of multiple identified vehicles. This
// list is not necessarily exhaustive. This is only filled if
// [fill_example_vehicle_indices_in_skipped_reasons][] is true.
//
// Experimental: This field's behavior or existence may change in future.
ExampleVehicleIndices []int32 `protobuf:"varint,5,rep,packed,name=example_vehicle_indices,json=exampleVehicleIndices,proto3" json:"example_vehicle_indices,omitempty"`
// If the reason code is `DEMAND_EXCEEDS_VEHICLE_CAPACITY`, documents one
// capacity type that is exceeded.
ExampleExceededCapacityType string `protobuf:"bytes,3,opt,name=example_exceeded_capacity_type,json=exampleExceededCapacityType,proto3" json:"example_exceeded_capacity_type,omitempty"`
// contains filtered or unexported fields
}If we can explain why the shipment was skipped, reasons will be listed
here. If the reason is not the same for all vehicles, reason will have
more than 1 element. A skipped shipment cannot have duplicate reasons,
i.e. where all fields are the same except for example_vehicle_index.
Example:
reasons {
code: DEMAND_EXCEEDS_VEHICLE_CAPACITY
example_vehicle_index: 1
example_exceeded_capacity_type: "Apples"
}
reasons {
code: DEMAND_EXCEEDS_VEHICLE_CAPACITY
example_vehicle_index: 3
example_exceeded_capacity_type: "Pears"
}
reasons {
code: CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT
example_vehicle_index: 1
}
The skipped shipment is incompatible with all vehicles. The reasons may be different for all vehicles but at least one vehicle's "Apples" capacity would be exceeded (including vehicle 1), at least one vehicle's "Pears" capacity would be exceeded (including vehicle 3) and at least one vehicle's distance limit would be exceeded (including vehicle 1).
func (*SkippedShipment_Reason) Descriptor
func (*SkippedShipment_Reason) Descriptor() ([]byte, []int)Deprecated: Use SkippedShipment_Reason.ProtoReflect.Descriptor instead.
func (*SkippedShipment_Reason) GetCode
func (x *SkippedShipment_Reason) GetCode() SkippedShipment_Reason_Codefunc (*SkippedShipment_Reason) GetExampleExceededCapacityType
func (x *SkippedShipment_Reason) GetExampleExceededCapacityType() stringfunc (*SkippedShipment_Reason) GetExampleVehicleIndex
func (x *SkippedShipment_Reason) GetExampleVehicleIndex() int32func (*SkippedShipment_Reason) GetExampleVehicleIndices
func (x *SkippedShipment_Reason) GetExampleVehicleIndices() []int32func (*SkippedShipment_Reason) ProtoMessage
func (*SkippedShipment_Reason) ProtoMessage()func (*SkippedShipment_Reason) ProtoReflect
func (x *SkippedShipment_Reason) ProtoReflect() protoreflect.Messagefunc (*SkippedShipment_Reason) Reset
func (x *SkippedShipment_Reason) Reset()func (*SkippedShipment_Reason) String
func (x *SkippedShipment_Reason) String() stringSkippedShipment_Reason_Code
type SkippedShipment_Reason_Code int32Code identifying the reason type. The order here is meaningless. In particular, it gives no indication of whether a given reason will appear before another in the solution, if both apply.
SkippedShipment_Reason_CODE_UNSPECIFIED, SkippedShipment_Reason_NO_VEHICLE, SkippedShipment_Reason_DEMAND_EXCEEDS_VEHICLE_CAPACITY, SkippedShipment_Reason_CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT, SkippedShipment_Reason_CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT, SkippedShipment_Reason_CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT, SkippedShipment_Reason_CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS, SkippedShipment_Reason_VEHICLE_NOT_ALLOWED, SkippedShipment_Reason_VEHICLE_IGNORED, SkippedShipment_Reason_SHIPMENT_IGNORED, SkippedShipment_Reason_SKIPPED_IN_INJECTED_SOLUTION_CONSTRAINT, SkippedShipment_Reason_VEHICLE_ROUTE_IS_FULLY_SEQUENCE_CONSTRAINED, SkippedShipment_Reason_ZERO_PENALTY_COST
const (
// This should never be used.
SkippedShipment_Reason_CODE_UNSPECIFIED SkippedShipment_Reason_Code = 0
// There is no vehicle in the model making all shipments infeasible.
SkippedShipment_Reason_NO_VEHICLE SkippedShipment_Reason_Code = 1
// The demand of the shipment exceeds a vehicle's capacity for some
// capacity types, one of which is `example_exceeded_capacity_type`.
SkippedShipment_Reason_DEMAND_EXCEEDS_VEHICLE_CAPACITY SkippedShipment_Reason_Code = 2
// The minimum distance necessary to perform this shipment, i.e. from
// the vehicle's `start_location` to the shipment's pickup and/or delivery
// locations and to the vehicle's end location exceeds the vehicle's
// `route_distance_limit`.
//
// Note that for this computation we use the geodesic distances.
SkippedShipment_Reason_CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT SkippedShipment_Reason_Code = 3
// The minimum time necessary to perform this shipment, including travel
// time, wait time and service time exceeds the vehicle's
// `route_duration_limit`.
//
// Note: travel time is computed in the best-case scenario, namely as
// geodesic distance x 36 m/s (roughly 130 km/hour).
SkippedShipment_Reason_CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT SkippedShipment_Reason_Code = 4
// Same as above but we only compare minimum travel time and the
// vehicle's `travel_duration_limit`.
SkippedShipment_Reason_CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT SkippedShipment_Reason_Code = 5
// The vehicle cannot perform this shipment in the best-case scenario
// (see `CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT` for time
// computation) if it starts at its earliest start time: the total time
// would make the vehicle end after its latest end time.
SkippedShipment_Reason_CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS SkippedShipment_Reason_Code = 6
// The `allowed_vehicle_indices` field of the shipment is not empty and
// this vehicle does not belong to it.
SkippedShipment_Reason_VEHICLE_NOT_ALLOWED SkippedShipment_Reason_Code = 7
// The vehicle's `ignore` field is true.
//
// Experimental: This field's behavior or existence may change in future.
SkippedShipment_Reason_VEHICLE_IGNORED SkippedShipment_Reason_Code = 8
// The shipment's `ignore` field is true.
//
// Experimental: This field's behavior or existence may change in future.
SkippedShipment_Reason_SHIPMENT_IGNORED SkippedShipment_Reason_Code = 9
// The shipment is skipped in the `injected_solution_constraint`.
//
// Experimental: This field's behavior or existence may change in future.
SkippedShipment_Reason_SKIPPED_IN_INJECTED_SOLUTION_CONSTRAINT SkippedShipment_Reason_Code = 10
// The vehicle route relaxation specified in the
// `injected_solution_constraint` doesn't permit any visit to be inserted.
//
// Experimental: This field's behavior or existence may change in future.
SkippedShipment_Reason_VEHICLE_ROUTE_IS_FULLY_SEQUENCE_CONSTRAINED SkippedShipment_Reason_Code = 11
// The shipment has a zero penalty cost. While this can be useful as an
// advanced modelling choice, it may also explain after the fact why a
// shipment was skipped.
//
// Experimental: This field's behavior or existence may change in future.
SkippedShipment_Reason_ZERO_PENALTY_COST SkippedShipment_Reason_Code = 13
)func (SkippedShipment_Reason_Code) Descriptor
func (SkippedShipment_Reason_Code) Descriptor() protoreflect.EnumDescriptorfunc (SkippedShipment_Reason_Code) Enum
func (x SkippedShipment_Reason_Code) Enum() *SkippedShipment_Reason_Codefunc (SkippedShipment_Reason_Code) EnumDescriptor
func (SkippedShipment_Reason_Code) EnumDescriptor() ([]byte, []int)Deprecated: Use SkippedShipment_Reason_Code.Descriptor instead.
func (SkippedShipment_Reason_Code) Number
func (x SkippedShipment_Reason_Code) Number() protoreflect.EnumNumberfunc (SkippedShipment_Reason_Code) String
func (x SkippedShipment_Reason_Code) String() stringfunc (SkippedShipment_Reason_Code) Type
func (SkippedShipment_Reason_Code) Type() protoreflect.EnumTypeTimeWindow
type TimeWindow struct {
// The hard time window start time. If unspecified it will be set to
// `ShipmentModel.global_start_time`.
StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// The hard time window end time. If unspecified it will be set to
// `ShipmentModel.global_end_time`.
EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// The soft start time of the time window.
SoftStartTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=soft_start_time,json=softStartTime,proto3" json:"soft_start_time,omitempty"`
// The soft end time of the time window.
SoftEndTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=soft_end_time,json=softEndTime,proto3" json:"soft_end_time,omitempty"`
// A cost per hour added to other costs in the model if the event occurs
// before soft_start_time, computed as:
//
// ```
//
// max(0, soft_start_time - t.seconds)
// * cost_per_hour_before_soft_start_time / 3600,
//
// t being the time of the event.
// ```
//
// This cost must be positive, and the field can only be set if
// soft_start_time has been set.
CostPerHourBeforeSoftStartTime *float64 `protobuf:"fixed64,5,opt,name=cost_per_hour_before_soft_start_time,json=costPerHourBeforeSoftStartTime,proto3,oneof" json:"cost_per_hour_before_soft_start_time,omitempty"`
// A cost per hour added to other costs in the model if the event occurs after
// `soft_end_time`, computed as:
//
// ```
//
// max(0, t.seconds - soft_end_time.seconds)
// * cost_per_hour_after_soft_end_time / 3600,
//
// t being the time of the event.
// ```
//
// This cost must be positive, and the field can only be set if
// `soft_end_time` has been set.
CostPerHourAfterSoftEndTime *float64 `protobuf:"fixed64,6,opt,name=cost_per_hour_after_soft_end_time,json=costPerHourAfterSoftEndTime,proto3,oneof" json:"cost_per_hour_after_soft_end_time,omitempty"`
// contains filtered or unexported fields
}Time windows constrain the time of an event, such as the arrival time at a visit, or the start and end time of a vehicle.
Hard time window bounds, start_time and end_time, enforce the earliest
and latest time of the event, such that start_time <= event_time <=
end_time. The soft time window lower bound, soft_start_time, expresses a
preference for the event to happen at or after soft_start_time by incurring
a cost proportional to how long before soft_start_time the event occurs. The
soft time window upper bound, soft_end_time, expresses a preference for the
event to happen at or before soft_end_time by incurring a cost proportional
to how long after soft_end_time the event occurs. start_time, end_time,
soft_start_time and soft_end_time should be within the global time limits
(see
[ShipmentModel.global_start_time][google.maps.routeoptimization.v1.ShipmentModel.global_start_time]
and
[ShipmentModel.global_end_time][google.maps.routeoptimization.v1.ShipmentModel.global_end_time])
and should respect:
0 <= `start_time` <= `end_time` and
0 <= `start_time` <= `soft_start_time` and
0 <= `soft_end_time` <= `end_time`.
func (*TimeWindow) Descriptor
func (*TimeWindow) Descriptor() ([]byte, []int)Deprecated: Use TimeWindow.ProtoReflect.Descriptor instead.
func (*TimeWindow) GetCostPerHourAfterSoftEndTime
func (x *TimeWindow) GetCostPerHourAfterSoftEndTime() float64func (*TimeWindow) GetCostPerHourBeforeSoftStartTime
func (x *TimeWindow) GetCostPerHourBeforeSoftStartTime() float64func (*TimeWindow) GetEndTime
func (x *TimeWindow) GetEndTime() *timestamppb.Timestampfunc (*TimeWindow) GetSoftEndTime
func (x *TimeWindow) GetSoftEndTime() *timestamppb.Timestampfunc (*TimeWindow) GetSoftStartTime
func (x *TimeWindow) GetSoftStartTime() *timestamppb.Timestampfunc (*TimeWindow) GetStartTime
func (x *TimeWindow) GetStartTime() *timestamppb.Timestampfunc (*TimeWindow) ProtoMessage
func (*TimeWindow) ProtoMessage()func (*TimeWindow) ProtoReflect
func (x *TimeWindow) ProtoReflect() protoreflect.Messagefunc (*TimeWindow) Reset
func (x *TimeWindow) Reset()func (*TimeWindow) String
func (x *TimeWindow) String() stringTransitionAttributes
type TransitionAttributes struct {
// Tags defining the set of (src->dst) transitions these attributes apply to.
//
// A source visit or vehicle start matches iff its
// [VisitRequest.tags][google.maps.routeoptimization.v1.Shipment.VisitRequest.tags]
// or
// [Vehicle.start_tags][google.maps.routeoptimization.v1.Vehicle.start_tags]
// either contains `src_tag` or does not contain `excluded_src_tag` (depending
// on which of these two fields is non-empty).
SrcTag string `protobuf:"bytes,1,opt,name=src_tag,json=srcTag,proto3" json:"src_tag,omitempty"`
// See `src_tag`. Exactly one of `src_tag` and `excluded_src_tag` must be
// non-empty.
ExcludedSrcTag string `protobuf:"bytes,2,opt,name=excluded_src_tag,json=excludedSrcTag,proto3" json:"excluded_src_tag,omitempty"`
// A destination visit or vehicle end matches iff its
// [VisitRequest.tags][google.maps.routeoptimization.v1.Shipment.VisitRequest.tags]
// or [Vehicle.end_tags][google.maps.routeoptimization.v1.Vehicle.end_tags]
// either contains `dst_tag` or does not contain `excluded_dst_tag` (depending
// on which of these two fields is non-empty).
DstTag string `protobuf:"bytes,3,opt,name=dst_tag,json=dstTag,proto3" json:"dst_tag,omitempty"`
// See `dst_tag`. Exactly one of `dst_tag` and `excluded_dst_tag` must be
// non-empty.
ExcludedDstTag string `protobuf:"bytes,4,opt,name=excluded_dst_tag,json=excludedDstTag,proto3" json:"excluded_dst_tag,omitempty"`
// Specifies a cost for performing this transition. This is in the same unit
// as all other costs in the model and must not be negative. It is applied on
// top of all other existing costs.
Cost float64 `protobuf:"fixed64,5,opt,name=cost,proto3" json:"cost,omitempty"`
// Specifies a cost per kilometer applied to the distance traveled while
// performing this transition. It adds up to any
// [Vehicle.cost_per_kilometer][google.maps.routeoptimization.v1.Vehicle.cost_per_kilometer]
// specified on vehicles.
CostPerKilometer float64 `protobuf:"fixed64,6,opt,name=cost_per_kilometer,json=costPerKilometer,proto3" json:"cost_per_kilometer,omitempty"`
// Specifies a limit on the distance traveled while performing this
// transition.
//
// As of 2021/06, only soft limits are supported.
DistanceLimit *DistanceLimit `protobuf:"bytes,7,opt,name=distance_limit,json=distanceLimit,proto3" json:"distance_limit,omitempty"`
// Specifies a delay incurred when performing this transition.
//
// This delay always occurs *after* finishing the source visit and *before*
// starting the destination visit.
Delay *durationpb.Duration `protobuf:"bytes,8,opt,name=delay,proto3" json:"delay,omitempty"`
// contains filtered or unexported fields
}Specifies attributes of transitions between two consecutive visits on a
route. Several TransitionAttributes may apply to the same transition: in
that case, all extra costs add up and the strictest constraint or limit
applies (following natural "AND" semantics).
func (*TransitionAttributes) Descriptor
func (*TransitionAttributes) Descriptor() ([]byte, []int)Deprecated: Use TransitionAttributes.ProtoReflect.Descriptor instead.
func (*TransitionAttributes) GetCost
func (x *TransitionAttributes) GetCost() float64func (*TransitionAttributes) GetCostPerKilometer
func (x *TransitionAttributes) GetCostPerKilometer() float64func (*TransitionAttributes) GetDelay
func (x *TransitionAttributes) GetDelay() *durationpb.Durationfunc (*TransitionAttributes) GetDistanceLimit
func (x *TransitionAttributes) GetDistanceLimit() *DistanceLimitfunc (*TransitionAttributes) GetDstTag
func (x *TransitionAttributes) GetDstTag() stringfunc (*TransitionAttributes) GetExcludedDstTag
func (x *TransitionAttributes) GetExcludedDstTag() stringfunc (*TransitionAttributes) GetExcludedSrcTag
func (x *TransitionAttributes) GetExcludedSrcTag() stringfunc (*TransitionAttributes) GetSrcTag
func (x *TransitionAttributes) GetSrcTag() stringfunc (*TransitionAttributes) ProtoMessage
func (*TransitionAttributes) ProtoMessage()func (*TransitionAttributes) ProtoReflect
func (x *TransitionAttributes) ProtoReflect() protoreflect.Messagefunc (*TransitionAttributes) Reset
func (x *TransitionAttributes) Reset()func (*TransitionAttributes) String
func (x *TransitionAttributes) String() stringUnimplementedRouteOptimizationServer
type UnimplementedRouteOptimizationServer struct {
}UnimplementedRouteOptimizationServer should be embedded to have forward compatible implementations.
func (UnimplementedRouteOptimizationServer) BatchOptimizeTours
func (UnimplementedRouteOptimizationServer) BatchOptimizeTours(context.Context, *BatchOptimizeToursRequest) (*longrunningpb.Operation, error)func (UnimplementedRouteOptimizationServer) OptimizeTours
func (UnimplementedRouteOptimizationServer) OptimizeTours(context.Context, *OptimizeToursRequest) (*OptimizeToursResponse, error)func (UnimplementedRouteOptimizationServer) OptimizeToursLongRunning
func (UnimplementedRouteOptimizationServer) OptimizeToursLongRunning(context.Context, *OptimizeToursRequest) (*longrunningpb.Operation, error)func (UnimplementedRouteOptimizationServer) OptimizeToursUri
func (UnimplementedRouteOptimizationServer) OptimizeToursUri(context.Context, *OptimizeToursUriRequest) (*longrunningpb.Operation, error)UnsafeRouteOptimizationServer
type UnsafeRouteOptimizationServer interface {
// contains filtered or unexported methods
}UnsafeRouteOptimizationServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to RouteOptimizationServer will result in compilation errors.
Uri
type Uri struct {
// The URI of the resource. The resource may not yet exist.
//
// The contents of the resource are encoded as either JSON
// or textproto. Only Google Cloud Storage resources are supported. If the
// resource is encoded as JSON, the resource name must be suffixed with
// `.json`. If the resource is encoded as textproto, the resource name must
// be suffixed with `.txtpb`. For example, a Google Cloud Storage URI to
// a JSON encoded file might look like: `gs://bucket/path/input/object.json`.
Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
// contains filtered or unexported fields
}A Universal Resource Identifier that points to a resource that can be read and written by the Route Optimization API.
func (*Uri) Descriptor
Deprecated: Use Uri.ProtoReflect.Descriptor instead.
func (*Uri) GetUri
func (*Uri) ProtoMessage
func (*Uri) ProtoMessage()func (*Uri) ProtoReflect
func (x *Uri) ProtoReflect() protoreflect.Messagefunc (*Uri) Reset
func (x *Uri) Reset()func (*Uri) String
Vehicle
type Vehicle struct {
// The user-defined display name of the vehicle.
// It can be up to 63 characters long and may use UTF-8 characters.
DisplayName string `protobuf:"bytes,32,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The travel mode which affects the roads usable by the vehicle and its
// speed. See also `travel_duration_multiple`.
TravelMode Vehicle_TravelMode `protobuf:"varint,1,opt,name=travel_mode,json=travelMode,proto3,enum=google.maps.routeoptimization.v1.Vehicle_TravelMode" json:"travel_mode,omitempty"`
// A set of conditions to satisfy that affect the way routes are calculated
// for the given vehicle.
RouteModifiers *RouteModifiers `protobuf:"bytes,2,opt,name=route_modifiers,json=routeModifiers,proto3" json:"route_modifiers,omitempty"`
// Geographic location where the vehicle starts before picking up any
// shipments. If not specified, the vehicle starts at its first pickup.
// If the shipment model has duration and distance matrices, `start_location`
// must not be specified.
StartLocation *latlng.LatLng `protobuf:"bytes,3,opt,name=start_location,json=startLocation,proto3" json:"start_location,omitempty"`
// Waypoint representing a geographic location where the vehicle starts before
// picking up any shipments. If neither `start_waypoint` nor `start_location`
// is specified, the vehicle starts at its first pickup.
// If the shipment model has duration and distance matrices, `start_waypoint`
// must not be specified.
StartWaypoint *Waypoint `protobuf:"bytes,4,opt,name=start_waypoint,json=startWaypoint,proto3" json:"start_waypoint,omitempty"`
// Geographic location where the vehicle ends after it has completed its last
// `VisitRequest`. If not specified the vehicle's `ShipmentRoute` ends
// immediately when it completes its last `VisitRequest`.
// If the shipment model has duration and distance matrices, `end_location`
// must not be specified.
EndLocation *latlng.LatLng `protobuf:"bytes,5,opt,name=end_location,json=endLocation,proto3" json:"end_location,omitempty"`
// Waypoint representing a geographic location where the vehicle ends after
// it has completed its last `VisitRequest`. If neither `end_waypoint` nor
// `end_location` is specified, the vehicle's `ShipmentRoute` ends immediately
// when it completes its last `VisitRequest`.
// If the shipment model has duration and distance matrices, `end_waypoint`
// must not be specified.
EndWaypoint *Waypoint `protobuf:"bytes,6,opt,name=end_waypoint,json=endWaypoint,proto3" json:"end_waypoint,omitempty"`
// Specifies tags attached to the start of the vehicle's route.
//
// Empty or duplicate strings are not allowed.
StartTags []string `protobuf:"bytes,7,rep,name=start_tags,json=startTags,proto3" json:"start_tags,omitempty"`
// Specifies tags attached to the end of the vehicle's route.
//
// Empty or duplicate strings are not allowed.
EndTags []string `protobuf:"bytes,8,rep,name=end_tags,json=endTags,proto3" json:"end_tags,omitempty"`
// Time windows during which the vehicle may depart its start location.
// They must be within the global time limits (see
// [ShipmentModel.global_*][google.maps.routeoptimization.v1.ShipmentModel.global_start_time]
// fields). If unspecified, there is no limitation besides those global time
// limits.
//
// Time windows belonging to the same repeated field must be disjoint, i.e. no
// time window can overlap with or be adjacent to another, and they must be in
// chronological order.
//
// `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if
// there is a single time window.
StartTimeWindows []*TimeWindow `protobuf:"bytes,9,rep,name=start_time_windows,json=startTimeWindows,proto3" json:"start_time_windows,omitempty"`
// Time windows during which the vehicle may arrive at its end location.
// They must be within the global time limits (see
// [ShipmentModel.global_*][google.maps.routeoptimization.v1.ShipmentModel.global_start_time]
// fields). If unspecified, there is no limitation besides those global time
// limits.
//
// Time windows belonging to the same repeated field must be disjoint, i.e. no
// time window can overlap with or be adjacent to another, and they must be in
// chronological order.
//
// `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if
// there is a single time window.
EndTimeWindows []*TimeWindow `protobuf:"bytes,10,rep,name=end_time_windows,json=endTimeWindows,proto3" json:"end_time_windows,omitempty"`
// Specifies a multiplicative factor that can be used to increase or decrease
// travel times of this vehicle. For example, setting this to 2.0 means
// that this vehicle is slower and has travel times that are twice what they
// are for standard vehicles. This multiple does not affect visit durations.
// It does affect cost if `cost_per_hour` or `cost_per_traveled_hour` are
// specified. This must be in the range [0.001, 1000.0]. If unset, the vehicle
// is standard, and this multiple is considered 1.0.
//
// WARNING: Travel times will be rounded to the nearest second after this
// multiple is applied but before performing any numerical operations, thus,
// a small multiple may result in a loss of precision.
//
// See also `extra_visit_duration_for_visit_type` below.
TravelDurationMultiple *float64 `protobuf:"fixed64,11,opt,name=travel_duration_multiple,json=travelDurationMultiple,proto3,oneof" json:"travel_duration_multiple,omitempty"`
// Unloading policy enforced on the vehicle.
UnloadingPolicy Vehicle_UnloadingPolicy `protobuf:"varint,12,opt,name=unloading_policy,json=unloadingPolicy,proto3,enum=google.maps.routeoptimization.v1.Vehicle_UnloadingPolicy" json:"unloading_policy,omitempty"`
// Capacities of the vehicle (weight, volume, # of pallets for example).
// The keys in the map are the identifiers of the type of load, consistent
// with the keys of the
// [Shipment.load_demands][google.maps.routeoptimization.v1.Shipment.load_demands]
// field. If a given key is absent from this map, the corresponding capacity
// is considered to be limitless.
LoadLimits map[string]*Vehicle_LoadLimit `protobuf:"bytes,30,rep,name=load_limits,json=loadLimits,proto3" json:"load_limits,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Vehicle costs: all costs add up and must be in the same unit as
// [Shipment.penalty_cost][google.maps.routeoptimization.v1.Shipment.penalty_cost].
//
// Cost per hour of the vehicle route. This cost is applied to the total time
// taken by the route, and includes travel time, waiting time, and visit time.
// Using `cost_per_hour` instead of just `cost_per_traveled_hour` may result
// in additional latency.
CostPerHour float64 `protobuf:"fixed64,16,opt,name=cost_per_hour,json=costPerHour,proto3" json:"cost_per_hour,omitempty"`
// Cost per traveled hour of the vehicle route. This cost is applied only to
// travel time taken by the route (i.e., that reported in
// [ShipmentRoute.transitions][google.maps.routeoptimization.v1.ShipmentRoute.transitions]),
// and excludes waiting time and visit time.
CostPerTraveledHour float64 `protobuf:"fixed64,17,opt,name=cost_per_traveled_hour,json=costPerTraveledHour,proto3" json:"cost_per_traveled_hour,omitempty"`
// Cost per kilometer of the vehicle route. This cost is applied to the
// distance reported in the
// [ShipmentRoute.transitions][google.maps.routeoptimization.v1.ShipmentRoute.transitions]
// and does not apply to any distance implicitly traveled from the
// `arrival_location` to the `departure_location` of a single `VisitRequest`.
CostPerKilometer float64 `protobuf:"fixed64,18,opt,name=cost_per_kilometer,json=costPerKilometer,proto3" json:"cost_per_kilometer,omitempty"`
// Fixed cost applied if this vehicle is used to handle a shipment.
FixedCost float64 `protobuf:"fixed64,19,opt,name=fixed_cost,json=fixedCost,proto3" json:"fixed_cost,omitempty"`
// This field only applies to vehicles when their route does not serve any
// shipments. It indicates if the vehicle should be considered as used or not
// in this case.
//
// If true, the vehicle goes from its start to its end location even if it
// doesn't serve any shipments, and time and distance costs resulting from its
// start --> end travel are taken into account.
//
// Otherwise, it doesn't travel from its start to its end location, and no
// `break_rule` or delay (from `TransitionAttributes`) are scheduled for this
// vehicle. In this case, the vehicle's `ShipmentRoute` doesn't contain any
// information except for the vehicle index and label.
UsedIfRouteIsEmpty bool `protobuf:"varint,20,opt,name=used_if_route_is_empty,json=usedIfRouteIsEmpty,proto3" json:"used_if_route_is_empty,omitempty"`
// Limit applied to the total duration of the vehicle's route. In a given
// `OptimizeToursResponse`, the route duration of a vehicle is the
// difference between its `vehicle_end_time` and `vehicle_start_time`.
RouteDurationLimit *Vehicle_DurationLimit `protobuf:"bytes,21,opt,name=route_duration_limit,json=routeDurationLimit,proto3" json:"route_duration_limit,omitempty"`
// Limit applied to the travel duration of the vehicle's route. In a given
// `OptimizeToursResponse`, the route travel duration is the sum of all its
// [transitions.travel_duration][google.maps.routeoptimization.v1.ShipmentRoute.Transition.travel_duration].
TravelDurationLimit *Vehicle_DurationLimit `protobuf:"bytes,22,opt,name=travel_duration_limit,json=travelDurationLimit,proto3" json:"travel_duration_limit,omitempty"`
// Limit applied to the total distance of the vehicle's route. In a given
// `OptimizeToursResponse`, the route distance is the sum of all its
// [transitions.travel_distance_meters][google.maps.routeoptimization.v1.ShipmentRoute.Transition.travel_distance_meters].
RouteDistanceLimit *DistanceLimit `protobuf:"bytes,23,opt,name=route_distance_limit,json=routeDistanceLimit,proto3" json:"route_distance_limit,omitempty"`
// Specifies a map from visit_types strings to durations. The duration is time
// in addition to
// [VisitRequest.duration][google.maps.routeoptimization.v1.Shipment.VisitRequest.duration]
// to be taken at visits with the specified `visit_types`. This extra visit
// duration adds cost if `cost_per_hour` is specified. Keys (i.e.
// `visit_types`) cannot be empty strings.
//
// If a visit request has multiple types, a duration will be added for each
// type in the map.
ExtraVisitDurationForVisitType map[string]*durationpb.Duration `protobuf:"bytes,24,rep,name=extra_visit_duration_for_visit_type,json=extraVisitDurationForVisitType,proto3" json:"extra_visit_duration_for_visit_type,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Describes the break schedule to be enforced on this vehicle.
// If empty, no breaks will be scheduled for this vehicle.
BreakRule *BreakRule `protobuf:"bytes,25,opt,name=break_rule,json=breakRule,proto3" json:"break_rule,omitempty"`
// Specifies a label for this vehicle. This label is reported in the response
// as the `vehicle_label` of the corresponding
// [ShipmentRoute][google.maps.routeoptimization.v1.ShipmentRoute].
Label string `protobuf:"bytes,27,opt,name=label,proto3" json:"label,omitempty"`
// If true, `used_if_route_is_empty` must be false, and this vehicle will
// remain unused.
//
// If a shipment is performed by an ignored vehicle in
// `injected_first_solution_routes`, it is skipped in the first solution but
// is free to be performed in the response.
//
// If a shipment is performed by an ignored vehicle in
// `injected_solution_constraint` and any related pickup/delivery is
// constrained to remain on the vehicle (i.e., not relaxed to level
// `RELAX_ALL_AFTER_THRESHOLD`), it is skipped in the response.
// If a shipment has a non-empty `allowed_vehicle_indices` field and all of
// the allowed vehicles are ignored, it is skipped in the response.
Ignore bool `protobuf:"varint,28,opt,name=ignore,proto3" json:"ignore,omitempty"`
// contains filtered or unexported fields
}Models a vehicle in a shipment problem. Solving a shipment problem will
build a route starting from start_location and ending at end_location
for this vehicle. A route is a sequence of visits (see ShipmentRoute).
func (*Vehicle) Descriptor
Deprecated: Use Vehicle.ProtoReflect.Descriptor instead.
func (*Vehicle) GetBreakRule
func (*Vehicle) GetCostPerHour
func (*Vehicle) GetCostPerKilometer
func (*Vehicle) GetCostPerTraveledHour
func (*Vehicle) GetDisplayName
func (*Vehicle) GetEndLocation
func (*Vehicle) GetEndTags
func (*Vehicle) GetEndTimeWindows
func (x *Vehicle) GetEndTimeWindows() []*TimeWindowfunc (*Vehicle) GetEndWaypoint
func (*Vehicle) GetExtraVisitDurationForVisitType
func (x *Vehicle) GetExtraVisitDurationForVisitType() map[string]*durationpb.Durationfunc (*Vehicle) GetFixedCost
func (*Vehicle) GetIgnore
func (*Vehicle) GetLabel
func (*Vehicle) GetLoadLimits
func (x *Vehicle) GetLoadLimits() map[string]*Vehicle_LoadLimitfunc (*Vehicle) GetRouteDistanceLimit
func (x *Vehicle) GetRouteDistanceLimit() *DistanceLimitfunc (*Vehicle) GetRouteDurationLimit
func (x *Vehicle) GetRouteDurationLimit() *Vehicle_DurationLimitfunc (*Vehicle) GetRouteModifiers
func (x *Vehicle) GetRouteModifiers() *RouteModifiersfunc (*Vehicle) GetStartLocation
func (*Vehicle) GetStartTags
func (*Vehicle) GetStartTimeWindows
func (x *Vehicle) GetStartTimeWindows() []*TimeWindowfunc (*Vehicle) GetStartWaypoint
func (*Vehicle) GetTravelDurationLimit
func (x *Vehicle) GetTravelDurationLimit() *Vehicle_DurationLimitfunc (*Vehicle) GetTravelDurationMultiple
func (*Vehicle) GetTravelMode
func (x *Vehicle) GetTravelMode() Vehicle_TravelModefunc (*Vehicle) GetUnloadingPolicy
func (x *Vehicle) GetUnloadingPolicy() Vehicle_UnloadingPolicyfunc (*Vehicle) GetUsedIfRouteIsEmpty
func (*Vehicle) ProtoMessage
func (*Vehicle) ProtoMessage()func (*Vehicle) ProtoReflect
func (x *Vehicle) ProtoReflect() protoreflect.Messagefunc (*Vehicle) Reset
func (x *Vehicle) Reset()func (*Vehicle) String
VehicleFullness
type VehicleFullness struct {
// Maximum of all other fields in this message.
MaxFullness *float64 `protobuf:"fixed64,1,opt,name=max_fullness,json=maxFullness,proto3,oneof" json:"max_fullness,omitempty"`
// The ratio between
// [AggregatedMetrics.travel_distance_meters][google.maps.routeoptimization.v1.AggregatedMetrics.travel_distance_meters]
// and
// [Vehicle.route_distance_limit][google.maps.routeoptimization.v1.Vehicle.route_distance_limit].
// If
// [Vehicle.route_distance_limit][google.maps.routeoptimization.v1.Vehicle.route_distance_limit]
// is unset, this field will be unset.
Distance *float64 `protobuf:"fixed64,2,opt,name=distance,proto3,oneof" json:"distance,omitempty"`
// The ratio between [AggregatedMetrics.travel_duration_seconds][] and
// [Vehicle.travel_duration_limit][google.maps.routeoptimization.v1.Vehicle.travel_duration_limit].
// If
// [Vehicle.travel_duration_limit][google.maps.routeoptimization.v1.Vehicle.travel_duration_limit]
// is unset, this field will be unset.
TravelDuration *float64 `protobuf:"fixed64,3,opt,name=travel_duration,json=travelDuration,proto3,oneof" json:"travel_duration,omitempty"`
// The ratio between [AggregatedMetrics.total_duration_seconds][] and
// [Vehicle.route_duration_limit][google.maps.routeoptimization.v1.Vehicle.route_duration_limit].
// If
// [Vehicle.route_duration_limit][google.maps.routeoptimization.v1.Vehicle.route_duration_limit]
// is unset, this field will be unset.
ActiveDuration *float64 `protobuf:"fixed64,4,opt,name=active_duration,json=activeDuration,proto3,oneof" json:"active_duration,omitempty"`
// The maximum ratio among all types of [AggregatedMetrics.max_load][] and
// their respective
// [Vehicle.load_limits][google.maps.routeoptimization.v1.Vehicle.load_limits].
// If all
// [Vehicle.load_limits][google.maps.routeoptimization.v1.Vehicle.load_limits]
// fields are unset, this field will be unset.
MaxLoad *float64 `protobuf:"fixed64,5,opt,name=max_load,json=maxLoad,proto3,oneof" json:"max_load,omitempty"`
// The ratio (vehicle_end_time - vehicle_start_time) /
// (latest_vehicle_end_time - earliest_vehicle_start_time) for a given
// vehicle. If the denominator is not present, it uses
// ([ShipmentModel.global_end_time][google.maps.routeoptimization.v1.ShipmentModel.global_end_time]
// -
// [ShipmentModel.global_start_time][google.maps.routeoptimization.v1.ShipmentModel.global_start_time])
// instead.
ActiveSpan *float64 `protobuf:"fixed64,6,opt,name=active_span,json=activeSpan,proto3,oneof" json:"active_span,omitempty"`
// contains filtered or unexported fields
}[VehicleFullness][google.maps.routeoptimization.v1.VehicleFullness] is a metric which computes how full a vehicle is. Each [VehicleFullness][google.maps.routeoptimization.v1.VehicleFullness] field is between 0 and 1, computed as the ratio between a capped metric field (e.g. [AggregatedMetrics.travel_distance_meters][google.maps.routeoptimization.v1.AggregatedMetrics.travel_distance_meters]) and its related vehicle limit (e.g. [Vehicle.route_distance_limit][google.maps.routeoptimization.v1.Vehicle.route_distance_limit]), if it exists. Otherwise the fullness ratio stays unset. If the limit is 0, the field is set to 1. Note: when a route is subject to traffic infeasibilities, some raw fullness ratios might exceed 1.0, e.g. the vehicle might exceed its distance limit. In these cases, we cap the fullness values at 1.0.
func (*VehicleFullness) Descriptor
func (*VehicleFullness) Descriptor() ([]byte, []int)Deprecated: Use VehicleFullness.ProtoReflect.Descriptor instead.
func (*VehicleFullness) GetActiveDuration
func (x *VehicleFullness) GetActiveDuration() float64func (*VehicleFullness) GetActiveSpan
func (x *VehicleFullness) GetActiveSpan() float64func (*VehicleFullness) GetDistance
func (x *VehicleFullness) GetDistance() float64func (*VehicleFullness) GetMaxFullness
func (x *VehicleFullness) GetMaxFullness() float64func (*VehicleFullness) GetMaxLoad
func (x *VehicleFullness) GetMaxLoad() float64func (*VehicleFullness) GetTravelDuration
func (x *VehicleFullness) GetTravelDuration() float64func (*VehicleFullness) ProtoMessage
func (*VehicleFullness) ProtoMessage()func (*VehicleFullness) ProtoReflect
func (x *VehicleFullness) ProtoReflect() protoreflect.Messagefunc (*VehicleFullness) Reset
func (x *VehicleFullness) Reset()func (*VehicleFullness) String
func (x *VehicleFullness) String() stringVehicle_DurationLimit
type Vehicle_DurationLimit struct {
// A hard limit constraining the duration to be at most max_duration.
MaxDuration *durationpb.Duration `protobuf:"bytes,1,opt,name=max_duration,json=maxDuration,proto3" json:"max_duration,omitempty"`
// A soft limit not enforcing a maximum duration limit, but when violated
// makes the route incur a cost. This cost adds up to other costs defined in
// the model, with the same unit.
//
// If defined, `soft_max_duration` must be nonnegative. If max_duration is
// also defined, `soft_max_duration` must be less than max_duration.
SoftMaxDuration *durationpb.Duration `protobuf:"bytes,2,opt,name=soft_max_duration,json=softMaxDuration,proto3" json:"soft_max_duration,omitempty"`
// Cost per hour incurred if the `soft_max_duration` threshold is violated.
// The additional cost is 0 if the duration is under the threshold,
// otherwise the cost depends on the duration as follows:
// ```
//
// cost_per_hour_after_soft_max * (duration - soft_max_duration)
//
// ```
// The cost must be nonnegative.
CostPerHourAfterSoftMax *float64 `protobuf:"fixed64,3,opt,name=cost_per_hour_after_soft_max,json=costPerHourAfterSoftMax,proto3,oneof" json:"cost_per_hour_after_soft_max,omitempty"`
// A soft limit not enforcing a maximum duration limit, but when violated
// makes the route incur a cost, quadratic in the duration. This cost adds
// up to other costs defined in the model, with the same unit.
//
// If defined, `quadratic_soft_max_duration` must be nonnegative. If
// `max_duration` is also defined, `quadratic_soft_max_duration` must be
// less than `max_duration`, and the difference must be no larger than one
// day:
//
// `max_duration - quadratic_soft_max_duration <= 86400="" seconds`="" quadraticsoftmaxduration="">durationpb.Duration `protobuf:"bytes,4,opt,name=quadratic_soft_max_duration,json=quadraticSoftMaxDuration,proto3" json:"quadratic_soft_max_duration,omitempty"`
// Cost per square hour incurred if the
// `quadratic_soft_max_duration` threshold is violated.
//
// The additional cost is 0 if the duration is under the threshold,
// otherwise the cost depends on the duration as follows:
//
// ```
//
// cost_per_square_hour_after_quadratic_soft_max *
// (duration - quadratic_soft_max_duration)^2
//
// ```
//
// The cost must be nonnegative.
CostPerSquareHourAfterQuadraticSoftMax *float64 `protobuf:"fixed64,5,opt,name=cost_per_square_hour_after_quadratic_soft_max,json=costPerSquareHourAfterQuadraticSoftMax,proto3,oneof" json:"cost_per_square_hour_after_quadratic_soft_max,omitempty"`
// contains filtered or unexported fields
}A limit defining a maximum duration of the route of a vehicle. It can be either hard or soft.
When a soft limit field is defined, both the soft max threshold and its associated cost must be defined together.
func (*Vehicle_DurationLimit) Descriptor
func (*Vehicle_DurationLimit) Descriptor() ([]byte, []int)Deprecated: Use Vehicle_DurationLimit.ProtoReflect.Descriptor instead.
func (*Vehicle_DurationLimit) GetCostPerHourAfterSoftMax
func (x *Vehicle_DurationLimit) GetCostPerHourAfterSoftMax() float64func (*Vehicle_DurationLimit) GetCostPerSquareHourAfterQuadraticSoftMax
func (x *Vehicle_DurationLimit) GetCostPerSquareHourAfterQuadraticSoftMax() float64func (*Vehicle_DurationLimit) GetMaxDuration
func (x *Vehicle_DurationLimit) GetMaxDuration() *durationpb.Durationfunc (*Vehicle_DurationLimit) GetQuadraticSoftMaxDuration
func (x *Vehicle_DurationLimit) GetQuadraticSoftMaxDuration() *durationpb.Durationfunc (*Vehicle_DurationLimit) GetSoftMaxDuration
func (x *Vehicle_DurationLimit) GetSoftMaxDuration() *durationpb.Durationfunc (*Vehicle_DurationLimit) ProtoMessage
func (*Vehicle_DurationLimit) ProtoMessage()func (*Vehicle_DurationLimit) ProtoReflect
func (x *Vehicle_DurationLimit) ProtoReflect() protoreflect.Messagefunc (*Vehicle_DurationLimit) Reset
func (x *Vehicle_DurationLimit) Reset()func (*Vehicle_DurationLimit) String
func (x *Vehicle_DurationLimit) String() stringVehicle_LoadLimit
type Vehicle_LoadLimit struct {
// The maximum acceptable amount of load.
MaxLoad *int64 `protobuf:"varint,1,opt,name=max_load,json=maxLoad,proto3,oneof" json:"max_load,omitempty"`
// A soft limit of the load. See
// [cost_per_unit_above_soft_max][google.maps.routeoptimization.v1.Vehicle.LoadLimit.cost_per_unit_above_soft_max].
SoftMaxLoad int64 `protobuf:"varint,2,opt,name=soft_max_load,json=softMaxLoad,proto3" json:"soft_max_load,omitempty"`
// If the load ever exceeds
// [soft_max_load][google.maps.routeoptimization.v1.Vehicle.LoadLimit.soft_max_load]
// along this vehicle's route, the following cost penalty applies (only once
// per vehicle): (load -
// [soft_max_load][google.maps.routeoptimization.v1.Vehicle.LoadLimit.soft_max_load])
// * [cost_per_unit_above_soft_max][google.maps.routeoptimization.v1.Vehicle.LoadLimit.cost_per_unit_above_soft_max]. All costs
// add up and must be in the same unit as
// [Shipment.penalty_cost][google.maps.routeoptimization.v1.Shipment.penalty_cost].
// Soft limits may only be defined on types that apply to either pickups
// only or deliveries only throughout the model.
CostPerUnitAboveSoftMax float64 `protobuf:"fixed64,3,opt,name=cost_per_unit_above_soft_max,json=costPerUnitAboveSoftMax,proto3" json:"cost_per_unit_above_soft_max,omitempty"`
// The acceptable load interval of the vehicle at the start of the route.
StartLoadInterval *Vehicle_LoadLimit_Interval `protobuf:"bytes,4,opt,name=start_load_interval,json=startLoadInterval,proto3" json:"start_load_interval,omitempty"`
// The acceptable load interval of the vehicle at the end of the route.
EndLoadInterval *Vehicle_LoadLimit_Interval `protobuf:"bytes,5,opt,name=end_load_interval,json=endLoadInterval,proto3" json:"end_load_interval,omitempty"`
// Cost of moving one unit of load over one kilometer for this vehicle.
// This can be used as a proxy for fuel consumption: if the load is a weight
// (in Newtons), then load*kilometer has the dimension of an energy.
//
// Experimental: See
// https://developers.google.com/maps/tt/route-optimization/experimental/load-cost/make-request
// for more details.
CostPerKilometer *Vehicle_LoadLimit_LoadCost `protobuf:"bytes,6,opt,name=cost_per_kilometer,json=costPerKilometer,proto3,oneof" json:"cost_per_kilometer,omitempty"`
// Cost of traveling with a unit of load during one hour for this vehicle.
//
// Experimental: See
// https://developers.google.com/maps/tt/route-optimization/experimental/load-cost/make-request
// for more details.
CostPerTraveledHour *Vehicle_LoadLimit_LoadCost `protobuf:"bytes,7,opt,name=cost_per_traveled_hour,json=costPerTraveledHour,proto3,oneof" json:"cost_per_traveled_hour,omitempty"`
// contains filtered or unexported fields
}Defines a load limit applying to a vehicle, e.g. "this truck may only carry up to 3500 kg". See [load_limits][google.maps.routeoptimization.v1.Vehicle.load_limits].
func (*Vehicle_LoadLimit) Descriptor
func (*Vehicle_LoadLimit) Descriptor() ([]byte, []int)Deprecated: Use Vehicle_LoadLimit.ProtoReflect.Descriptor instead.
func (*Vehicle_LoadLimit) GetCostPerKilometer
func (x *Vehicle_LoadLimit) GetCostPerKilometer() *Vehicle_LoadLimit_LoadCostfunc (*Vehicle_LoadLimit) GetCostPerTraveledHour
func (x *Vehicle_LoadLimit) GetCostPerTraveledHour() *Vehicle_LoadLimit_LoadCostfunc (*Vehicle_LoadLimit) GetCostPerUnitAboveSoftMax
func (x *Vehicle_LoadLimit) GetCostPerUnitAboveSoftMax() float64func (*Vehicle_LoadLimit) GetEndLoadInterval
func (x *Vehicle_LoadLimit) GetEndLoadInterval() *Vehicle_LoadLimit_Intervalfunc (*Vehicle_LoadLimit) GetMaxLoad
func (x *Vehicle_LoadLimit) GetMaxLoad() int64func (*Vehicle_LoadLimit) GetSoftMaxLoad
func (x *Vehicle_LoadLimit) GetSoftMaxLoad() int64func (*Vehicle_LoadLimit) GetStartLoadInterval
func (x *Vehicle_LoadLimit) GetStartLoadInterval() *Vehicle_LoadLimit_Intervalfunc (*Vehicle_LoadLimit) ProtoMessage
func (*Vehicle_LoadLimit) ProtoMessage()func (*Vehicle_LoadLimit) ProtoReflect
func (x *Vehicle_LoadLimit) ProtoReflect() protoreflect.Messagefunc (*Vehicle_LoadLimit) Reset
func (x *Vehicle_LoadLimit) Reset()func (*Vehicle_LoadLimit) String
func (x *Vehicle_LoadLimit) String() stringVehicle_LoadLimit_Interval
type Vehicle_LoadLimit_Interval struct {
// A minimum acceptable load. Must be ≥ 0.
// If they're both specified,
// [min][google.maps.routeoptimization.v1.Vehicle.LoadLimit.Interval.min]
// must be ≤
// [max][google.maps.routeoptimization.v1.Vehicle.LoadLimit.Interval.max].
Min int64 `protobuf:"varint,1,opt,name=min,proto3" json:"min,omitempty"`
// A maximum acceptable load. Must be ≥ 0. If unspecified, the maximum
// load is unrestricted by this message.
// If they're both specified,
// [min][google.maps.routeoptimization.v1.Vehicle.LoadLimit.Interval.min]
// must be ≤
// [max][google.maps.routeoptimization.v1.Vehicle.LoadLimit.Interval.max].
Max *int64 `protobuf:"varint,2,opt,name=max,proto3,oneof" json:"max,omitempty"`
// contains filtered or unexported fields
}Interval of acceptable load amounts.
func (*Vehicle_LoadLimit_Interval) Descriptor
func (*Vehicle_LoadLimit_Interval) Descriptor() ([]byte, []int)Deprecated: Use Vehicle_LoadLimit_Interval.ProtoReflect.Descriptor instead.
func (*Vehicle_LoadLimit_Interval) GetMax
func (x *Vehicle_LoadLimit_Interval) GetMax() int64func (*Vehicle_LoadLimit_Interval) GetMin
func (x *Vehicle_LoadLimit_Interval) GetMin() int64func (*Vehicle_LoadLimit_Interval) ProtoMessage
func (*Vehicle_LoadLimit_Interval) ProtoMessage()func (*Vehicle_LoadLimit_Interval) ProtoReflect
func (x *Vehicle_LoadLimit_Interval) ProtoReflect() protoreflect.Messagefunc (*Vehicle_LoadLimit_Interval) Reset
func (x *Vehicle_LoadLimit_Interval) Reset()func (*Vehicle_LoadLimit_Interval) String
func (x *Vehicle_LoadLimit_Interval) String() stringVehicle_LoadLimit_LoadCost
type Vehicle_LoadLimit_LoadCost struct {
// Amount of load above which the cost of moving a unit of load changes
// from cost_per_unit_below_threshold to cost_per_unit_above_threshold.
// Must be >= 0.
LoadThreshold *int64 `protobuf:"varint,1,opt,name=load_threshold,json=loadThreshold,proto3,oneof" json:"load_threshold,omitempty"`
// Cost of moving a unit of load, for each unit between 0 and threshold.
// Must be a finite value, and >= 0.
CostPerUnitBelowThreshold *float64 `protobuf:"fixed64,2,opt,name=cost_per_unit_below_threshold,json=costPerUnitBelowThreshold,proto3,oneof" json:"cost_per_unit_below_threshold,omitempty"`
// Cost of moving a unit of load, for each unit above threshold.
// In the special case threshold = 0, this is a fixed cost per unit.
// Must be a finite value, and >= 0.
CostPerUnitAboveThreshold *float64 `protobuf:"fixed64,3,opt,name=cost_per_unit_above_threshold,json=costPerUnitAboveThreshold,proto3,oneof" json:"cost_per_unit_above_threshold,omitempty"`
// contains filtered or unexported fields
}Cost of moving one unit of load during a Transition.
For a given load, the cost is the sum of two parts:
- min(load,
load_threshold) *cost_per_unit_below_threshold - max(0, load -
load_threshold) *cost_per_unit_above_threshold
With this cost, solutions prefer to deliver high demands first, or equivalently pickup high demands last. For example, if a vehicle has
load_limit {
key: "weight"
value {
cost_per_kilometer {
load_threshold: 15
cost_per_unit_below_threshold: 2.0
cost_per_unit_above_threshold: 10.0
}
}
}
and its route is start,pickup,pickup,delivery,delivery,end with transitions:
transition { vehicle_load['weight'] { amount: 0 }
travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 10 }
travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 20 }
travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 10 }
travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 0 }
travel_distance_meters: 1000.0 }
then the cost incurred by this LoadCost is
(cost_below * load_below * kilometers + cost_above * load_above * kms)
- transition 0: 0.0
- transition 1: 2.0 * 10 * 1.0 + 10.0 * 0 * 1.0 = 20.0
- transition 2: 2.0 * 15 * 1.0 + 10.0 * (20 - 15) * 1.0 = 80.0
- transition 3: 2.0 * 10 * 1.0 + 10.0 * 0 * 1.0 = 20.0
- transition 4: 0.0
So the LoadCost over the route is 120.0.
However, if the route is start,pickup,delivery,pickup,delivery,end with transitions:
transition { vehicle_load['weight'] { amount: 0 }
travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 10 }
travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 0 }
travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 10 }
travel_distance_meters: 1000.0 }
transition { vehicle_load['weight'] { amount: 0 }
travel_distance_meters: 1000.0 }
then the cost incurred by this LoadCost is
- transition 0: 0.0
- transition 1: 2.0 * 10 * 1.0 + 10.0 * 0 * 1.0 = 20.0
- transition 2: 0.0
- transition 3: 2.0 * 10 * 1.0 + 10.0 * 0 * 1.0 = 20.0
- transition 4: 0.0
Here the LoadCost over the route is 40.0.
LoadCost makes solutions with heavy-loaded transitions more expensive.
Experimental: See https://developers.google.com/maps/tt/route-optimization/experimental/load-cost/make-request for more details.
func (*Vehicle_LoadLimit_LoadCost) Descriptor
func (*Vehicle_LoadLimit_LoadCost) Descriptor() ([]byte, []int)Deprecated: Use Vehicle_LoadLimit_LoadCost.ProtoReflect.Descriptor instead.
func (*Vehicle_LoadLimit_LoadCost) GetCostPerUnitAboveThreshold
func (x *Vehicle_LoadLimit_LoadCost) GetCostPerUnitAboveThreshold() float64func (*Vehicle_LoadLimit_LoadCost) GetCostPerUnitBelowThreshold
func (x *Vehicle_LoadLimit_LoadCost) GetCostPerUnitBelowThreshold() float64func (*Vehicle_LoadLimit_LoadCost) GetLoadThreshold
func (x *Vehicle_LoadLimit_LoadCost) GetLoadThreshold() int64func (*Vehicle_LoadLimit_LoadCost) ProtoMessage
func (*Vehicle_LoadLimit_LoadCost) ProtoMessage()func (*Vehicle_LoadLimit_LoadCost) ProtoReflect
func (x *Vehicle_LoadLimit_LoadCost) ProtoReflect() protoreflect.Messagefunc (*Vehicle_LoadLimit_LoadCost) Reset
func (x *Vehicle_LoadLimit_LoadCost) Reset()func (*Vehicle_LoadLimit_LoadCost) String
func (x *Vehicle_LoadLimit_LoadCost) String() stringVehicle_TravelMode
type Vehicle_TravelMode int32Travel modes which can be used by vehicles.
These should be a subset of the Google Maps Platform Routes API travel modes, see: https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteTravelMode
Note: WALKING routes are in beta and might sometimes be missing clear
sidewalks or pedestrian paths. You must display this warning to the user
for all walking routes that you display in your app.
Vehicle_TRAVEL_MODE_UNSPECIFIED, Vehicle_DRIVING, Vehicle_WALKING
const (
// Unspecified travel mode, equivalent to `DRIVING`.
Vehicle_TRAVEL_MODE_UNSPECIFIED Vehicle_TravelMode = 0
// Travel mode corresponding to driving directions (car, ...).
Vehicle_DRIVING Vehicle_TravelMode = 1
// Travel mode corresponding to walking directions.
Vehicle_WALKING Vehicle_TravelMode = 2
)func (Vehicle_TravelMode) Descriptor
func (Vehicle_TravelMode) Descriptor() protoreflect.EnumDescriptorfunc (Vehicle_TravelMode) Enum
func (x Vehicle_TravelMode) Enum() *Vehicle_TravelModefunc (Vehicle_TravelMode) EnumDescriptor
func (Vehicle_TravelMode) EnumDescriptor() ([]byte, []int)Deprecated: Use Vehicle_TravelMode.Descriptor instead.
func (Vehicle_TravelMode) Number
func (x Vehicle_TravelMode) Number() protoreflect.EnumNumberfunc (Vehicle_TravelMode) String
func (x Vehicle_TravelMode) String() stringfunc (Vehicle_TravelMode) Type
func (Vehicle_TravelMode) Type() protoreflect.EnumTypeVehicle_UnloadingPolicy
type Vehicle_UnloadingPolicy int32Policy on how a vehicle can be unloaded. Applies only to shipments having both a pickup and a delivery.
Other shipments are free to occur anywhere on the route independent of
unloading_policy.
Vehicle_UNLOADING_POLICY_UNSPECIFIED, Vehicle_LAST_IN_FIRST_OUT, Vehicle_FIRST_IN_FIRST_OUT
const (
// Unspecified unloading policy; deliveries must just occur after their
// corresponding pickups.
Vehicle_UNLOADING_POLICY_UNSPECIFIED Vehicle_UnloadingPolicy = 0
// Deliveries must occur in reverse order of pickups
Vehicle_LAST_IN_FIRST_OUT Vehicle_UnloadingPolicy = 1
// Deliveries must occur in the same order as pickups
Vehicle_FIRST_IN_FIRST_OUT Vehicle_UnloadingPolicy = 2
)func (Vehicle_UnloadingPolicy) Descriptor
func (Vehicle_UnloadingPolicy) Descriptor() protoreflect.EnumDescriptorfunc (Vehicle_UnloadingPolicy) Enum
func (x Vehicle_UnloadingPolicy) Enum() *Vehicle_UnloadingPolicyfunc (Vehicle_UnloadingPolicy) EnumDescriptor
func (Vehicle_UnloadingPolicy) EnumDescriptor() ([]byte, []int)Deprecated: Use Vehicle_UnloadingPolicy.Descriptor instead.
func (Vehicle_UnloadingPolicy) Number
func (x Vehicle_UnloadingPolicy) Number() protoreflect.EnumNumberfunc (Vehicle_UnloadingPolicy) String
func (x Vehicle_UnloadingPolicy) String() stringfunc (Vehicle_UnloadingPolicy) Type
func (Vehicle_UnloadingPolicy) Type() protoreflect.EnumTypeWaypoint
type Waypoint struct {
// Different ways to represent a location.
//
// Types that are assignable to LocationType:
//
// *Waypoint_Location
// *Waypoint_PlaceId
LocationType isWaypoint_LocationType `protobuf_oneof:"location_type"`
// Optional. Indicates that the location of this waypoint is meant to have a
// preference for the vehicle to stop at a particular side of road. When you
// set this value, the route will pass through the location so that the
// vehicle can stop at the side of road that the location is biased towards
// from the center of the road. This option doesn't work for the 'WALKING'
// travel mode.
SideOfRoad bool `protobuf:"varint,3,opt,name=side_of_road,json=sideOfRoad,proto3" json:"side_of_road,omitempty"`
// Indicates that the waypoint is meant for vehicles to stop at, where the
// intention is to either pick up or drop off. This option works only for the
// 'DRIVING' travel mode, and when the 'location_type' is 'location'.
//
// Experimental: This field's behavior or existence may change in future.
VehicleStopover bool `protobuf:"varint,4,opt,name=vehicle_stopover,json=vehicleStopover,proto3" json:"vehicle_stopover,omitempty"`
// contains filtered or unexported fields
}Encapsulates a waypoint. Waypoints mark arrival and departure locations of VisitRequests, and start and end locations of Vehicles.
func (*Waypoint) Descriptor
Deprecated: Use Waypoint.ProtoReflect.Descriptor instead.
func (*Waypoint) GetLocation
func (*Waypoint) GetLocationType
func (m *Waypoint) GetLocationType() isWaypoint_LocationTypefunc (*Waypoint) GetPlaceId
func (*Waypoint) GetSideOfRoad
func (*Waypoint) GetVehicleStopover
func (*Waypoint) ProtoMessage
func (*Waypoint) ProtoMessage()func (*Waypoint) ProtoReflect
func (x *Waypoint) ProtoReflect() protoreflect.Messagefunc (*Waypoint) Reset
func (x *Waypoint) Reset()func (*Waypoint) String
Waypoint_Location
type Waypoint_Location struct {
// A point specified using geographic coordinates, including an optional
// heading.
Location *Location `protobuf:"bytes,1,opt,name=location,proto3,oneof"`
}Waypoint_PlaceId
type Waypoint_PlaceId struct {
// The POI place ID associated with the waypoint.
//
// When using a place ID to specify arrival or departure location of a
// VisitRequest, use a place ID that is specific enough to determine a
// LatLng location for navigation to the place.
// For example, a place ID representing a building is suitable, but a place
// ID representing a road is discouraged.
PlaceId string `protobuf:"bytes,2,opt,name=place_id,json=placeId,proto3,oneof"`
}