Cloud Optimization V1 API - Class Google::Cloud::Optimization::V1::Waypoint (v0.13.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
  • (::Google::Cloud::Optimization::V1::Location) — A point specified using geographic coordinates, including an optional heading.

    Note: The following fields are mutually exclusive: location, place_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

#location=

def location=(value) -> ::Google::Cloud::Optimization::V1::Location
Parameter
  • value (::Google::Cloud::Optimization::V1::Location) — A point specified using geographic coordinates, including an optional heading.

    Note: The following fields are mutually exclusive: location, place_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Optimization::V1::Location) — A point specified using geographic coordinates, including an optional heading.

    Note: The following fields are mutually exclusive: location, place_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

#place_id

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

    Note: The following fields are mutually exclusive: place_id, location. If a field in that set is populated, all other fields in the set will automatically be cleared.

#place_id=

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

    Note: The following fields are mutually exclusive: place_id, location. If a field in that set is populated, all other fields in the set will automatically be cleared.

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

    Note: The following fields are mutually exclusive: place_id, location. If a field in that set is populated, all other fields in the set will automatically be cleared.

#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'.