{-# 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.FraudDetector.Types.EvaluatedRule
-- 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.FraudDetector.Types.EvaluatedRule where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | The details of the rule used for evaluating variable values.
--
-- /See:/ 'newEvaluatedRule' smart constructor.
data EvaluatedRule = EvaluatedRule'
  { -- | Indicates whether the rule was evaluated.
    EvaluatedRule -> Maybe Bool
evaluated :: Prelude.Maybe Prelude.Bool,
    -- | The rule expression.
    EvaluatedRule -> Maybe (Sensitive Text)
expression :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | The rule expression value.
    EvaluatedRule -> Maybe (Sensitive Text)
expressionWithValues :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | Indicates whether the rule matched.
    EvaluatedRule -> Maybe Bool
matched :: Prelude.Maybe Prelude.Bool,
    -- | The rule outcome.
    EvaluatedRule -> Maybe [Text]
outcomes :: Prelude.Maybe [Prelude.Text],
    -- | The rule ID.
    EvaluatedRule -> Maybe Text
ruleId :: Prelude.Maybe Prelude.Text,
    -- | The rule version.
    EvaluatedRule -> Maybe Text
ruleVersion :: Prelude.Maybe Prelude.Text
  }
  deriving (EvaluatedRule -> EvaluatedRule -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: EvaluatedRule -> EvaluatedRule -> Bool
$c/= :: EvaluatedRule -> EvaluatedRule -> Bool
== :: EvaluatedRule -> EvaluatedRule -> Bool
$c== :: EvaluatedRule -> EvaluatedRule -> Bool
Prelude.Eq, Int -> EvaluatedRule -> ShowS
[EvaluatedRule] -> ShowS
EvaluatedRule -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [EvaluatedRule] -> ShowS
$cshowList :: [EvaluatedRule] -> ShowS
show :: EvaluatedRule -> String
$cshow :: EvaluatedRule -> String
showsPrec :: Int -> EvaluatedRule -> ShowS
$cshowsPrec :: Int -> EvaluatedRule -> ShowS
Prelude.Show, forall x. Rep EvaluatedRule x -> EvaluatedRule
forall x. EvaluatedRule -> Rep EvaluatedRule x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep EvaluatedRule x -> EvaluatedRule
$cfrom :: forall x. EvaluatedRule -> Rep EvaluatedRule x
Prelude.Generic)

-- |
-- Create a value of 'EvaluatedRule' 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:
--
-- 'evaluated', 'evaluatedRule_evaluated' - Indicates whether the rule was evaluated.
--
-- 'expression', 'evaluatedRule_expression' - The rule expression.
--
-- 'expressionWithValues', 'evaluatedRule_expressionWithValues' - The rule expression value.
--
-- 'matched', 'evaluatedRule_matched' - Indicates whether the rule matched.
--
-- 'outcomes', 'evaluatedRule_outcomes' - The rule outcome.
--
-- 'ruleId', 'evaluatedRule_ruleId' - The rule ID.
--
-- 'ruleVersion', 'evaluatedRule_ruleVersion' - The rule version.
newEvaluatedRule ::
  EvaluatedRule
newEvaluatedRule :: EvaluatedRule
newEvaluatedRule =
  EvaluatedRule'
    { $sel:evaluated:EvaluatedRule' :: Maybe Bool
evaluated = forall a. Maybe a
Prelude.Nothing,
      $sel:expression:EvaluatedRule' :: Maybe (Sensitive Text)
expression = forall a. Maybe a
Prelude.Nothing,
      $sel:expressionWithValues:EvaluatedRule' :: Maybe (Sensitive Text)
expressionWithValues = forall a. Maybe a
Prelude.Nothing,
      $sel:matched:EvaluatedRule' :: Maybe Bool
matched = forall a. Maybe a
Prelude.Nothing,
      $sel:outcomes:EvaluatedRule' :: Maybe [Text]
outcomes = forall a. Maybe a
Prelude.Nothing,
      $sel:ruleId:EvaluatedRule' :: Maybe Text
ruleId = forall a. Maybe a
Prelude.Nothing,
      $sel:ruleVersion:EvaluatedRule' :: Maybe Text
ruleVersion = forall a. Maybe a
Prelude.Nothing
    }

-- | Indicates whether the rule was evaluated.
evaluatedRule_evaluated :: Lens.Lens' EvaluatedRule (Prelude.Maybe Prelude.Bool)
evaluatedRule_evaluated :: Lens' EvaluatedRule (Maybe Bool)
evaluatedRule_evaluated = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EvaluatedRule' {Maybe Bool
evaluated :: Maybe Bool
$sel:evaluated:EvaluatedRule' :: EvaluatedRule -> Maybe Bool
evaluated} -> Maybe Bool
evaluated) (\s :: EvaluatedRule
s@EvaluatedRule' {} Maybe Bool
a -> EvaluatedRule
s {$sel:evaluated:EvaluatedRule' :: Maybe Bool
evaluated = Maybe Bool
a} :: EvaluatedRule)

-- | The rule expression.
evaluatedRule_expression :: Lens.Lens' EvaluatedRule (Prelude.Maybe Prelude.Text)
evaluatedRule_expression :: Lens' EvaluatedRule (Maybe Text)
evaluatedRule_expression = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EvaluatedRule' {Maybe (Sensitive Text)
expression :: Maybe (Sensitive Text)
$sel:expression:EvaluatedRule' :: EvaluatedRule -> Maybe (Sensitive Text)
expression} -> Maybe (Sensitive Text)
expression) (\s :: EvaluatedRule
s@EvaluatedRule' {} Maybe (Sensitive Text)
a -> EvaluatedRule
s {$sel:expression:EvaluatedRule' :: Maybe (Sensitive Text)
expression = Maybe (Sensitive Text)
a} :: EvaluatedRule) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall a. Iso' (Sensitive a) a
Data._Sensitive

-- | The rule expression value.
evaluatedRule_expressionWithValues :: Lens.Lens' EvaluatedRule (Prelude.Maybe Prelude.Text)
evaluatedRule_expressionWithValues :: Lens' EvaluatedRule (Maybe Text)
evaluatedRule_expressionWithValues = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EvaluatedRule' {Maybe (Sensitive Text)
expressionWithValues :: Maybe (Sensitive Text)
$sel:expressionWithValues:EvaluatedRule' :: EvaluatedRule -> Maybe (Sensitive Text)
expressionWithValues} -> Maybe (Sensitive Text)
expressionWithValues) (\s :: EvaluatedRule
s@EvaluatedRule' {} Maybe (Sensitive Text)
a -> EvaluatedRule
s {$sel:expressionWithValues:EvaluatedRule' :: Maybe (Sensitive Text)
expressionWithValues = Maybe (Sensitive Text)
a} :: EvaluatedRule) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall a. Iso' (Sensitive a) a
Data._Sensitive

-- | Indicates whether the rule matched.
evaluatedRule_matched :: Lens.Lens' EvaluatedRule (Prelude.Maybe Prelude.Bool)
evaluatedRule_matched :: Lens' EvaluatedRule (Maybe Bool)
evaluatedRule_matched = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EvaluatedRule' {Maybe Bool
matched :: Maybe Bool
$sel:matched:EvaluatedRule' :: EvaluatedRule -> Maybe Bool
matched} -> Maybe Bool
matched) (\s :: EvaluatedRule
s@EvaluatedRule' {} Maybe Bool
a -> EvaluatedRule
s {$sel:matched:EvaluatedRule' :: Maybe Bool
matched = Maybe Bool
a} :: EvaluatedRule)

-- | The rule outcome.
evaluatedRule_outcomes :: Lens.Lens' EvaluatedRule (Prelude.Maybe [Prelude.Text])
evaluatedRule_outcomes :: Lens' EvaluatedRule (Maybe [Text])
evaluatedRule_outcomes = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EvaluatedRule' {Maybe [Text]
outcomes :: Maybe [Text]
$sel:outcomes:EvaluatedRule' :: EvaluatedRule -> Maybe [Text]
outcomes} -> Maybe [Text]
outcomes) (\s :: EvaluatedRule
s@EvaluatedRule' {} Maybe [Text]
a -> EvaluatedRule
s {$sel:outcomes:EvaluatedRule' :: Maybe [Text]
outcomes = Maybe [Text]
a} :: EvaluatedRule) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The rule ID.
evaluatedRule_ruleId :: Lens.Lens' EvaluatedRule (Prelude.Maybe Prelude.Text)
evaluatedRule_ruleId :: Lens' EvaluatedRule (Maybe Text)
evaluatedRule_ruleId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EvaluatedRule' {Maybe Text
ruleId :: Maybe Text
$sel:ruleId:EvaluatedRule' :: EvaluatedRule -> Maybe Text
ruleId} -> Maybe Text
ruleId) (\s :: EvaluatedRule
s@EvaluatedRule' {} Maybe Text
a -> EvaluatedRule
s {$sel:ruleId:EvaluatedRule' :: Maybe Text
ruleId = Maybe Text
a} :: EvaluatedRule)

