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

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::CalculateRouteSummary

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

A summary of the calculated route.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:route_b_box]

Instance Attribute Summary

• #data_source ⇒ String

  The data provider of traffic and road network data used to calculate the route.

• #distance ⇒ Float

  The total distance covered by the route.

• #distance_unit ⇒ String

  The unit of measurement for route distances.

• #duration_seconds ⇒ Float

  The total travel time for the route measured in seconds.

• #route_b_box ⇒ Array<Float>

  Specifies a geographical box surrounding a route.

Instance Attribute Details

#data_source ⇒ String

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

• ‘Esri`

• ‘Grab`

• ‘Here`

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

[1]: docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html

Returns:

• (String)

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

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

#distance ⇒ Float

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

<note markdown=“1”> 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.

</note>

Returns:

• (Float)

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

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

#distance_unit ⇒ String

The unit of measurement for route distances.

Returns:

• (String)

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

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

#duration_seconds ⇒ Float

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

Returns:

• (Float)

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

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

#route_b_box ⇒ Array<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>)

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

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