# Google Maps Route Optimization V1 Client - Class SkippedShipment (0.6.2)

0.6.2 (latest) 0.6.1 0.5.1 0.4.1 0.3.3 0.2.0 0.1.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](https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.Shipment#_Google_Maps_RouteOptimization_V1_Shipment__getLabel__), if specified in the `Shipment`. |
| `↳ penalty_cost` | `float` This is a copy of the [Shipment.penalty_cost](https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.Shipment#_Google_Maps_RouteOptimization_V1_Shipment__getPenaltyCost__), 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<https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/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](https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.Shipment#_Google_Maps_RouteOptimization_V1_Shipment__getLabel__), if
specified in the `Shipment`.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setLabel

Copy of the corresponding
[Shipment.label](https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.Shipment#_Google_Maps_RouteOptimization_V1_Shipment__getLabel__), if
specified in the `Shipment`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPenaltyCost

This is a copy of the
[Shipment.penalty_cost](https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.Shipment#_Google_Maps_RouteOptimization_V1_Shipment__getPenaltyCost__),
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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `float` |   |

### hasPenaltyCost

### clearPenaltyCost

### setPenaltyCost

This is a copy of the
[Shipment.penalty_cost](https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.Shipment#_Google_Maps_RouteOptimization_V1_Shipment__getPenaltyCost__),
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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `float` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `float` |

| **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** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.SkippedShipment.Reason>` |   |

### 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<https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.SkippedShipment.Reason>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |