libZSservicesZSamazonka-locationZSamazonka-location
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Location.Types.CalculateRouteSummary

Description

 
Synopsis

Documentation

data CalculateRouteSummary Source #

A summary of the calculated route.

See: newCalculateRouteSummary smart constructor.

Constructors

CalculateRouteSummary' 

Fields

  • dataSource :: Text

    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.

  • distance :: Double

    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.

  • distanceUnit :: DistanceUnit

    The unit of measurement for the distance.

  • durationSeconds :: Double

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

  • routeBBox :: Sensitive (NonEmpty Double)

    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.

Instances

Instances details
Eq CalculateRouteSummary Source # 
Instance details

Defined in Amazonka.Location.Types.CalculateRouteSummary

Methods

(==) :: CalculateRouteSummary -> CalculateRouteSummary -> Bool #

(/=) :: CalculateRouteSummary -> CalculateRouteSummary -> Bool #

Show CalculateRouteSummary Source # 
Instance details

Defined in Amazonka.Location.Types.CalculateRouteSummary

Methods

showsPrec :: Int -> CalculateRouteSummary -> ShowS #

show :: CalculateRouteSummary -> String #

showList :: [CalculateRouteSummary] -> ShowS #

Generic CalculateRouteSummary Source # 
Instance details

Defined in Amazonka.Location.Types.CalculateRouteSummary

Associated Types

type Rep CalculateRouteSummary :: Type -> Type #

Methods

from :: CalculateRouteSummary -> Rep CalculateRouteSummary x #

to :: Rep CalculateRouteSummary x -> CalculateRouteSummary #

NFData CalculateRouteSummary Source # 
Instance details

Defined in Amazonka.Location.Types.CalculateRouteSummary

Methods

rnf :: CalculateRouteSummary -> () #

Hashable CalculateRouteSummary Source # 
Instance details

Defined in Amazonka.Location.Types.CalculateRouteSummary

Methods

hashWithSalt :: Int -> CalculateRouteSummary -> Int #

hash :: CalculateRouteSummary -> Int #

FromJSON CalculateRouteSummary Source # 
Instance details

Defined in Amazonka.Location.Types.CalculateRouteSummary

Methods

parseJSON :: Value -> Parser CalculateRouteSummary #

parseJSONList :: Value -> Parser [CalculateRouteSummary] #

type Rep CalculateRouteSummary Source # 
Instance details

Defined in Amazonka.Location.Types.CalculateRouteSummary

type Rep CalculateRouteSummary = D1 ('MetaData "CalculateRouteSummary" "Amazonka.Location.Types.CalculateRouteSummary" "libZSservicesZSamazonka-locationZSamazonka-location" 'False) (C1 ('MetaCons "CalculateRouteSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "distance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "distanceUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DistanceUnit) :*: (S1 ('MetaSel ('Just "durationSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "routeBBox") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive (NonEmpty Double)))))))

newCalculateRouteSummary Source #

Arguments

:: Text

$sel:dataSource:CalculateRouteSummary'

-> Double

$sel:distance:CalculateRouteSummary'

-> DistanceUnit

$sel:distanceUnit:CalculateRouteSummary'

-> Double

$sel:durationSeconds:CalculateRouteSummary'

-> NonEmpty Double

$sel:routeBBox:CalculateRouteSummary'

-> CalculateRouteSummary 

Create a value of CalculateRouteSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dataSource:CalculateRouteSummary', calculateRouteSummary_dataSource - 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.

$sel:distance:CalculateRouteSummary', calculateRouteSummary_distance - 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.

$sel:distanceUnit:CalculateRouteSummary', calculateRouteSummary_distanceUnit - The unit of measurement for the distance.

$sel:durationSeconds:CalculateRouteSummary', calculateRouteSummary_durationSeconds - The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

$sel:routeBBox:CalculateRouteSummary', calculateRouteSummary_routeBBox - 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.

calculateRouteSummary_dataSource :: Lens' CalculateRouteSummary Text Source #

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.

calculateRouteSummary_distance :: Lens' CalculateRouteSummary Double Source #

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.

calculateRouteSummary_distanceUnit :: Lens' CalculateRouteSummary DistanceUnit Source #

The unit of measurement for the distance.

calculateRouteSummary_durationSeconds :: Lens' CalculateRouteSummary Double Source #

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

calculateRouteSummary_routeBBox :: Lens' CalculateRouteSummary (NonEmpty Double) Source #

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.