{-# 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.Evidently.Types.Treatment
-- 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.Evidently.Types.Treatment 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

-- | A structure that defines one treatment in an experiment. A treatment is
-- a variation of the feature that you are including in the experiment.
--
-- /See:/ 'newTreatment' smart constructor.
data Treatment = Treatment'
  { -- | The description of the treatment.
    Treatment -> Maybe Text
description :: Prelude.Maybe Prelude.Text,
    -- | The feature variation used for this treatment. This is a key-value pair.
    -- The key is the feature name, and the value is the variation name.
    Treatment -> Maybe (HashMap Text Text)
featureVariations :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text),
    -- | The name of this treatment.
    Treatment -> Text
name :: Prelude.Text
  }
  deriving (Treatment -> Treatment -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Treatment -> Treatment -> Bool
$c/= :: Treatment -> Treatment -> Bool
== :: Treatment -> Treatment -> Bool
$c== :: Treatment -> Treatment -> Bool
Prelude.Eq, ReadPrec [Treatment]
ReadPrec Treatment
Int -> ReadS Treatment
ReadS [Treatment]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Treatment]
$creadListPrec :: ReadPrec [Treatment]
readPrec :: ReadPrec Treatment
$creadPrec :: ReadPrec Treatment
readList :: ReadS [Treatment]
$creadList :: ReadS [Treatment]
readsPrec :: Int -> ReadS Treatment
$creadsPrec :: Int -> ReadS Treatment
Prelude.Read, Int -> Treatment -> ShowS
[Treatment] -> ShowS
Treatment -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Treatment] -> ShowS
$cshowList :: [Treatment] -> ShowS
show :: Treatment -> String
$cshow :: Treatment -> String
showsPrec :: Int -> Treatment -> ShowS
$cshowsPrec :: Int -> Treatment -> ShowS
Prelude.Show, forall x. Rep Treatment x -> Treatment
forall x. Treatment -> Rep Treatment x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Treatment x -> Treatment
$cfrom :: forall x. Treatment -> Rep Treatment x
Prelude.Generic)

-- |
-- Create a value of 'Treatment' 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:
--
-- 'description', 'treatment_description' - The description of the treatment.
--
-- 'featureVariations', 'treatment_featureVariations' - The feature variation used for this treatment. This is a key-value pair.
-- The key is the feature name, and the value is the variation name.
--
-- 'name', 'treatment_name' - The name of this treatment.
newTreatment ::
  -- | 'name'
  Prelude.Text ->
  Treatment
newTreatment :: Text -> Treatment
newTreatment Text
pName_ =
  Treatment'
    { $sel:description:Treatment' :: Maybe Text
description = forall a. Maybe a
Prelude.Nothing,
      $sel:featureVariations:Treatment' :: Maybe (HashMap Text Text)
featureVariations = forall a. Maybe a
Prelude.Nothing,
      $sel:name:Treatment' :: Text
name = Text
pName_
    }

-- | The description of the treatment.
treatment_description :: Lens.Lens' Treatment (Prelude.Maybe Prelude.Text)
treatment_description :: Lens' Treatment (Maybe Text)
treatment_description = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Treatment' {Maybe Text
description :: Maybe Text
$sel:description:Treatment' :: Treatment -> Maybe Text
description} -> Maybe Text
description) (\s :: Treatment
s@Treatment' {} Maybe Text
a -> Treatment
s {$sel:description:Treatment' :: Maybe Text
description = Maybe Text
a} :: Treatment)

-- | The feature variation used for this treatment. This is a key-value pair.
-- The key is the feature name, and the value is the variation name.
treatment_featureVariations :: Lens.Lens' Treatment (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
treatment_featureVariations :: Lens' Treatment (Maybe (HashMap Text Text))
treatment_featureVariations = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Treatment' {Maybe (HashMap Text Text)
featureVariations :: Maybe (HashMap Text Text)
$sel:featureVariations:Treatment' :: Treatment -> Maybe (HashMap Text Text)
featureVariations} -> Maybe (HashMap Text Text)
featureVariations) (\s :: Treatment
s@Treatment' {} Maybe (HashMap Text Text)
a -> Treatment
s {$sel:featureVariations:Treatment' :: Maybe (HashMap Text Text)
featureVariations = Maybe (HashMap Text Text)
a} :: Treatment) 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 name of this treatment.
treatment_name :: Lens.Lens' Treatment Prelude.Text
treatment_name :: Lens' Treatment Text
treatment_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Treatment' {Text
name :: Text
$sel:name:Treatment' :: Treatment -> Text
name} -> Text
name) (\s :: Treatment
s@Treatment' {} Text
a -> Treatment
s {$sel:name:Treatment' :: Text
name = Text
a} :: Treatment)

instance Data.FromJSON Treatment where
  parseJSON :: Value -> Parser Treatment
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"Treatment"
      ( \Object
x ->
          Maybe Text -> Maybe (HashMap Text Text) -> Text -> Treatment
Treatment'
            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
"description")
            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
"featureVariations"
                            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 a
Data..: Key
"name")
      )

instance Prelude.Hashable Treatment where
  hashWithSalt :: Int -> Treatment -> Int
hashWithSalt Int
_salt Treatment' {Maybe Text
Maybe (HashMap Text Text)
Text
name :: Text
featureVariations :: Maybe (HashMap Text Text)
description :: Maybe Text
$sel:name:Treatment' :: Treatment -> Text
$sel:featureVariations:Treatment' :: Treatment -> Maybe (HashMap Text Text)
$sel:description:Treatment' :: Treatment -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
description
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text Text)
featureVariations
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name

instance Prelude.NFData Treatment where
  rnf :: Treatment -> ()
rnf Treatment' {Maybe Text
Maybe (HashMap Text Text)
Text
name :: Text
featureVariations :: Maybe (HashMap Text Text)
description :: Maybe Text
$sel:name:Treatment' :: Treatment -> Text
$sel:featureVariations:Treatment' :: Treatment -> Maybe (HashMap Text Text)
$sel:description:Treatment' :: Treatment -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
description
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text Text)
featureVariations
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
name