Amazonka.Location.Types.CalculateRouteTruckModeOptions

Documentation

data CalculateRouteTruckModeOptions

Contains details about additional route preferences for requests that specify TravelMode as Truck.

See: newCalculateRouteTruckModeOptions smart constructor.

Constructors

CalculateRouteTruckModeOptions'

Fields

• avoidFerries :: Maybe Bool

  Avoids ferries when calculating routes.

  Default Value: false

  Valid Values: false | true

• avoidTolls :: Maybe Bool

  Avoids tolls when calculating routes.

  Default Value: false

  Valid Values: false | true

• dimensions :: Maybe TruckDimensions

  Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.

• weight :: Maybe TruckWeight

  Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.

Instances

ToJSON CalculateRouteTruckModeOptions

Defined in Amazonka.Location.Types.CalculateRouteTruckModeOptions

Methods

toJSON :: CalculateRouteTruckModeOptions -> Value

toEncoding :: CalculateRouteTruckModeOptions -> Encoding

toJSONList :: [CalculateRouteTruckModeOptions] -> Value

toEncodingList :: [CalculateRouteTruckModeOptions] -> Encoding

Generic CalculateRouteTruckModeOptions

Defined in Amazonka.Location.Types.CalculateRouteTruckModeOptions

Associated Types

type Rep CalculateRouteTruckModeOptions :: Type -> Type

Methods

from :: CalculateRouteTruckModeOptions -> Rep CalculateRouteTruckModeOptions x

to :: Rep CalculateRouteTruckModeOptions x -> CalculateRouteTruckModeOptions

Read CalculateRouteTruckModeOptions

Defined in Amazonka.Location.Types.CalculateRouteTruckModeOptions

Methods

readsPrec :: Int -> ReadS CalculateRouteTruckModeOptions

readList :: ReadS [CalculateRouteTruckModeOptions]

readPrec :: ReadPrec CalculateRouteTruckModeOptions

readListPrec :: ReadPrec [CalculateRouteTruckModeOptions]

Show CalculateRouteTruckModeOptions

Defined in Amazonka.Location.Types.CalculateRouteTruckModeOptions

Methods

showsPrec :: Int -> CalculateRouteTruckModeOptions -> ShowS

show :: CalculateRouteTruckModeOptions -> String

showList :: [CalculateRouteTruckModeOptions] -> ShowS

NFData CalculateRouteTruckModeOptions

Defined in Amazonka.Location.Types.CalculateRouteTruckModeOptions

Methods

rnf :: CalculateRouteTruckModeOptions -> ()

Eq CalculateRouteTruckModeOptions

Defined in Amazonka.Location.Types.CalculateRouteTruckModeOptions

Methods

(==) :: CalculateRouteTruckModeOptions -> CalculateRouteTruckModeOptions -> Bool

(/=) :: CalculateRouteTruckModeOptions -> CalculateRouteTruckModeOptions -> Bool

Hashable CalculateRouteTruckModeOptions

Defined in Amazonka.Location.Types.CalculateRouteTruckModeOptions

Methods

hashWithSalt :: Int -> CalculateRouteTruckModeOptions -> Int

hash :: CalculateRouteTruckModeOptions -> Int

type Rep CalculateRouteTruckModeOptions

Defined in Amazonka.Location.Types.CalculateRouteTruckModeOptions

type Rep CalculateRouteTruckModeOptions = D1 ('MetaData "CalculateRouteTruckModeOptions" "Amazonka.Location.Types.CalculateRouteTruckModeOptions" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "CalculateRouteTruckModeOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "avoidFerries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "avoidTolls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TruckDimensions)) :*: S1 ('MetaSel ('Just "weight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TruckWeight)))))

newCalculateRouteTruckModeOptions :: CalculateRouteTruckModeOptions

Create a value of CalculateRouteTruckModeOptions 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:avoidFerries:CalculateRouteTruckModeOptions', calculateRouteTruckModeOptions_avoidFerries - Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

$sel:avoidTolls:CalculateRouteTruckModeOptions', calculateRouteTruckModeOptions_avoidTolls - Avoids tolls when calculating routes.

Default Value: false

Valid Values: false | true

$sel:dimensions:CalculateRouteTruckModeOptions', calculateRouteTruckModeOptions_dimensions - Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.

$sel:weight:CalculateRouteTruckModeOptions', calculateRouteTruckModeOptions_weight - Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.

calculateRouteTruckModeOptions_avoidFerries :: Lens' CalculateRouteTruckModeOptions (Maybe Bool)

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

calculateRouteTruckModeOptions_avoidTolls :: Lens' CalculateRouteTruckModeOptions (Maybe Bool)

Avoids tolls when calculating routes.

Default Value: false

Valid Values: false | true

calculateRouteTruckModeOptions_dimensions :: Lens' CalculateRouteTruckModeOptions (Maybe TruckDimensions)

Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.

calculateRouteTruckModeOptions_weight :: Lens' CalculateRouteTruckModeOptions (Maybe TruckWeight)

Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.