# Google Maps Route Optimization V1 Client - Class OptimizeToursResponse (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 OptimizeToursResponse.

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.

Generated from protobuf message `google.maps.routeoptimization.v1.OptimizeToursResponse`

## Namespace

Google \\ Maps \\ RouteOptimization \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ routes` | `array<https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.ShipmentRoute>` Routes computed for each vehicle; the i-th route corresponds to the i-th vehicle in the model. |
| `↳ request_label` | `string` Copy of the [OptimizeToursRequest.label](https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.OptimizeToursRequest#_Google_Maps_RouteOptimization_V1_OptimizeToursRequest__getLabel__), if a label was specified in the request. |
| `↳ skipped_shipments` | `array<https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.SkippedShipment>` The list of all shipments skipped. |
| `↳ validation_errors` | `array<https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.OptimizeToursValidationError>` List of all the validation errors that we were able to detect independently. See the "MULTIPLE ERRORS" explanation for the [OptimizeToursValidationError](https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.OptimizeToursValidationError) message. Instead of errors, this will include warnings in the case `solving_mode` is `DEFAULT_SOLVE`. |
| `↳ processed_request` | `https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.OptimizeToursRequest` 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. |
| `↳ metrics` | `https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.OptimizeToursResponse.Metrics` Duration, distance and usage metrics for this solution. |

### getRoutes

Routes computed for each vehicle; the i-th route corresponds to the i-th
vehicle in the model.

| **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.ShipmentRoute>` |   |

### setRoutes

Routes computed for each vehicle; the i-th route corresponds to the i-th
vehicle in the model.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.ShipmentRoute>` |

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

### getRequestLabel

Copy of the
[OptimizeToursRequest.label](https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.OptimizeToursRequest#_Google_Maps_RouteOptimization_V1_OptimizeToursRequest__getLabel__),
if a label was specified in the request.

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

### setRequestLabel

Copy of the
[OptimizeToursRequest.label](https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.OptimizeToursRequest#_Google_Maps_RouteOptimization_V1_OptimizeToursRequest__getLabel__),
if a label was specified in the request.

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

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

### getSkippedShipments

The list of all shipments skipped.

| **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>` |   |

### setSkippedShipments

The list of all shipments skipped.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.SkippedShipment>` |

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

### getValidationErrors

List of all the validation errors that we were able to detect
independently. See the "MULTIPLE ERRORS" explanation for the
[OptimizeToursValidationError](https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.OptimizeToursValidationError)
message. Instead of errors, this will include warnings in the case
`solving_mode` is `DEFAULT_SOLVE`.

| **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.OptimizeToursValidationError>` |   |

### setValidationErrors

List of all the validation errors that we were able to detect
independently. See the "MULTIPLE ERRORS" explanation for the
[OptimizeToursValidationError](https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.OptimizeToursValidationError)
message. Instead of errors, this will include warnings in the case
`solving_mode` is `DEFAULT_SOLVE`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.OptimizeToursValidationError>` |

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

### getProcessedRequest

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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.OptimizeToursRequest|null` |   |

### hasProcessedRequest

### clearProcessedRequest

### setProcessedRequest

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.OptimizeToursRequest` |

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

### getMetrics

Duration, distance and usage metrics for this solution.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.OptimizeToursResponse.Metrics|null` |   |

### hasMetrics

### clearMetrics

### setMetrics

Duration, distance and usage metrics for this solution.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/maps-routeoptimization/latest/V1.OptimizeToursResponse.Metrics` |

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