{-# 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.LexV2Models.Types.ConditionalSpecification
-- 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.LexV2Models.Types.ConditionalSpecification where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.LexV2Models.Types.ConditionalBranch
import Amazonka.LexV2Models.Types.DefaultConditionalBranch
import qualified Amazonka.Prelude as Prelude

-- | Provides a list of conditional branches. Branches are evaluated in the
-- order that they are entered in the list. The first branch with a
-- condition that evaluates to true is executed. The last branch in the
-- list is the default branch. The default branch should not have any
-- condition expression. The default branch is executed if no other branch
-- has a matching condition.
--
-- /See:/ 'newConditionalSpecification' smart constructor.
data ConditionalSpecification = ConditionalSpecification'
  { -- | Determines whether a conditional branch is active. When @active@ is
    -- false, the conditions are not evaluated.
    ConditionalSpecification -> Bool
active :: Prelude.Bool,
    -- | A list of conditional branches. A conditional branch is made up of a
    -- condition, a response and a next step. The response and next step are
    -- executed when the condition is true.
    ConditionalSpecification -> NonEmpty ConditionalBranch
conditionalBranches :: Prelude.NonEmpty ConditionalBranch,
    -- | The conditional branch that should be followed when the conditions for
    -- other branches are not satisfied. A conditional branch is made up of a
    -- condition, a response and a next step.
    ConditionalSpecification -> DefaultConditionalBranch
defaultBranch :: DefaultConditionalBranch
  }
  deriving (ConditionalSpecification -> ConditionalSpecification -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ConditionalSpecification -> ConditionalSpecification -> Bool
$c/= :: ConditionalSpecification -> ConditionalSpecification -> Bool
== :: ConditionalSpecification -> ConditionalSpecification -> Bool
$c== :: ConditionalSpecification -> ConditionalSpecification -> Bool
Prelude.Eq, ReadPrec [ConditionalSpecification]
ReadPrec ConditionalSpecification
Int -> ReadS ConditionalSpecification
ReadS [ConditionalSpecification]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ConditionalSpecification]
$creadListPrec :: ReadPrec [ConditionalSpecification]
readPrec :: ReadPrec ConditionalSpecification
$creadPrec :: ReadPrec ConditionalSpecification
readList :: ReadS [ConditionalSpecification]
$creadList :: ReadS [ConditionalSpecification]
readsPrec :: Int -> ReadS ConditionalSpecification
$creadsPrec :: Int -> ReadS ConditionalSpecification
Prelude.Read, Int -> ConditionalSpecification -> ShowS
[ConditionalSpecification] -> ShowS
ConditionalSpecification -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ConditionalSpecification] -> ShowS
$cshowList :: [ConditionalSpecification] -> ShowS
show :: ConditionalSpecification -> String
$cshow :: ConditionalSpecification -> String
showsPrec :: Int -> ConditionalSpecification -> ShowS
$cshowsPrec :: Int -> ConditionalSpecification -> ShowS
Prelude.Show, forall x.
Rep ConditionalSpecification x -> ConditionalSpecification
forall x.
ConditionalSpecification -> Rep ConditionalSpecification x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ConditionalSpecification x -> ConditionalSpecification
$cfrom :: forall x.
ConditionalSpecification -> Rep ConditionalSpecification x
Prelude.Generic)

-- |
-- Create a value of 'ConditionalSpecification' 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:
--
-- 'active', 'conditionalSpecification_active' - Determines whether a conditional branch is active. When @active@ is
-- false, the conditions are not evaluated.
--
-- 'conditionalBranches', 'conditionalSpecification_conditionalBranches' - A list of conditional branches. A conditional branch is made up of a
-- condition, a response and a next step. The response and next step are
-- executed when the condition is true.
--
-- 'defaultBranch', 'conditionalSpecification_defaultBranch' - The conditional branch that should be followed when the conditions for
-- other branches are not satisfied. A conditional branch is made up of a
-- condition, a response and a next step.
newConditionalSpecification ::
  -- | 'active'
  Prelude.Bool ->
  -- | 'conditionalBranches'
  Prelude.NonEmpty ConditionalBranch ->
  -- | 'defaultBranch'
  DefaultConditionalBranch ->
  ConditionalSpecification
newConditionalSpecification :: Bool
-> NonEmpty ConditionalBranch
-> DefaultConditionalBranch
-> ConditionalSpecification
newConditionalSpecification
  Bool
pActive_
  NonEmpty ConditionalBranch
pConditionalBranches_
  DefaultConditionalBranch
pDefaultBranch_ =
    ConditionalSpecification'
      { $sel:active:ConditionalSpecification' :: Bool
active = Bool
pActive_,
        $sel:conditionalBranches:ConditionalSpecification' :: NonEmpty ConditionalBranch
conditionalBranches =
          forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced forall t b. AReview t b -> b -> t
Lens.# NonEmpty ConditionalBranch
pConditionalBranches_,
        $sel:defaultBranch:ConditionalSpecification' :: DefaultConditionalBranch
defaultBranch = DefaultConditionalBranch
pDefaultBranch_
      }

-- | Determines whether a conditional branch is active. When @active@ is
-- false, the conditions are not evaluated.
conditionalSpecification_active :: Lens.Lens' ConditionalSpecification Prelude.Bool
conditionalSpecification_active :: Lens' ConditionalSpecification Bool
conditionalSpecification_active = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ConditionalSpecification' {Bool
active :: Bool
$sel:active:ConditionalSpecification' :: ConditionalSpecification -> Bool
active} -> Bool
active) (\s :: ConditionalSpecification
s@ConditionalSpecification' {} Bool
a -> ConditionalSpecification
s {$sel:active:ConditionalSpecification' :: Bool
active = Bool
a} :: ConditionalSpecification)

