Reference documentation and code samples for the Google Maps Route Optimization V1 Client class Waypoint.
Encapsulates a waypoint. Waypoints mark arrival and departure locations of VisitRequests, and start and end locations of Vehicles.
Generated from protobuf message google.maps.routeoptimization.v1.Waypoint
Namespace
Google \ Maps \ RouteOptimization \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ location
↳ place_id
string
The POI place ID associated with the waypoint. When using a place ID to specify arrival or departure location of a VisitRequest, use a place ID that is specific enough to determine a LatLng location for navigation to the place. For example, a place ID representing a building is suitable, but a place ID representing a road is discouraged.
↳ side_of_road
bool
Optional. Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road. When you set this value, the route will pass through the location so that the vehicle can stop at the side of road that the location is biased towards from the center of the road. This option doesn't work for the 'WALKING' travel mode.
↳ vehicle_stopover
bool
Indicates that the waypoint is meant for vehicles to stop at, where the intention is to either pick up or drop off. This option works only for the 'DRIVING' travel mode, and when the 'location_type' is 'location'. Experimental: This field's behavior or existence may change in future.
getLocation
A point specified using geographic coordinates, including an optional heading.
hasLocation
setLocation
A point specified using geographic coordinates, including an optional heading.
$this
getPlaceId
The POI place ID associated with the waypoint.
When using a place ID to specify arrival or departure location of a VisitRequest, use a place ID that is specific enough to determine a LatLng location for navigation to the place. For example, a place ID representing a building is suitable, but a place ID representing a road is discouraged.
string
hasPlaceId
setPlaceId
The POI place ID associated with the waypoint.
When using a place ID to specify arrival or departure location of a VisitRequest, use a place ID that is specific enough to determine a LatLng location for navigation to the place. For example, a place ID representing a building is suitable, but a place ID representing a road is discouraged.
var
string
$this
getSideOfRoad
Optional. Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road. When you set this value, the route will pass through the location so that the vehicle can stop at the side of road that the location is biased towards from the center of the road. This option doesn't work for the 'WALKING' travel mode.
bool
setSideOfRoad
Optional. Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road. When you set this value, the route will pass through the location so that the vehicle can stop at the side of road that the location is biased towards from the center of the road. This option doesn't work for the 'WALKING' travel mode.
var
bool
$this
getVehicleStopover
Indicates that the waypoint is meant for vehicles to stop at, where the intention is to either pick up or drop off. This option works only for the 'DRIVING' travel mode, and when the 'location_type' is 'location'.
Experimental: This field's behavior or existence may change in future.
bool
setVehicleStopover
Indicates that the waypoint is meant for vehicles to stop at, where the intention is to either pick up or drop off. This option works only for the 'DRIVING' travel mode, and when the 'location_type' is 'location'.
Experimental: This field's behavior or existence may change in future.
var
bool
$this
getLocationType
string
