Reference documentation and code samples for the Google Cloud Optimization V1 Client class RouteModifiers.
Encapsulates a set of optional conditions to satisfy when calculating
vehicle routes. This is similar to RouteModifiers in the Google Maps
Platform API; see:
https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteModifiers.
Generated from protobuf message google.cloud.optimization.v1.RouteModifiers
Namespace
Google \ Cloud \ Optimization \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ avoid_tolls |
bool
Specifies whether to avoid toll roads where reasonable. Preference will be given to routes not containing toll roads. Applies only to motorized travel modes. |
↳ avoid_highways |
bool
Specifies whether to avoid highways where reasonable. Preference will be given to routes not containing highways. Applies only to motorized travel modes. |
↳ avoid_ferries |
bool
Specifies whether to avoid ferries where reasonable. Preference will be given to routes not containing travel by ferries. Applies only to motorized travel modes. |
↳ avoid_indoor |
bool
Optional. Specifies whether to avoid navigating indoors where reasonable. Preference will be given to routes not containing indoor navigation. Applies only to the |
getAvoidTolls
Specifies whether to avoid toll roads where reasonable. Preference will be given to routes not containing toll roads. Applies only to motorized travel modes.
| Returns | |
|---|---|
| Type | Description |
bool | |
setAvoidTolls
Specifies whether to avoid toll roads where reasonable. Preference will be given to routes not containing toll roads. Applies only to motorized travel modes.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAvoidHighways
Specifies whether to avoid highways where reasonable. Preference will be given to routes not containing highways. Applies only to motorized travel modes.
| Returns | |
|---|---|
| Type | Description |
bool | |
setAvoidHighways
Specifies whether to avoid highways where reasonable. Preference will be given to routes not containing highways. Applies only to motorized travel modes.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAvoidFerries
Specifies whether to avoid ferries where reasonable. Preference will be given to routes not containing travel by ferries. Applies only to motorized travel modes.
| Returns | |
|---|---|
| Type | Description |
bool | |
setAvoidFerries
Specifies whether to avoid ferries where reasonable. Preference will be given to routes not containing travel by ferries. Applies only to motorized travel modes.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAvoidIndoor
Optional. Specifies whether to avoid navigating indoors where reasonable.
Preference will be given to routes not containing indoor navigation.
Applies only to the WALKING travel mode.
| Returns | |
|---|---|
| Type | Description |
bool | |
setAvoidIndoor
Optional. Specifies whether to avoid navigating indoors where reasonable.
Preference will be given to routes not containing indoor navigation.
Applies only to the WALKING travel mode.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |