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

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

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#legs ⇒ Array<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.

[1]: docs.aws.amazon.com/location/latest/developerguide/snap-to-nearby-road.html

Returns:



1141
1142
1143
1144
1145
1146
 
# File 'lib/aws-sdk-locationservice/types.rb', line 1141

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

#summary ⇒ Types::CalculateRouteSummary

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

Returns:



1141
1142
1143
1144
1145
1146
 
# File 'lib/aws-sdk-locationservice/types.rb', line 1141

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