Class: Google::Cloud::Optimization::V1::Waypoint

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/optimization/v1/fleet_routing.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#location ⇒ ::Google::Cloud::Optimization::V1::Location

Returns 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.



1747
1748
1749
1750
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 1747

class Waypoint
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#place_id ⇒ ::String

Returns 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.



1747
1748
1749
1750
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 1747

class Waypoint
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#side_of_road ⇒ ::Boolean

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



1747
1748
1749
1750
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 1747

class Waypoint
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end