Reference documentation and code samples for the Google Maps Route Optimization V1 Client class SkippedShipment.
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.
Generated from protobuf message google.maps.routeoptimization.v1.SkippedShipment
Namespace
Google \ Maps \ RouteOptimization \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ index
int
The index corresponds to the index of the shipment in the source ShipmentModel
.
↳ label
↳ penalty_cost
float
This is a copy of the 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.
↳ estimated_incompatible_vehicle_ratio
float
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.
↳ reasons
array< SkippedShipment\Reason
>
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.
getIndex
The index corresponds to the index of the shipment in the source ShipmentModel
.
int
setIndex
The index corresponds to the index of the shipment in the source ShipmentModel
.
var
int
$this
getLabel
Copy of the corresponding Shipment.label
, if
specified in the Shipment
.
string
setLabel
Copy of the corresponding Shipment.label
, if
specified in the Shipment
.
var
string
$this
getPenaltyCost
This is a copy of the 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.
float
hasPenaltyCost
clearPenaltyCost
setPenaltyCost
This is a copy of the 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.
var
float
$this
getEstimatedIncompatibleVehicleRatio
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.
float
hasEstimatedIncompatibleVehicleRatio
clearEstimatedIncompatibleVehicleRatio
setEstimatedIncompatibleVehicleRatio
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.
var
float
$this
getReasons
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.
setReasons
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.
$this
