{-# 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.ExperimentReport
-- 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.ExperimentReport where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Evidently.Types.ExperimentReportName
import qualified Amazonka.Prelude as Prelude

-- | A structure that contains results of an experiment.
--
-- /See:/ 'newExperimentReport' smart constructor.
data ExperimentReport = ExperimentReport'
  { -- | The content of the report.
    ExperimentReport -> Maybe Text
content :: Prelude.Maybe Prelude.Text,
    -- | The name of the metric that is analyzed in this experiment report.
    ExperimentReport -> Maybe Text
metricName :: Prelude.Maybe Prelude.Text,
    -- | The type of analysis used for this report.
    ExperimentReport -> Maybe ExperimentReportName
reportName :: Prelude.Maybe ExperimentReportName,
    -- | The name of the variation that this report pertains to.
    ExperimentReport -> Maybe Text
treatmentName :: Prelude.Maybe Prelude.Text
  }
  deriving (ExperimentReport -> ExperimentReport -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ExperimentReport -> ExperimentReport -> Bool
$c/= :: ExperimentReport -> ExperimentReport -> Bool
== :: ExperimentReport -> ExperimentReport -> Bool
$c== :: ExperimentReport -> ExperimentReport -> Bool
Prelude.Eq, ReadPrec [ExperimentReport]
ReadPrec ExperimentReport
Int -> ReadS ExperimentReport
ReadS [ExperimentReport]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ExperimentReport]
$creadListPrec :: ReadPrec [ExperimentReport]
readPrec :: ReadPrec ExperimentReport
$creadPrec :: ReadPrec ExperimentReport
readList :: ReadS [ExperimentReport]
$creadList :: ReadS [ExperimentReport]
readsPrec :: Int -> ReadS ExperimentReport
$creadsPrec :: Int -> ReadS ExperimentReport
Prelude.Read, Int -> ExperimentReport -> ShowS
[ExperimentReport] -> ShowS
ExperimentReport -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ExperimentReport] -> ShowS
$cshowList :: [ExperimentReport] -> ShowS
show :: ExperimentReport -> String
$cshow :: ExperimentReport -> String
showsPrec :: Int -> ExperimentReport -> ShowS
$cshowsPrec :: Int -> ExperimentReport -> ShowS
Prelude.Show, forall x. Rep ExperimentReport x -> ExperimentReport
forall x. ExperimentReport -> Rep ExperimentReport x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ExperimentReport x -> ExperimentReport
$cfrom :: forall x. ExperimentReport -> Rep ExperimentReport x
Prelude.Generic)

-- |
-- Create a value of 'ExperimentReport' 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:
--
-- 'content', 'experimentReport_content' - The content of the report.
--
-- 'metricName', 'experimentReport_metricName' - The name of the metric that is analyzed in this experiment report.
--
-- 'reportName', 'experimentReport_reportName' - The type of analysis used for this report.
--
-- 'treatmentName', 'experimentReport_treatmentName' - The name of the variation that this report pertains to.
newExperimentReport ::
  ExperimentReport
newExperimentReport :: ExperimentReport
newExperimentReport =
  ExperimentReport'
    { $sel:content:ExperimentReport' :: Maybe Text
content = forall a. Maybe a
Prelude.Nothing,
      $sel:metricName:ExperimentReport' :: Maybe Text
metricName = forall a. Maybe a
Prelude.Nothing,
      $sel:reportName:ExperimentReport' :: Maybe ExperimentReportName
reportName = forall a. Maybe a
Prelude.Nothing,
      $sel:treatmentName:ExperimentReport' :: Maybe Text
treatmentName = forall a. Maybe a
Prelude.Nothing
    }

-- | The content of the report.
experimentReport_content :: Lens.Lens' ExperimentReport (Prelude.Maybe Prelude.Text)
experimentReport_content :: Lens' ExperimentReport (Maybe Text)
experimentReport_content = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExperimentReport' {Maybe Text
content :: Maybe Text
$sel:content:ExperimentReport' :: ExperimentReport -> Maybe Text
content} -> Maybe Text
content) (\s :: ExperimentReport
s@ExperimentReport' {} Maybe Text
a -> ExperimentReport
s {$sel:content:ExperimentReport' :: Maybe Text
content = Maybe Text
a} :: ExperimentReport)