-- | A list of conditional branches. A conditional branch is made up of a
-- condition, a response and a next step. The response and next step are
-- executed when the condition is true.
conditionalSpecification_conditionalBranches :: Lens.Lens' ConditionalSpecification (Prelude.NonEmpty ConditionalBranch)
conditionalSpecification_conditionalBranches :: Lens' ConditionalSpecification (NonEmpty ConditionalBranch)
conditionalSpecification_conditionalBranches = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ConditionalSpecification' {NonEmpty ConditionalBranch
conditionalBranches :: NonEmpty ConditionalBranch
$sel:conditionalBranches:ConditionalSpecification' :: ConditionalSpecification -> NonEmpty ConditionalBranch
conditionalBranches} -> NonEmpty ConditionalBranch
conditionalBranches) (\s :: ConditionalSpecification
s@ConditionalSpecification' {} NonEmpty ConditionalBranch
a -> ConditionalSpecification
s {$sel:conditionalBranches:ConditionalSpecification' :: NonEmpty ConditionalBranch
conditionalBranches = NonEmpty ConditionalBranch
a} :: ConditionalSpecification) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The conditional branch that should be followed when the conditions for
-- other branches are not satisfied. A conditional branch is made up of a
-- condition, a response and a next step.
conditionalSpecification_defaultBranch :: Lens.Lens' ConditionalSpecification DefaultConditionalBranch
conditionalSpecification_defaultBranch :: Lens' ConditionalSpecification DefaultConditionalBranch
conditionalSpecification_defaultBranch = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ConditionalSpecification' {DefaultConditionalBranch
defaultBranch :: DefaultConditionalBranch
$sel:defaultBranch:ConditionalSpecification' :: ConditionalSpecification -> DefaultConditionalBranch
defaultBranch} -> DefaultConditionalBranch
defaultBranch) (\s :: ConditionalSpecification
s@ConditionalSpecification' {} DefaultConditionalBranch
a -> ConditionalSpecification
s {$sel:defaultBranch:ConditionalSpecification' :: DefaultConditionalBranch
defaultBranch = DefaultConditionalBranch
a} :: ConditionalSpecification)

instance Data.FromJSON ConditionalSpecification where
  parseJSON :: Value -> Parser ConditionalSpecification
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ConditionalSpecification"
      ( \Object
x ->
          Bool
-> NonEmpty ConditionalBranch
-> DefaultConditionalBranch
-> ConditionalSpecification
ConditionalSpecification'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"active")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"conditionalBranches")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"defaultBranch")
      )

instance Prelude.Hashable ConditionalSpecification where
  hashWithSalt :: Int -> ConditionalSpecification -> Int
hashWithSalt Int
_salt ConditionalSpecification' {Bool
NonEmpty ConditionalBranch
DefaultConditionalBranch
defaultBranch :: DefaultConditionalBranch
conditionalBranches :: NonEmpty ConditionalBranch
active :: Bool
$sel:defaultBranch:ConditionalSpecification' :: ConditionalSpecification -> DefaultConditionalBranch
$sel:conditionalBranches:ConditionalSpecification' :: ConditionalSpecification -> NonEmpty ConditionalBranch
$sel:active:ConditionalSpecification' :: ConditionalSpecification -> Bool
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Bool
active
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` NonEmpty ConditionalBranch
conditionalBranches
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` DefaultConditionalBranch
defaultBranch

instance Prelude.NFData ConditionalSpecification where
  rnf :: ConditionalSpecification -> ()
rnf ConditionalSpecification' {Bool
NonEmpty ConditionalBranch
DefaultConditionalBranch
defaultBranch :: DefaultConditionalBranch
conditionalBranches :: NonEmpty ConditionalBranch
active :: Bool
$sel:defaultBranch:ConditionalSpecification' :: ConditionalSpecification -> DefaultConditionalBranch
$sel:conditionalBranches:ConditionalSpecification' :: ConditionalSpecification -> NonEmpty ConditionalBranch
$sel:active:ConditionalSpecification' :: ConditionalSpecification -> Bool
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Bool
active
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf NonEmpty ConditionalBranch
conditionalBranches
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf DefaultConditionalBranch
defaultBranch

instance Data.ToJSON ConditionalSpecification where
  toJSON :: ConditionalSpecification -> Value
toJSON ConditionalSpecification' {Bool
NonEmpty ConditionalBranch
DefaultConditionalBranch
defaultBranch :: DefaultConditionalBranch
conditionalBranches :: NonEmpty ConditionalBranch
active :: Bool
$sel:defaultBranch:ConditionalSpecification' :: ConditionalSpecification -> DefaultConditionalBranch
$sel:conditionalBranches:ConditionalSpecification' :: ConditionalSpecification -> NonEmpty ConditionalBranch
$sel:active:ConditionalSpecification' :: ConditionalSpecification -> Bool
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"active" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Bool
active),
            forall a. a -> Maybe a
Prelude.Just
              (Key
"conditionalBranches" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= NonEmpty ConditionalBranch
conditionalBranches),
            forall a. a -> Maybe a
Prelude.Just
              (Key
"defaultBranch" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= DefaultConditionalBranch
defaultBranch)
          ]
      )