{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Location.Types.CalculateRouteTruckModeOptions
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Location.Types.CalculateRouteTruckModeOptions where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Location.Types.TruckDimensions
import Amazonka.Location.Types.TruckWeight
import qualified Amazonka.Prelude as Prelude

-- | Contains details about additional route preferences for requests that
-- specify @TravelMode@ as @Truck@.
--
-- /See:/ 'newCalculateRouteTruckModeOptions' smart constructor.
data CalculateRouteTruckModeOptions = CalculateRouteTruckModeOptions'
  { -- | Avoids ferries when calculating routes.
    --
    -- Default Value: @false@
    --
    -- Valid Values: @false@ | @true@
    CalculateRouteTruckModeOptions -> Maybe Bool
avoidFerries :: Prelude.Maybe Prelude.Bool,
    -- | Avoids tolls when calculating routes.
    --
    -- Default Value: @false@
    --
    -- Valid Values: @false@ | @true@
    CalculateRouteTruckModeOptions -> Maybe Bool
avoidTolls :: Prelude.Maybe Prelude.Bool,
    -- | 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 -> Maybe TruckDimensions
dimensions :: Prelude.Maybe TruckDimensions,
    -- | 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 -> Maybe TruckWeight
weight :: Prelude.Maybe TruckWeight
  }
  deriving (CalculateRouteTruckModeOptions
-> CalculateRouteTruckModeOptions -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CalculateRouteTruckModeOptions
-> CalculateRouteTruckModeOptions -> Bool
$c/= :: CalculateRouteTruckModeOptions
-> CalculateRouteTruckModeOptions -> Bool
== :: CalculateRouteTruckModeOptions
-> CalculateRouteTruckModeOptions -> Bool
$c== :: CalculateRouteTruckModeOptions
-> CalculateRouteTruckModeOptions -> Bool
Prelude.Eq, ReadPrec [CalculateRouteTruckModeOptions]
ReadPrec CalculateRouteTruckModeOptions
Int -> ReadS CalculateRouteTruckModeOptions
ReadS [CalculateRouteTruckModeOptions]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CalculateRouteTruckModeOptions]
$creadListPrec :: ReadPrec [CalculateRouteTruckModeOptions]
readPrec :: ReadPrec CalculateRouteTruckModeOptions
$creadPrec :: ReadPrec CalculateRouteTruckModeOptions
readList :: ReadS [CalculateRouteTruckModeOptions]
$creadList :: ReadS [CalculateRouteTruckModeOptions]
readsPrec :: Int -> ReadS CalculateRouteTruckModeOptions
$creadsPrec :: Int -> ReadS CalculateRouteTruckModeOptions
Prelude.Read, Int -> CalculateRouteTruckModeOptions -> ShowS
[CalculateRouteTruckModeOptions] -> ShowS
CalculateRouteTruckModeOptions -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CalculateRouteTruckModeOptions] -> ShowS
$cshowList :: [CalculateRouteTruckModeOptions] -> ShowS
show :: CalculateRouteTruckModeOptions -> String
$cshow :: CalculateRouteTruckModeOptions -> String
showsPrec :: Int -> CalculateRouteTruckModeOptions -> ShowS
$cshowsPrec :: Int -> CalculateRouteTruckModeOptions -> ShowS
Prelude.Show, forall x.
Rep CalculateRouteTruckModeOptions x
-> CalculateRouteTruckModeOptions
forall x.
CalculateRouteTruckModeOptions
-> Rep CalculateRouteTruckModeOptions x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CalculateRouteTruckModeOptions x
-> CalculateRouteTruckModeOptions
$cfrom :: forall x.
CalculateRouteTruckModeOptions
-> Rep CalculateRouteTruckModeOptions x
Prelude.Generic)

-- |
-- Create a value of 'CalculateRouteTruckModeOptions' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'avoidFerries', 'calculateRouteTruckModeOptions_avoidFerries' - Avoids ferries when calculating routes.
--
-- Default Value: @false@
--
-- Valid Values: @false@ | @true@
--
-- 'avoidTolls', 'calculateRouteTruckModeOptions_avoidTolls' - Avoids tolls when calculating routes.
--
-- Default Value: @false@
--
-- Valid Values: @false@ | @true@
--
-- 'dimensions', '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.
--
-- 'weight', '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.
newCalculateRouteTruckModeOptions ::
  CalculateRouteTruckModeOptions
newCalculateRouteTruckModeOptions :: CalculateRouteTruckModeOptions
newCalculateRouteTruckModeOptions =
  CalculateRouteTruckModeOptions'
    { $sel:avoidFerries:CalculateRouteTruckModeOptions' :: Maybe Bool
avoidFerries =
        forall a. Maybe a
Prelude.Nothing,
      $sel:avoidTolls:CalculateRouteTruckModeOptions' :: Maybe Bool
avoidTolls = forall a. Maybe a
Prelude.Nothing,
      $sel:dimensions:CalculateRouteTruckModeOptions' :: Maybe TruckDimensions
dimensions = forall a. Maybe a
Prelude.Nothing,
      $sel:weight:CalculateRouteTruckModeOptions' :: Maybe TruckWeight
weight = forall a. Maybe a
Prelude.Nothing
    }

-- | Avoids ferries when calculating routes.
--
-- Default Value: @false@
--
-- Valid Values: @false@ | @true@
calculateRouteTruckModeOptions_avoidFerries :: Lens.Lens' CalculateRouteTruckModeOptions (Prelude.Maybe Prelude.Bool)
calculateRouteTruckModeOptions_avoidFerries :: Lens' CalculateRouteTruckModeOptions (Maybe Bool)
calculateRouteTruckModeOptions_avoidFerries = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CalculateRouteTruckModeOptions' {Maybe Bool
avoidFerries :: Maybe Bool
$sel:avoidFerries:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe Bool
avoidFerries} -> Maybe Bool
avoidFerries) (\s :: CalculateRouteTruckModeOptions
s@CalculateRouteTruckModeOptions' {} Maybe Bool
a -> CalculateRouteTruckModeOptions
s {$sel:avoidFerries:CalculateRouteTruckModeOptions' :: Maybe Bool
avoidFerries = Maybe Bool
a} :: CalculateRouteTruckModeOptions)

