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.TruckDimensions

Description

 
Synopsis

Documentation

data TruckDimensions Source #

Contains details about the truck dimensions in the unit of measurement that you specify. Used to filter out roads that can't support or allow the specified dimensions for requests that specify TravelMode as Truck.

See: newTruckDimensions smart constructor.

Constructors

TruckDimensions' 

Fields

  • height :: Maybe Double

    The height of the truck.

    • For example, 4.5.

    For routes calculated with a HERE resource, this value must be between 0 and 50 meters.

  • length :: Maybe Double

    The length of the truck.

    • For example, 15.5.

    For routes calculated with a HERE resource, this value must be between 0 and 300 meters.

  • unit :: Maybe DimensionUnit

    Specifies the unit of measurement for the truck dimensions.

    Default Value: Meters

  • width :: Maybe Double

    The width of the truck.

    • For example, 4.5.

    For routes calculated with a HERE resource, this value must be between 0 and 50 meters.

Instances

Instances details
ToJSON TruckDimensions Source # 
Instance details

Defined in Amazonka.Location.Types.TruckDimensions

Generic TruckDimensions Source # 
Instance details

Defined in Amazonka.Location.Types.TruckDimensions

Associated Types

type Rep TruckDimensions :: Type -> Type #

Read TruckDimensions Source # 
Instance details

Defined in Amazonka.Location.Types.TruckDimensions

Show TruckDimensions Source # 
Instance details

Defined in Amazonka.Location.Types.TruckDimensions

NFData TruckDimensions Source # 
Instance details

Defined in Amazonka.Location.Types.TruckDimensions

Methods

rnf :: TruckDimensions -> () #

Eq TruckDimensions Source # 
Instance details

Defined in Amazonka.Location.Types.TruckDimensions

Hashable TruckDimensions Source # 
Instance details

Defined in Amazonka.Location.Types.TruckDimensions

type Rep TruckDimensions Source # 
Instance details

Defined in Amazonka.Location.Types.TruckDimensions

type Rep TruckDimensions = D1 ('MetaData "TruckDimensions" "Amazonka.Location.Types.TruckDimensions" "amazonka-location-2.0-4NLaYgEbMXwF6j2j7LAFNb" 'False) (C1 ('MetaCons "TruckDimensions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "length") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DimensionUnit)) :*: S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))

newTruckDimensions :: TruckDimensions Source #

Create a value of TruckDimensions 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:height:TruckDimensions', truckDimensions_height - The height of the truck.

  • For example, 4.5.

For routes calculated with a HERE resource, this value must be between 0 and 50 meters.

$sel:length:TruckDimensions', truckDimensions_length - The length of the truck.

  • For example, 15.5.

For routes calculated with a HERE resource, this value must be between 0 and 300 meters.

$sel:unit:TruckDimensions', truckDimensions_unit - Specifies the unit of measurement for the truck dimensions.

Default Value: Meters

$sel:width:TruckDimensions', truckDimensions_width - The width of the truck.

  • For example, 4.5.

For routes calculated with a HERE resource, this value must be between 0 and 50 meters.

truckDimensions_height :: Lens' TruckDimensions (Maybe Double) Source #

The height of the truck.

  • For example, 4.5.

For routes calculated with a HERE resource, this value must be between 0 and 50 meters.

truckDimensions_length :: Lens' TruckDimensions (Maybe Double) Source #

The length of the truck.

  • For example, 15.5.

For routes calculated with a HERE resource, this value must be between 0 and 300 meters.

truckDimensions_unit :: Lens' TruckDimensions (Maybe DimensionUnit) Source #

Specifies the unit of measurement for the truck dimensions.

Default Value: Meters

truckDimensions_width :: Lens' TruckDimensions (Maybe Double) Source #

The width of the truck.

  • For example, 4.5.

For routes calculated with a HERE resource, this value must be between 0 and 50 meters.