Reference documentation and code samples for the Cloud Optimization V1 API class Google::Cloud::Optimization::V1::Vehicle.
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
).
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#break_rule
def break_rule() -> ::Google::Cloud::Optimization::V1::BreakRule
- (::Google::Cloud::Optimization::V1::BreakRule) — Describes the break schedule to be enforced on this vehicle. If empty, no breaks will be scheduled for this vehicle.
#break_rule=
def break_rule=(value) -> ::Google::Cloud::Optimization::V1::BreakRule
- value (::Google::Cloud::Optimization::V1::BreakRule) — Describes the break schedule to be enforced on this vehicle. If empty, no breaks will be scheduled for this vehicle.
- (::Google::Cloud::Optimization::V1::BreakRule) — Describes the break schedule to be enforced on this vehicle. If empty, no breaks will be scheduled for this vehicle.
#break_rule_indices
def break_rule_indices() -> ::Array<::Integer>
-
(::Array<::Integer>) — Deprecated: No longer used.
Indices in the
break_rule
field in the source ShipmentModel. They correspond to break rules enforced on the vehicle.As of 2018/03, at most one rule index per vehicle can be specified.
#break_rule_indices=
def break_rule_indices=(value) -> ::Array<::Integer>
-
value (::Array<::Integer>) — Deprecated: No longer used.
Indices in the
break_rule
field in the source ShipmentModel. They correspond to break rules enforced on the vehicle.As of 2018/03, at most one rule index per vehicle can be specified.
-
(::Array<::Integer>) — Deprecated: No longer used.
Indices in the
break_rule
field in the source ShipmentModel. They correspond to break rules enforced on the vehicle.As of 2018/03, at most one rule index per vehicle can be specified.
#capacities
def capacities() -> ::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>
- (::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>) — Deprecated: Use Vehicle.load_limits instead.
#capacities=
def capacities=(value) -> ::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>
- value (::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>) — Deprecated: Use Vehicle.load_limits instead.
- (::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>) — Deprecated: Use Vehicle.load_limits instead.
#cost_per_hour
def cost_per_hour() -> ::Float
-
(::Float) — Vehicle costs: all costs add up and must be in the same unit as
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 justcost_per_traveled_hour
may result in additional latency.
#cost_per_hour=
def cost_per_hour=(value) -> ::Float
-
value (::Float) — Vehicle costs: all costs add up and must be in the same unit as
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 justcost_per_traveled_hour
may result in additional latency.
-
(::Float) — Vehicle costs: all costs add up and must be in the same unit as
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 justcost_per_traveled_hour
may result in additional latency.
#cost_per_kilometer
def cost_per_kilometer() -> ::Float
-
(::Float) — Cost per kilometer of the vehicle route. This cost is applied to the
distance reported in the
ShipmentRoute.transitions
and does not apply to any distance implicitly traveled from the
arrival_location
to thedeparture_location
of a singleVisitRequest
.
#cost_per_kilometer=
def cost_per_kilometer=(value) -> ::Float
-
value (::Float) — Cost per kilometer of the vehicle route. This cost is applied to the
distance reported in the
ShipmentRoute.transitions
and does not apply to any distance implicitly traveled from the
arrival_location
to thedeparture_location
of a singleVisitRequest
.
-
(::Float) — Cost per kilometer of the vehicle route. This cost is applied to the
distance reported in the
ShipmentRoute.transitions
and does not apply to any distance implicitly traveled from the
arrival_location
to thedeparture_location
of a singleVisitRequest
.
#cost_per_traveled_hour
def cost_per_traveled_hour() -> ::Float
- (::Float) — 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), and excludes waiting time and visit time.
#cost_per_traveled_hour=
def cost_per_traveled_hour=(value) -> ::Float
- value (::Float) — 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), and excludes waiting time and visit time.
- (::Float) — 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), and excludes waiting time and visit time.
#end_load_intervals
def end_load_intervals() -> ::Array<::Google::Cloud::Optimization::V1::CapacityQuantityInterval>
- (::Array<::Google::Cloud::Optimization::V1::CapacityQuantityInterval>) — Deprecated: Use Vehicle.LoadLimit.end_load_interval instead.
#end_load_intervals=
def end_load_intervals=(value) -> ::Array<::Google::Cloud::Optimization::V1::CapacityQuantityInterval>
- value (::Array<::Google::Cloud::Optimization::V1::CapacityQuantityInterval>) — Deprecated: Use Vehicle.LoadLimit.end_load_interval instead.
- (::Array<::Google::Cloud::Optimization::V1::CapacityQuantityInterval>) — Deprecated: Use Vehicle.LoadLimit.end_load_interval instead.
#end_location
def end_location() -> ::Google::Type::LatLng
-
(::Google::Type::LatLng) — Geographic location where the vehicle ends after it has completed its last
VisitRequest
. If not specified the vehicle'sShipmentRoute
ends immediately when it completes its lastVisitRequest
. If the shipment model has duration and distance matrices,end_location
must not be specified.
#end_location=
def end_location=(value) -> ::Google::Type::LatLng
-
value (::Google::Type::LatLng) — Geographic location where the vehicle ends after it has completed its last
VisitRequest
. If not specified the vehicle'sShipmentRoute
ends immediately when it completes its lastVisitRequest
. If the shipment model has duration and distance matrices,end_location
must not be specified.
-
(::Google::Type::LatLng) — Geographic location where the vehicle ends after it has completed its last
VisitRequest
. If not specified the vehicle'sShipmentRoute
ends immediately when it completes its lastVisitRequest
. If the shipment model has duration and distance matrices,end_location
must not be specified.
#end_tags
def end_tags() -> ::Array<::String>
-
(::Array<::String>) — Specifies tags attached to the end of the vehicle's route.
Empty or duplicate strings are not allowed.
#end_tags=
def end_tags=(value) -> ::Array<::String>
-
value (::Array<::String>) — Specifies tags attached to the end of the vehicle's route.
Empty or duplicate strings are not allowed.
-
(::Array<::String>) — Specifies tags attached to the end of the vehicle's route.
Empty or duplicate strings are not allowed.
#end_time_windows
def end_time_windows() -> ::Array<::Google::Cloud::Optimization::V1::TimeWindow>
-
(::Array<::Google::Cloud::Optimization::V1::TimeWindow>) — Time windows during which the vehicle may arrive at its end location.
They must be within the global time limits (see
[ShipmentModel.global_*][google.cloud.optimization.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
andsoft_end_time
can only be set if there is a single time window.
#end_time_windows=
def end_time_windows=(value) -> ::Array<::Google::Cloud::Optimization::V1::TimeWindow>
-
value (::Array<::Google::Cloud::Optimization::V1::TimeWindow>) — Time windows during which the vehicle may arrive at its end location.
They must be within the global time limits (see
[ShipmentModel.global_*][google.cloud.optimization.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
andsoft_end_time
can only be set if there is a single time window.
-
(::Array<::Google::Cloud::Optimization::V1::TimeWindow>) — Time windows during which the vehicle may arrive at its end location.
They must be within the global time limits (see
[ShipmentModel.global_*][google.cloud.optimization.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
andsoft_end_time
can only be set if there is a single time window.
#end_waypoint
def end_waypoint() -> ::Google::Cloud::Optimization::V1::Waypoint
-
(::Google::Cloud::Optimization::V1::Waypoint) — Waypoint representing a geographic location where the vehicle ends after
it has completed its last
VisitRequest
. If neitherend_waypoint
norend_location
is specified, the vehicle'sShipmentRoute
ends immediately when it completes its lastVisitRequest
. If the shipment model has duration and distance matrices,end_waypoint
must not be specified.
#end_waypoint=
def end_waypoint=(value) -> ::Google::Cloud::Optimization::V1::Waypoint
-
value (::Google::Cloud::Optimization::V1::Waypoint) — Waypoint representing a geographic location where the vehicle ends after
it has completed its last
VisitRequest
. If neitherend_waypoint
norend_location
is specified, the vehicle'sShipmentRoute
ends immediately when it completes its lastVisitRequest
. If the shipment model has duration and distance matrices,end_waypoint
must not be specified.
-
(::Google::Cloud::Optimization::V1::Waypoint) — Waypoint representing a geographic location where the vehicle ends after
it has completed its last
VisitRequest
. If neitherend_waypoint
norend_location
is specified, the vehicle'sShipmentRoute
ends immediately when it completes its lastVisitRequest
. If the shipment model has duration and distance matrices,end_waypoint
must not be specified.
#extra_visit_duration_for_visit_type
def extra_visit_duration_for_visit_type() -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Duration}
-
(::Google::Protobuf::Map{::String => ::Google::Protobuf::Duration}) — Specifies a map from visit_types strings to durations. The duration is time
in addition to
VisitRequest.duration
to be taken at visits with the specified
visit_types
. This extra visit duration adds cost ifcost_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.
#extra_visit_duration_for_visit_type=
def extra_visit_duration_for_visit_type=(value) -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Duration}
-
value (::Google::Protobuf::Map{::String => ::Google::Protobuf::Duration}) — Specifies a map from visit_types strings to durations. The duration is time
in addition to
VisitRequest.duration
to be taken at visits with the specified
visit_types
. This extra visit duration adds cost ifcost_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.
-
(::Google::Protobuf::Map{::String => ::Google::Protobuf::Duration}) — Specifies a map from visit_types strings to durations. The duration is time
in addition to
VisitRequest.duration
to be taken at visits with the specified
visit_types
. This extra visit duration adds cost ifcost_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.
#fixed_cost
def fixed_cost() -> ::Float
- (::Float) — Fixed cost applied if this vehicle is used to handle a shipment.
#fixed_cost=
def fixed_cost=(value) -> ::Float
- value (::Float) — Fixed cost applied if this vehicle is used to handle a shipment.
- (::Float) — Fixed cost applied if this vehicle is used to handle a shipment.
#ignore
def ignore() -> ::Boolean
-
(::Boolean) — 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 levelRELAX_ALL_AFTER_THRESHOLD
), it is skipped in the response. If a shipment has a non-emptyallowed_vehicle_indices
field and all of the allowed vehicles are ignored, it is skipped in the response.
#ignore=
def ignore=(value) -> ::Boolean
-
value (::Boolean) — 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 levelRELAX_ALL_AFTER_THRESHOLD
), it is skipped in the response. If a shipment has a non-emptyallowed_vehicle_indices
field and all of the allowed vehicles are ignored, it is skipped in the response.
-
(::Boolean) — 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 levelRELAX_ALL_AFTER_THRESHOLD
), it is skipped in the response. If a shipment has a non-emptyallowed_vehicle_indices
field and all of the allowed vehicles are ignored, it is skipped in the response.
#label
def label() -> ::String
-
(::String) — Specifies a label for this vehicle. This label is reported in the response
as the
vehicle_label
of the corresponding ShipmentRoute.
#label=
def label=(value) -> ::String
-
value (::String) — Specifies a label for this vehicle. This label is reported in the response
as the
vehicle_label
of the corresponding ShipmentRoute.
-
(::String) — Specifies a label for this vehicle. This label is reported in the response
as the
vehicle_label
of the corresponding ShipmentRoute.
#load_limits
def load_limits() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Vehicle::LoadLimit}
- (::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Vehicle::LoadLimit}) — 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 field. If a given key is absent from this map, the corresponding capacity is considered to be limitless.
#load_limits=
def load_limits=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Vehicle::LoadLimit}
- value (::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Vehicle::LoadLimit}) — 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 field. If a given key is absent from this map, the corresponding capacity is considered to be limitless.
- (::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::Vehicle::LoadLimit}) — 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 field. If a given key is absent from this map, the corresponding capacity is considered to be limitless.
#route_distance_limit
def route_distance_limit() -> ::Google::Cloud::Optimization::V1::DistanceLimit
-
(::Google::Cloud::Optimization::V1::DistanceLimit) — 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.
#route_distance_limit=
def route_distance_limit=(value) -> ::Google::Cloud::Optimization::V1::DistanceLimit
-
value (::Google::Cloud::Optimization::V1::DistanceLimit) — 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::Cloud::Optimization::V1::DistanceLimit) — 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.
#route_duration_limit
def route_duration_limit() -> ::Google::Cloud::Optimization::V1::Vehicle::DurationLimit
-
(::Google::Cloud::Optimization::V1::Vehicle::DurationLimit) — 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 itsvehicle_end_time
andvehicle_start_time
.
#route_duration_limit=
def route_duration_limit=(value) -> ::Google::Cloud::Optimization::V1::Vehicle::DurationLimit
-
value (::Google::Cloud::Optimization::V1::Vehicle::DurationLimit) — 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 itsvehicle_end_time
andvehicle_start_time
.
-
(::Google::Cloud::Optimization::V1::Vehicle::DurationLimit) — 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 itsvehicle_end_time
andvehicle_start_time
.
#route_modifiers
def route_modifiers() -> ::Google::Cloud::Optimization::V1::RouteModifiers
- (::Google::Cloud::Optimization::V1::RouteModifiers) — Optional. A set of conditions to satisfy that affect the way routes are calculated for the given vehicle.
#route_modifiers=
def route_modifiers=(value) -> ::Google::Cloud::Optimization::V1::RouteModifiers
- value (::Google::Cloud::Optimization::V1::RouteModifiers) — Optional. A set of conditions to satisfy that affect the way routes are calculated for the given vehicle.
- (::Google::Cloud::Optimization::V1::RouteModifiers) — Optional. A set of conditions to satisfy that affect the way routes are calculated for the given vehicle.
#start_load_intervals
def start_load_intervals() -> ::Array<::Google::Cloud::Optimization::V1::CapacityQuantityInterval>
- (::Array<::Google::Cloud::Optimization::V1::CapacityQuantityInterval>) — Deprecated: Use Vehicle.LoadLimit.start_load_interval instead.
#start_load_intervals=
def start_load_intervals=(value) -> ::Array<::Google::Cloud::Optimization::V1::CapacityQuantityInterval>
- value (::Array<::Google::Cloud::Optimization::V1::CapacityQuantityInterval>) — Deprecated: Use Vehicle.LoadLimit.start_load_interval instead.
- (::Array<::Google::Cloud::Optimization::V1::CapacityQuantityInterval>) — Deprecated: Use Vehicle.LoadLimit.start_load_interval instead.
#start_location
def start_location() -> ::Google::Type::LatLng
-
(::Google::Type::LatLng) — 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.
#start_location=
def start_location=(value) -> ::Google::Type::LatLng
-
value (::Google::Type::LatLng) — 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.
-
(::Google::Type::LatLng) — 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.
#start_tags
def start_tags() -> ::Array<::String>
-
(::Array<::String>) — Specifies tags attached to the start of the vehicle's route.
Empty or duplicate strings are not allowed.
#start_tags=
def start_tags=(value) -> ::Array<::String>
-
value (::Array<::String>) — Specifies tags attached to the start of the vehicle's route.
Empty or duplicate strings are not allowed.
-
(::Array<::String>) — Specifies tags attached to the start of the vehicle's route.
Empty or duplicate strings are not allowed.
#start_time_windows
def start_time_windows() -> ::Array<::Google::Cloud::Optimization::V1::TimeWindow>
-
(::Array<::Google::Cloud::Optimization::V1::TimeWindow>) — Time windows during which the vehicle may depart its start location.
They must be within the global time limits (see
[ShipmentModel.global_*][google.cloud.optimization.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
andsoft_end_time
can only be set if there is a single time window.
#start_time_windows=
def start_time_windows=(value) -> ::Array<::Google::Cloud::Optimization::V1::TimeWindow>
-
value (::Array<::Google::Cloud::Optimization::V1::TimeWindow>) — Time windows during which the vehicle may depart its start location.
They must be within the global time limits (see
[ShipmentModel.global_*][google.cloud.optimization.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
andsoft_end_time
can only be set if there is a single time window.
-
(::Array<::Google::Cloud::Optimization::V1::TimeWindow>) — Time windows during which the vehicle may depart its start location.
They must be within the global time limits (see
[ShipmentModel.global_*][google.cloud.optimization.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
andsoft_end_time
can only be set if there is a single time window.
#start_waypoint
def start_waypoint() -> ::Google::Cloud::Optimization::V1::Waypoint
-
(::Google::Cloud::Optimization::V1::Waypoint) — Waypoint representing a geographic location where the vehicle starts before
picking up any shipments. If neither
start_waypoint
norstart_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.
#start_waypoint=
def start_waypoint=(value) -> ::Google::Cloud::Optimization::V1::Waypoint
-
value (::Google::Cloud::Optimization::V1::Waypoint) — Waypoint representing a geographic location where the vehicle starts before
picking up any shipments. If neither
start_waypoint
norstart_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.
-
(::Google::Cloud::Optimization::V1::Waypoint) — Waypoint representing a geographic location where the vehicle starts before
picking up any shipments. If neither
start_waypoint
norstart_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.
#travel_duration_limit
def travel_duration_limit() -> ::Google::Cloud::Optimization::V1::Vehicle::DurationLimit
-
(::Google::Cloud::Optimization::V1::Vehicle::DurationLimit) — 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.
#travel_duration_limit=
def travel_duration_limit=(value) -> ::Google::Cloud::Optimization::V1::Vehicle::DurationLimit
-
value (::Google::Cloud::Optimization::V1::Vehicle::DurationLimit) — 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::Cloud::Optimization::V1::Vehicle::DurationLimit) — 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.
#travel_duration_multiple
def travel_duration_multiple() -> ::Float
-
(::Float) — 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
orcost_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.
#travel_duration_multiple=
def travel_duration_multiple=(value) -> ::Float
-
value (::Float) — 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
orcost_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.
-
(::Float) — 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
orcost_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.
#travel_mode
def travel_mode() -> ::Google::Cloud::Optimization::V1::Vehicle::TravelMode
-
(::Google::Cloud::Optimization::V1::Vehicle::TravelMode) — The travel mode which affects the roads usable by the vehicle and its
speed. See also
travel_duration_multiple
.
#travel_mode=
def travel_mode=(value) -> ::Google::Cloud::Optimization::V1::Vehicle::TravelMode
-
value (::Google::Cloud::Optimization::V1::Vehicle::TravelMode) — The travel mode which affects the roads usable by the vehicle and its
speed. See also
travel_duration_multiple
.
-
(::Google::Cloud::Optimization::V1::Vehicle::TravelMode) — The travel mode which affects the roads usable by the vehicle and its
speed. See also
travel_duration_multiple
.
#unloading_policy
def unloading_policy() -> ::Google::Cloud::Optimization::V1::Vehicle::UnloadingPolicy
- (::Google::Cloud::Optimization::V1::Vehicle::UnloadingPolicy) — Unloading policy enforced on the vehicle.
#unloading_policy=
def unloading_policy=(value) -> ::Google::Cloud::Optimization::V1::Vehicle::UnloadingPolicy
- value (::Google::Cloud::Optimization::V1::Vehicle::UnloadingPolicy) — Unloading policy enforced on the vehicle.
- (::Google::Cloud::Optimization::V1::Vehicle::UnloadingPolicy) — Unloading policy enforced on the vehicle.
#used_if_route_is_empty
def used_if_route_is_empty() -> ::Boolean
-
(::Boolean) — 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 (fromTransitionAttributes
) are scheduled for this vehicle. In this case, the vehicle'sShipmentRoute
doesn't contain any information except for the vehicle index and label.
#used_if_route_is_empty=
def used_if_route_is_empty=(value) -> ::Boolean
-
value (::Boolean) — 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 (fromTransitionAttributes
) are scheduled for this vehicle. In this case, the vehicle'sShipmentRoute
doesn't contain any information except for the vehicle index and label.
-
(::Boolean) — 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 (fromTransitionAttributes
) are scheduled for this vehicle. In this case, the vehicle'sShipmentRoute
doesn't contain any information except for the vehicle index and label.