-- | Avoids tolls when calculating routes.
--
-- Default Value: @false@
--
-- Valid Values: @false@ | @true@
calculateRouteTruckModeOptions_avoidTolls :: Lens.Lens' CalculateRouteTruckModeOptions (Prelude.Maybe Prelude.Bool)
calculateRouteTruckModeOptions_avoidTolls :: Lens' CalculateRouteTruckModeOptions (Maybe Bool)
calculateRouteTruckModeOptions_avoidTolls = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CalculateRouteTruckModeOptions' {Maybe Bool
avoidTolls :: Maybe Bool
$sel:avoidTolls:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe Bool
avoidTolls} -> Maybe Bool
avoidTolls) (\s :: CalculateRouteTruckModeOptions
s@CalculateRouteTruckModeOptions' {} Maybe Bool
a -> CalculateRouteTruckModeOptions
s {$sel:avoidTolls:CalculateRouteTruckModeOptions' :: Maybe Bool
avoidTolls = Maybe Bool
a} :: CalculateRouteTruckModeOptions)

-- | 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_dimensions :: Lens.Lens' CalculateRouteTruckModeOptions (Prelude.Maybe TruckDimensions)
calculateRouteTruckModeOptions_dimensions :: Lens' CalculateRouteTruckModeOptions (Maybe TruckDimensions)
calculateRouteTruckModeOptions_dimensions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CalculateRouteTruckModeOptions' {Maybe TruckDimensions
dimensions :: Maybe TruckDimensions
$sel:dimensions:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe TruckDimensions
dimensions} -> Maybe TruckDimensions
dimensions) (\s :: CalculateRouteTruckModeOptions
s@CalculateRouteTruckModeOptions' {} Maybe TruckDimensions
a -> CalculateRouteTruckModeOptions
s {$sel:dimensions:CalculateRouteTruckModeOptions' :: Maybe TruckDimensions
dimensions = Maybe TruckDimensions
a} :: CalculateRouteTruckModeOptions)

-- | 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_weight :: Lens.Lens' CalculateRouteTruckModeOptions (Prelude.Maybe TruckWeight)
calculateRouteTruckModeOptions_weight :: Lens' CalculateRouteTruckModeOptions (Maybe TruckWeight)
calculateRouteTruckModeOptions_weight = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CalculateRouteTruckModeOptions' {Maybe TruckWeight
weight :: Maybe TruckWeight
$sel:weight:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe TruckWeight
weight} -> Maybe TruckWeight
weight) (\s :: CalculateRouteTruckModeOptions
s@CalculateRouteTruckModeOptions' {} Maybe TruckWeight
a -> CalculateRouteTruckModeOptions
s {$sel:weight:CalculateRouteTruckModeOptions' :: Maybe TruckWeight
weight = Maybe TruckWeight
a} :: CalculateRouteTruckModeOptions)

instance
  Prelude.Hashable
    CalculateRouteTruckModeOptions
  where
  hashWithSalt :: Int -> CalculateRouteTruckModeOptions -> Int
hashWithSalt
    Int
_salt
    CalculateRouteTruckModeOptions' {Maybe Bool
Maybe TruckDimensions
Maybe TruckWeight
weight :: Maybe TruckWeight
dimensions :: Maybe TruckDimensions
avoidTolls :: Maybe Bool
avoidFerries :: Maybe Bool
$sel:weight:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe TruckWeight
$sel:dimensions:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe TruckDimensions
$sel:avoidTolls:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe Bool
$sel:avoidFerries:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe Bool
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
avoidFerries
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
avoidTolls
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe TruckDimensions
dimensions
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe TruckWeight
weight

instance
  Prelude.NFData
    CalculateRouteTruckModeOptions
  where
  rnf :: CalculateRouteTruckModeOptions -> ()
rnf CalculateRouteTruckModeOptions' {Maybe Bool
Maybe TruckDimensions
Maybe TruckWeight
weight :: Maybe TruckWeight
dimensions :: Maybe TruckDimensions
avoidTolls :: Maybe Bool
avoidFerries :: Maybe Bool
$sel:weight:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe TruckWeight
$sel:dimensions:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe TruckDimensions
$sel:avoidTolls:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe Bool
$sel:avoidFerries:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe Bool
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
avoidFerries
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
avoidTolls
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe TruckDimensions
dimensions
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe TruckWeight
weight

instance Data.ToJSON CalculateRouteTruckModeOptions where
  toJSON :: CalculateRouteTruckModeOptions -> Value
toJSON CalculateRouteTruckModeOptions' {Maybe Bool
Maybe TruckDimensions
Maybe TruckWeight
weight :: Maybe TruckWeight
dimensions :: Maybe TruckDimensions
avoidTolls :: Maybe Bool
avoidFerries :: Maybe Bool
$sel:weight:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe TruckWeight
$sel:dimensions:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe TruckDimensions
$sel:avoidTolls:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe Bool
$sel:avoidFerries:CalculateRouteTruckModeOptions' :: CalculateRouteTruckModeOptions -> Maybe Bool
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"AvoidFerries" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
avoidFerries,
            (Key
"AvoidTolls" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
avoidTolls,
            (Key
"Dimensions" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe TruckDimensions
dimensions,
            (Key
"Weight" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe TruckWeight
weight
          ]
      )