{-# 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.MetricGoalConfig
-- 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.MetricGoalConfig 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.ChangeDirectionEnum
import Amazonka.Evidently.Types.MetricDefinitionConfig
import qualified Amazonka.Prelude as Prelude

-- | Use this structure to tell Evidently whether higher or lower values are
-- desired for a metric that is used in an experiment.
--
-- /See:/ 'newMetricGoalConfig' smart constructor.
data MetricGoalConfig = MetricGoalConfig'
  { -- | @INCREASE@ means that a variation with a higher number for this metric
    -- is performing better.
    --
    -- @DECREASE@ means that a variation with a lower number for this metric is
    -- performing better.
    MetricGoalConfig -> Maybe ChangeDirectionEnum
desiredChange :: Prelude.Maybe ChangeDirectionEnum,
    -- | A structure that contains details about the metric.
    MetricGoalConfig -> MetricDefinitionConfig
metricDefinition :: MetricDefinitionConfig
  }
  deriving (MetricGoalConfig -> MetricGoalConfig -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: MetricGoalConfig -> MetricGoalConfig -> Bool
$c/= :: MetricGoalConfig -> MetricGoalConfig -> Bool
== :: MetricGoalConfig -> MetricGoalConfig -> Bool
$c== :: MetricGoalConfig -> MetricGoalConfig -> Bool
Prelude.Eq, ReadPrec [MetricGoalConfig]
ReadPrec MetricGoalConfig
Int -> ReadS MetricGoalConfig
ReadS [MetricGoalConfig]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [MetricGoalConfig]
$creadListPrec :: ReadPrec [MetricGoalConfig]
readPrec :: ReadPrec MetricGoalConfig
$creadPrec :: ReadPrec MetricGoalConfig
readList :: ReadS [MetricGoalConfig]
$creadList :: ReadS [MetricGoalConfig]
readsPrec :: Int -> ReadS MetricGoalConfig
$creadsPrec :: Int -> ReadS MetricGoalConfig
Prelude.Read, Int -> MetricGoalConfig -> ShowS
[MetricGoalConfig] -> ShowS
MetricGoalConfig -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [MetricGoalConfig] -> ShowS
$cshowList :: [MetricGoalConfig] -> ShowS
show :: MetricGoalConfig -> String
$cshow :: MetricGoalConfig -> String
showsPrec :: Int -> MetricGoalConfig -> ShowS
$cshowsPrec :: Int -> MetricGoalConfig -> ShowS
Prelude.Show, forall x. Rep MetricGoalConfig x -> MetricGoalConfig
forall x. MetricGoalConfig -> Rep MetricGoalConfig x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep MetricGoalConfig x -> MetricGoalConfig
$cfrom :: forall x. MetricGoalConfig -> Rep MetricGoalConfig x
Prelude.Generic)

-- |
-- Create a value of 'MetricGoalConfig' 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:
--
-- 'desiredChange', 'metricGoalConfig_desiredChange' - @INCREASE@ means that a variation with a higher number for this metric
-- is performing better.
--
-- @DECREASE@ means that a variation with a lower number for this metric is
-- performing better.
--
-- 'metricDefinition', 'metricGoalConfig_metricDefinition' - A structure that contains details about the metric.
newMetricGoalConfig ::
  -- | 'metricDefinition'
  MetricDefinitionConfig ->
  MetricGoalConfig
newMetricGoalConfig :: MetricDefinitionConfig -> MetricGoalConfig
newMetricGoalConfig MetricDefinitionConfig
pMetricDefinition_ =
  MetricGoalConfig'
    { $sel:desiredChange:MetricGoalConfig' :: Maybe ChangeDirectionEnum
desiredChange = forall a. Maybe a
Prelude.Nothing,
      $sel:metricDefinition:MetricGoalConfig' :: MetricDefinitionConfig
metricDefinition = MetricDefinitionConfig
pMetricDefinition_
    }

-- | @INCREASE@ means that a variation with a higher number for this metric
-- is performing better.
--
-- @DECREASE@ means that a variation with a lower number for this metric is
-- performing better.
metricGoalConfig_desiredChange :: Lens.Lens' MetricGoalConfig (Prelude.Maybe ChangeDirectionEnum)
metricGoalConfig_desiredChange :: Lens' MetricGoalConfig (Maybe ChangeDirectionEnum)
metricGoalConfig_desiredChange = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricGoalConfig' {Maybe ChangeDirectionEnum
desiredChange :: Maybe ChangeDirectionEnum
$sel:desiredChange:MetricGoalConfig' :: MetricGoalConfig -> Maybe ChangeDirectionEnum
desiredChange} -> Maybe ChangeDirectionEnum
desiredChange) (\s :: MetricGoalConfig
s@MetricGoalConfig' {} Maybe ChangeDirectionEnum
a -> MetricGoalConfig
s {$sel:desiredChange:MetricGoalConfig' :: Maybe ChangeDirectionEnum
desiredChange = Maybe ChangeDirectionEnum
a} :: MetricGoalConfig)

