Class: Aws::LocationService::Types::CalculateRouteMatrixSummary

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::CalculateRouteMatrixSummary

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

A summary of the calculated route matrix.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_source ⇒ String

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

• #distance_unit ⇒ String

  The unit of measurement for route distances.

• #error_count ⇒ Integer

  The count of error results in the route matrix.

• #route_count ⇒ Integer

  The count of cells in the route matrix.

Instance Attribute Details

#data_source ⇒ String

The data provider of traffic and road network data used to calculate the routes. 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 884

class CalculateRouteMatrixSummary < Struct.new(
  :data_source,
  :route_count,
  :error_count,
  :distance_unit)
  SENSITIVE = []
  include Aws::Structure
end

#distance_unit ⇒ String

The unit of measurement for route distances.

Returns:

• (String)

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

class CalculateRouteMatrixSummary < Struct.new(
  :data_source,
  :route_count,
  :error_count,
  :distance_unit)
  SENSITIVE = []
  include Aws::Structure
end

#error_count ⇒ Integer

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

Returns:

• (Integer)

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

class CalculateRouteMatrixSummary < Struct.new(
  :data_source,
  :route_count,
  :error_count,
  :distance_unit)
  SENSITIVE = []
  include Aws::Structure
end

#route_count ⇒ Integer

The count of cells in the route matrix. Equal to the number of ‘DeparturePositions` multiplied by the number of `DestinationPositions`.

Returns:

• (Integer)

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

class CalculateRouteMatrixSummary < Struct.new(
  :data_source,
  :route_count,
  :error_count,
  :distance_unit)
  SENSITIVE = []
  include Aws::Structure
end