-- | The name of the metric that is analyzed in this experiment report.
experimentReport_metricName :: Lens.Lens' ExperimentReport (Prelude.Maybe Prelude.Text)
experimentReport_metricName :: Lens' ExperimentReport (Maybe Text)
experimentReport_metricName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExperimentReport' {Maybe Text
metricName :: Maybe Text
$sel:metricName:ExperimentReport' :: ExperimentReport -> Maybe Text
metricName} -> Maybe Text
metricName) (\s :: ExperimentReport
s@ExperimentReport' {} Maybe Text
a -> ExperimentReport
s {$sel:metricName:ExperimentReport' :: Maybe Text
metricName = Maybe Text
a} :: ExperimentReport)

-- | The type of analysis used for this report.
experimentReport_reportName :: Lens.Lens' ExperimentReport (Prelude.Maybe ExperimentReportName)
experimentReport_reportName :: Lens' ExperimentReport (Maybe ExperimentReportName)
experimentReport_reportName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExperimentReport' {Maybe ExperimentReportName
reportName :: Maybe ExperimentReportName
$sel:reportName:ExperimentReport' :: ExperimentReport -> Maybe ExperimentReportName
reportName} -> Maybe ExperimentReportName
reportName) (\s :: ExperimentReport
s@ExperimentReport' {} Maybe ExperimentReportName
a -> ExperimentReport
s {$sel:reportName:ExperimentReport' :: Maybe ExperimentReportName
reportName = Maybe ExperimentReportName
a} :: ExperimentReport)

-- | The name of the variation that this report pertains to.
experimentReport_treatmentName :: Lens.Lens' ExperimentReport (Prelude.Maybe Prelude.Text)
experimentReport_treatmentName :: Lens' ExperimentReport (Maybe Text)
experimentReport_treatmentName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExperimentReport' {Maybe Text
treatmentName :: Maybe Text
$sel:treatmentName:ExperimentReport' :: ExperimentReport -> Maybe Text
treatmentName} -> Maybe Text
treatmentName) (\s :: ExperimentReport
s@ExperimentReport' {} Maybe Text
a -> ExperimentReport
s {$sel:treatmentName:ExperimentReport' :: Maybe Text
treatmentName = Maybe Text
a} :: ExperimentReport)

instance Data.FromJSON ExperimentReport where
  parseJSON :: Value -> Parser ExperimentReport
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ExperimentReport"
      ( \Object
x ->
          Maybe Text
-> Maybe Text
-> Maybe ExperimentReportName
-> Maybe Text
-> ExperimentReport
ExperimentReport'
            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
"content")
            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
"metricName")
            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
"reportName")
            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
"treatmentName")
      )

instance Prelude.Hashable ExperimentReport where
  hashWithSalt :: Int -> ExperimentReport -> Int
hashWithSalt Int
_salt ExperimentReport' {Maybe Text
Maybe ExperimentReportName
treatmentName :: Maybe Text
reportName :: Maybe ExperimentReportName
metricName :: Maybe Text
content :: Maybe Text
$sel:treatmentName:ExperimentReport' :: ExperimentReport -> Maybe Text
$sel:reportName:ExperimentReport' :: ExperimentReport -> Maybe ExperimentReportName
$sel:metricName:ExperimentReport' :: ExperimentReport -> Maybe Text
$sel:content:ExperimentReport' :: ExperimentReport -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
content
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
metricName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ExperimentReportName
reportName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
treatmentName

instance Prelude.NFData ExperimentReport where
  rnf :: ExperimentReport -> ()
rnf ExperimentReport' {Maybe Text
Maybe ExperimentReportName
treatmentName :: Maybe Text
reportName :: Maybe ExperimentReportName
metricName :: Maybe Text
content :: Maybe Text
$sel:treatmentName:ExperimentReport' :: ExperimentReport -> Maybe Text
$sel:reportName:ExperimentReport' :: ExperimentReport -> Maybe ExperimentReportName
$sel:metricName:ExperimentReport' :: ExperimentReport -> Maybe Text
$sel:content:ExperimentReport' :: ExperimentReport -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
content
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
metricName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ExperimentReportName
reportName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
treatmentName