Class: Aws::LocationService::Types::CalculateRouteResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb

Overview

Returns the result of the route calculation. Metadata includes legs and route summary.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#legsArray<Types::Leg>

Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

  • The StartPosition is the departure position.

  • The EndPosition is the destination position.

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

  • Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.

  • Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

Returns:



852
853
854
855
856
857
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 852

class CalculateRouteResponse < Struct.new(
  :legs,
  :summary)
  SENSITIVE = []
  include Aws::Structure
end

#summaryTypes::CalculateRouteSummary

Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.



852
853
854
855
856
857
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 852

class CalculateRouteResponse < Struct.new(
  :legs,
  :summary)
  SENSITIVE = []
  include Aws::Structure
end