A point specified using geographic coordinates, including an optional heading.
↳ place_id
string
The POI Place ID associated with the waypoint.
↳ side_of_road
bool
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 works only for the 'DRIVING' travel mode, and when the 'location_type' is set to 'location'.
getLocation
A point specified using geographic coordinates, including an optional
heading.
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 works only for the 'DRIVING' travel mode,
and when the 'location_type' is set to 'location'.
Returns
Type
Description
bool
setSideOfRoad
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 works only for the 'DRIVING' travel mode,
and when the 'location_type' is set to 'location'.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Optimization V1 Client - Class Waypoint (1.0.5)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.5 (latest)](/php/docs/reference/cloud-optimization/latest/V1.Waypoint)\n- [1.0.4](/php/docs/reference/cloud-optimization/1.0.4/V1.Waypoint)\n- [0.7.0](/php/docs/reference/cloud-optimization/0.7.0/V1.Waypoint)\n- [0.6.5](/php/docs/reference/cloud-optimization/0.6.5/V1.Waypoint)\n- [0.5.1](/php/docs/reference/cloud-optimization/0.5.1/V1.Waypoint)\n- [0.4.0](/php/docs/reference/cloud-optimization/0.4.0/V1.Waypoint)\n- [0.3.4](/php/docs/reference/cloud-optimization/0.3.4/V1.Waypoint)\n- [0.2.0](/php/docs/reference/cloud-optimization/0.2.0/V1.Waypoint)\n- [0.1.9](/php/docs/reference/cloud-optimization/0.1.9/V1.Waypoint) \nReference documentation and code samples for the Google Cloud Optimization V1 Client class Waypoint.\n\nEncapsulates a waypoint. Waypoints mark arrival and departure locations of\nVisitRequests, and start and end locations of Vehicles.\n\nGenerated from protobuf message `google.cloud.optimization.v1.Waypoint`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Optimization \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getLocation\n\nA point specified using geographic coordinates, including an optional\nheading.\n\n### hasLocation\n\n### setLocation\n\nA point specified using geographic coordinates, including an optional\nheading.\n\n### getPlaceId\n\nThe POI Place ID associated with the waypoint.\n\n### hasPlaceId\n\n### setPlaceId\n\nThe POI Place ID associated with the waypoint.\n\n### getSideOfRoad\n\nIndicates that the location of this waypoint is meant to have a preference\nfor the vehicle to stop at a particular side of road. When you set this\nvalue, the route will pass through the location so that the vehicle can\nstop at the side of road that the location is biased towards from the\ncenter of the road. This option works only for the 'DRIVING' travel mode,\nand when the 'location_type' is set to 'location'.\n\n### setSideOfRoad\n\nIndicates that the location of this waypoint is meant to have a preference\nfor the vehicle to stop at a particular side of road. When you set this\nvalue, the route will pass through the location so that the vehicle can\nstop at the side of road that the location is biased towards from the\ncenter of the road. This option works only for the 'DRIVING' travel mode,\nand when the 'location_type' is set to 'location'.\n\n### getLocationType"]]
