Class: Aws::LocationService::Types::CalculateRouteSummary

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

Overview

A summary of the calculated route.

Constant Summary collapse

SENSITIVE =
[:route_b_box]

Instance Attribute Summary collapse

Instance Attribute Details

#data_sourceString

The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

  • Esri

  • Here

For more information about data providers, see Amazon Location Service data providers.

Returns:

  • (String)


1209
1210
1211
1212
1213
1214
1215
1216
1217
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1209

class CalculateRouteSummary < Struct.new(
  :data_source,
  :distance,
  :distance_unit,
  :duration_seconds,
  :route_b_box)
  SENSITIVE = [:route_b_box]
  include Aws::Structure
end

#distanceFloat

The total distance covered by the route. The sum of the distance travelled between every stop on the route.

If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a 400 RoutesValidationException error.

Returns:

  • (Float)


1209
1210
1211
1212
1213
1214
1215
1216
1217
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1209

class CalculateRouteSummary < Struct.new(
  :data_source,
  :distance,
  :distance_unit,
  :duration_seconds,
  :route_b_box)
  SENSITIVE = [:route_b_box]
  include Aws::Structure
end

#distance_unitString

The unit of measurement for route distances.

Returns:

  • (String)


1209
1210
1211
1212
1213
1214
1215
1216
1217
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1209

class CalculateRouteSummary < Struct.new(
  :data_source,
  :distance,
  :distance_unit,
  :duration_seconds,
  :route_b_box)
  SENSITIVE = [:route_b_box]
  include Aws::Structure
end

#duration_secondsFloat

The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

Returns:

  • (Float)


1209
1210
1211
1212
1213
1214
1215
1216
1217
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1209

class CalculateRouteSummary < Struct.new(
  :data_source,
  :distance,
  :distance_unit,
  :duration_seconds,
  :route_b_box)
  SENSITIVE = [:route_b_box]
  include Aws::Structure
end

#route_b_boxArray<Float>

Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y].

The first 2 bbox parameters describe the lower southwest corner:

  • The first bbox position is the X coordinate or longitude of the lower southwest corner.

  • The second bbox position is the Y coordinate or latitude of the lower southwest corner.

The next 2 bbox parameters describe the upper northeast corner:

  • The third bbox position is the X coordinate, or longitude of the upper northeast corner.

  • The fourth bbox position is the Y coordinate, or latitude of the upper northeast corner.

Returns:

  • (Array<Float>)


1209
1210
1211
1212
1213
1214
1215
1216
1217
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 1209

class CalculateRouteSummary < Struct.new(
  :data_source,
  :distance,
  :distance_unit,
  :duration_seconds,
  :route_b_box)
  SENSITIVE = [:route_b_box]
  include Aws::Structure
end