-- | The rule version.
evaluatedRule_ruleVersion :: Lens.Lens' EvaluatedRule (Prelude.Maybe Prelude.Text)
evaluatedRule_ruleVersion :: Lens' EvaluatedRule (Maybe Text)
evaluatedRule_ruleVersion = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EvaluatedRule' {Maybe Text
ruleVersion :: Maybe Text
$sel:ruleVersion:EvaluatedRule' :: EvaluatedRule -> Maybe Text
ruleVersion} -> Maybe Text
ruleVersion) (\s :: EvaluatedRule
s@EvaluatedRule' {} Maybe Text
a -> EvaluatedRule
s {$sel:ruleVersion:EvaluatedRule' :: Maybe Text
ruleVersion = Maybe Text
a} :: EvaluatedRule)

instance Data.FromJSON EvaluatedRule where
  parseJSON :: Value -> Parser EvaluatedRule
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"EvaluatedRule"
      ( \Object
x ->
          Maybe Bool
-> Maybe (Sensitive Text)
-> Maybe (Sensitive Text)
-> Maybe Bool
-> Maybe [Text]
-> Maybe Text
-> Maybe Text
-> EvaluatedRule
EvaluatedRule'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"evaluated")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"expression")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"expressionWithValues")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"matched")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"outcomes" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ruleId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ruleVersion")
      )

instance Prelude.Hashable EvaluatedRule where
  hashWithSalt :: Int -> EvaluatedRule -> Int
hashWithSalt Int
_salt EvaluatedRule' {Maybe Bool
Maybe [Text]
Maybe Text
Maybe (Sensitive Text)
ruleVersion :: Maybe Text
ruleId :: Maybe Text
outcomes :: Maybe [Text]
matched :: Maybe Bool
expressionWithValues :: Maybe (Sensitive Text)
expression :: Maybe (Sensitive Text)
evaluated :: Maybe Bool
$sel:ruleVersion:EvaluatedRule' :: EvaluatedRule -> Maybe Text
$sel:ruleId:EvaluatedRule' :: EvaluatedRule -> Maybe Text
$sel:outcomes:EvaluatedRule' :: EvaluatedRule -> Maybe [Text]
$sel:matched:EvaluatedRule' :: EvaluatedRule -> Maybe Bool
$sel:expressionWithValues:EvaluatedRule' :: EvaluatedRule -> Maybe (Sensitive Text)
$sel:expression:EvaluatedRule' :: EvaluatedRule -> Maybe (Sensitive Text)
$sel:evaluated:EvaluatedRule' :: EvaluatedRule -> Maybe Bool
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
evaluated
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
expression
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
expressionWithValues
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
matched
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
outcomes
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
ruleId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
ruleVersion

instance Prelude.NFData EvaluatedRule where
  rnf :: EvaluatedRule -> ()
rnf EvaluatedRule' {Maybe Bool
Maybe [Text]
Maybe Text
Maybe (Sensitive Text)
ruleVersion :: Maybe Text
ruleId :: Maybe Text
outcomes :: Maybe [Text]
matched :: Maybe Bool
expressionWithValues :: Maybe (Sensitive Text)
expression :: Maybe (Sensitive Text)
evaluated :: Maybe Bool
$sel:ruleVersion:EvaluatedRule' :: EvaluatedRule -> Maybe Text
$sel:ruleId:EvaluatedRule' :: EvaluatedRule -> Maybe Text
$sel:outcomes:EvaluatedRule' :: EvaluatedRule -> Maybe [Text]
$sel:matched:EvaluatedRule' :: EvaluatedRule -> Maybe Bool
$sel:expressionWithValues:EvaluatedRule' :: EvaluatedRule -> Maybe (Sensitive Text)
$sel:expression:EvaluatedRule' :: EvaluatedRule -> Maybe (Sensitive Text)
$sel:evaluated:EvaluatedRule' :: EvaluatedRule -> Maybe Bool
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
evaluated
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
expression
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
expressionWithValues
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
matched
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
outcomes
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
ruleId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
ruleVersion