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

Inherits:

Struct

Object
Struct
Aws::LocationService::Types::CalculateRouteResponse

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

#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.
#summary ⇒ Types::CalculateRouteSummary
Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.

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.

Returns:

(Array<Types::Leg>)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1139

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.