amazonka-location-2.0: Amazon Location Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Location.Types.Step

Description

 
Synopsis

Documentation

data Step Source #

Represents an element of a leg within a route. A step contains instructions for how to move to the next step in the leg.

See: newStep smart constructor.

Constructors

Step' 

Fields

  • geometryOffset :: Maybe Natural

    Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is 0.

    Included in the response for queries that set IncludeLegGeometry to True.

  • distance :: Double

    The travel distance between the step's StartPosition and EndPosition.

  • durationSeconds :: Double

    The estimated travel time, in seconds, from the step's StartPosition to the EndPosition. . The travel mode and departure time that you specify in the request determines the calculated time.

  • endPosition :: Sensitive (NonEmpty Double)

    The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.

  • startPosition :: Sensitive (NonEmpty Double)

    The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.

Instances

Instances details
FromJSON Step Source # 
Instance details

Defined in Amazonka.Location.Types.Step

Generic Step Source # 
Instance details

Defined in Amazonka.Location.Types.Step

Associated Types

type Rep Step :: Type -> Type #

Methods

from :: Step -> Rep Step x #

to :: Rep Step x -> Step #

Show Step Source # 
Instance details

Defined in Amazonka.Location.Types.Step

Methods

showsPrec :: Int -> Step -> ShowS #

show :: Step -> String #

showList :: [Step] -> ShowS #

NFData Step Source # 
Instance details

Defined in Amazonka.Location.Types.Step

Methods

rnf :: Step -> () #

Eq Step Source # 
Instance details

Defined in Amazonka.Location.Types.Step

Methods

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

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

Hashable Step Source # 
Instance details

Defined in Amazonka.Location.Types.Step

Methods

hashWithSalt :: Int -> Step -> Int #

hash :: Step -> Int #

type Rep Step Source # 
Instance details

Defined in Amazonka.Location.Types.Step

type Rep Step = D1 ('MetaData "Step" "Amazonka.Location.Types.Step" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "Step'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "geometryOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "distance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "durationSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: (S1 ('MetaSel ('Just "endPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive (NonEmpty Double))) :*: S1 ('MetaSel ('Just "startPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive (NonEmpty Double)))))))

newStep Source #

Create a value of Step 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:geometryOffset:Step', step_geometryOffset - Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is 0.

Included in the response for queries that set IncludeLegGeometry to True.

$sel:distance:Step', step_distance - The travel distance between the step's StartPosition and EndPosition.

$sel:durationSeconds:Step', step_durationSeconds - The estimated travel time, in seconds, from the step's StartPosition to the EndPosition. . The travel mode and departure time that you specify in the request determines the calculated time.

$sel:endPosition:Step', step_endPosition - The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.

$sel:startPosition:Step', step_startPosition - The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.

step_geometryOffset :: Lens' Step (Maybe Natural) Source #

Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is 0.

Included in the response for queries that set IncludeLegGeometry to True.

step_distance :: Lens' Step Double Source #

The travel distance between the step's StartPosition and EndPosition.

step_durationSeconds :: Lens' Step Double Source #

The estimated travel time, in seconds, from the step's StartPosition to the EndPosition. . The travel mode and departure time that you specify in the request determines the calculated time.

step_endPosition :: Lens' Step (NonEmpty Double) Source #

The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.

step_startPosition :: Lens' Step (NonEmpty Double) Source #

The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg.