Google Maps Route Optimization V1 Client - Class SkippedShipment (0.2.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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 string

Copy of the corresponding Shipment.label, if specified in the Shipment.

↳ reasons array<Google\Maps\RouteOptimization\V1\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.

Returns
Type Description
int

setIndex

The index corresponds to the index of the shipment in the source ShipmentModel.

Parameter
Name Description
var int
Returns
Type Description
$this

getLabel

Copy of the corresponding Shipment.label, if specified in the Shipment.

Returns
Type Description
string

setLabel

Copy of the corresponding Shipment.label, if specified in the Shipment.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

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.

Parameter
Name Description
var array<Google\Maps\RouteOptimization\V1\SkippedShipment\Reason>
Returns
Type Description
$this