Google Cloud Optimization V1 Client - Class Waypoint (1.0.5)

Reference documentation and code samples for the Google Cloud 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.cloud.optimization.v1.Waypoint

Namespace

Google \ Cloud \ Optimization \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ ___location`	`Location` 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.

Returns
Type	Description
`Location\|null`

hasLocation

setLocation

A point specified using geographic coordinates, including an optional heading.

Parameter
Name	Description
`var`	`Location`

Returns
Type	Description
`$this`

getPlaceId

The POI Place ID associated with the waypoint.

Returns
Type	Description
`string`

hasPlaceId

setPlaceId