Cloud Optimization V1 API - Class Google::Cloud::Optimization::V1::Waypoint (v0.3.0)

Reference documentation and code samples for the Cloud Optimization V1 API class Google::Cloud::Optimization::V1::Waypoint.

Encapsulates a waypoint. Waypoints mark arrival and departure locations of VisitRequests, and start and end locations of Vehicles.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#___location

def ___location() -> ::Google::Cloud::Optimization::V1::Location
Returns

#___location=

def ___location=(value) -> ::Google::Cloud::Optimization::V1::Location
Parameter
Returns

#place_id

def place_id() -> ::String
Returns
  • (::String) — The POI Place ID associated with the waypoint.

#place_id=

def place_id=(value) -> ::String
Parameter
  • value (::String) — The POI Place ID associated with the waypoint.
Returns
  • (::String) — The POI Place ID associated with the waypoint.

#side_of_road

def side_of_road() -> ::Boolean
Returns
  • (::Boolean) — 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'.

#side_of_road=

def side_of_road=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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'.