-- | A structure that contains details about the metric.
metricGoalConfig_metricDefinition :: Lens.Lens' MetricGoalConfig MetricDefinitionConfig
metricGoalConfig_metricDefinition :: Lens' MetricGoalConfig MetricDefinitionConfig
metricGoalConfig_metricDefinition = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricGoalConfig' {MetricDefinitionConfig
metricDefinition :: MetricDefinitionConfig
$sel:metricDefinition:MetricGoalConfig' :: MetricGoalConfig -> MetricDefinitionConfig
metricDefinition} -> MetricDefinitionConfig
metricDefinition) (\s :: MetricGoalConfig
s@MetricGoalConfig' {} MetricDefinitionConfig
a -> MetricGoalConfig
s {$sel:metricDefinition:MetricGoalConfig' :: MetricDefinitionConfig
metricDefinition = MetricDefinitionConfig
a} :: MetricGoalConfig)

instance Prelude.Hashable MetricGoalConfig where
  hashWithSalt :: Int -> MetricGoalConfig -> Int
hashWithSalt Int
_salt MetricGoalConfig' {Maybe ChangeDirectionEnum
MetricDefinitionConfig
metricDefinition :: MetricDefinitionConfig
desiredChange :: Maybe ChangeDirectionEnum
$sel:metricDefinition:MetricGoalConfig' :: MetricGoalConfig -> MetricDefinitionConfig
$sel:desiredChange:MetricGoalConfig' :: MetricGoalConfig -> Maybe ChangeDirectionEnum
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ChangeDirectionEnum
desiredChange
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` MetricDefinitionConfig
metricDefinition

instance Prelude.NFData MetricGoalConfig where
  rnf :: MetricGoalConfig -> ()
rnf MetricGoalConfig' {Maybe ChangeDirectionEnum
MetricDefinitionConfig
metricDefinition :: MetricDefinitionConfig
desiredChange :: Maybe ChangeDirectionEnum
$sel:metricDefinition:MetricGoalConfig' :: MetricGoalConfig -> MetricDefinitionConfig
$sel:desiredChange:MetricGoalConfig' :: MetricGoalConfig -> Maybe ChangeDirectionEnum
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe ChangeDirectionEnum
desiredChange
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf MetricDefinitionConfig
metricDefinition

instance Data.ToJSON MetricGoalConfig where
  toJSON :: MetricGoalConfig -> Value
toJSON MetricGoalConfig' {Maybe ChangeDirectionEnum
MetricDefinitionConfig
metricDefinition :: MetricDefinitionConfig
desiredChange :: Maybe ChangeDirectionEnum
$sel:metricDefinition:MetricGoalConfig' :: MetricGoalConfig -> MetricDefinitionConfig
$sel:desiredChange:MetricGoalConfig' :: MetricGoalConfig -> Maybe ChangeDirectionEnum
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"desiredChange" 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 ChangeDirectionEnum
desiredChange,
            forall a. a -> Maybe a
Prelude.Just
              (Key
"metricDefinition" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= MetricDefinitionConfig
metricDefinition)
          ]
      )