{-# 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.MetricDefinitionConfig
-- 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.MetricDefinitionConfig 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

-- | This structure defines a metric that you want to use to evaluate the
-- variations during a launch or experiment.
--
-- /See:/ 'newMetricDefinitionConfig' smart constructor.
data MetricDefinitionConfig = MetricDefinitionConfig'
  { -- | The EventBridge event pattern that defines how the metric is recorded.
    --
    -- For more information about EventBridge event patterns, see
    -- <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html Amazon EventBridge event patterns>.
    MetricDefinitionConfig -> Maybe Text
eventPattern :: Prelude.Maybe Prelude.Text,
    -- | A label for the units that the metric is measuring.
    MetricDefinitionConfig -> Maybe Text
unitLabel :: Prelude.Maybe Prelude.Text,
    -- | The entity, such as a user or session, that does an action that causes a
    -- metric value to be recorded. An example is @userDetails.userID@.
    MetricDefinitionConfig -> Text
entityIdKey :: Prelude.Text,
    -- | A name for the metric.
    MetricDefinitionConfig -> Text
name :: Prelude.Text,
    -- | The value that is tracked to produce the metric.
    MetricDefinitionConfig -> Text
valueKey :: Prelude.Text
  }
  deriving (MetricDefinitionConfig -> MetricDefinitionConfig -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: MetricDefinitionConfig -> MetricDefinitionConfig -> Bool
$c/= :: MetricDefinitionConfig -> MetricDefinitionConfig -> Bool
== :: MetricDefinitionConfig -> MetricDefinitionConfig -> Bool
$c== :: MetricDefinitionConfig -> MetricDefinitionConfig -> Bool
Prelude.Eq, ReadPrec [MetricDefinitionConfig]
ReadPrec MetricDefinitionConfig
Int -> ReadS MetricDefinitionConfig
ReadS [MetricDefinitionConfig]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [MetricDefinitionConfig]
$creadListPrec :: ReadPrec [MetricDefinitionConfig]
readPrec :: ReadPrec MetricDefinitionConfig
$creadPrec :: ReadPrec MetricDefinitionConfig
readList :: ReadS [MetricDefinitionConfig]
$creadList :: ReadS [MetricDefinitionConfig]
readsPrec :: Int -> ReadS MetricDefinitionConfig
$creadsPrec :: Int -> ReadS MetricDefinitionConfig
Prelude.Read, Int -> MetricDefinitionConfig -> ShowS
[MetricDefinitionConfig] -> ShowS
MetricDefinitionConfig -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [MetricDefinitionConfig] -> ShowS
$cshowList :: [MetricDefinitionConfig] -> ShowS
show :: MetricDefinitionConfig -> String
$cshow :: MetricDefinitionConfig -> String
showsPrec :: Int -> MetricDefinitionConfig -> ShowS
$cshowsPrec :: Int -> MetricDefinitionConfig -> ShowS
Prelude.Show, forall x. Rep MetricDefinitionConfig x -> MetricDefinitionConfig
forall x. MetricDefinitionConfig -> Rep MetricDefinitionConfig x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep MetricDefinitionConfig x -> MetricDefinitionConfig
$cfrom :: forall x. MetricDefinitionConfig -> Rep MetricDefinitionConfig x
Prelude.Generic)

-- |
-- Create a value of 'MetricDefinitionConfig' 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:
--
-- 'eventPattern', 'metricDefinitionConfig_eventPattern' - The EventBridge event pattern that defines how the metric is recorded.
--
-- For more information about EventBridge event patterns, see
-- <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html Amazon EventBridge event patterns>.
--
-- 'unitLabel', 'metricDefinitionConfig_unitLabel' - A label for the units that the metric is measuring.
--
-- 'entityIdKey', 'metricDefinitionConfig_entityIdKey' - The entity, such as a user or session, that does an action that causes a
-- metric value to be recorded. An example is @userDetails.userID@.
--
-- 'name', 'metricDefinitionConfig_name' - A name for the metric.
--
-- 'valueKey', 'metricDefinitionConfig_valueKey' - The value that is tracked to produce the metric.
newMetricDefinitionConfig ::
  -- | 'entityIdKey'
  Prelude.Text ->
  -- | 'name'
  Prelude.Text ->
  -- | 'valueKey'
  Prelude.Text ->
  MetricDefinitionConfig
newMetricDefinitionConfig :: Text -> Text -> Text -> MetricDefinitionConfig
newMetricDefinitionConfig
  Text
pEntityIdKey_
  Text
pName_
  Text
pValueKey_ =
    MetricDefinitionConfig'
      { $sel:eventPattern:MetricDefinitionConfig' :: Maybe Text
eventPattern =
          forall a. Maybe a
Prelude.Nothing,
        $sel:unitLabel:MetricDefinitionConfig' :: Maybe Text
unitLabel = forall a. Maybe a
Prelude.Nothing,
        $sel:entityIdKey:MetricDefinitionConfig' :: Text
entityIdKey = Text
pEntityIdKey_,
        $sel:name:MetricDefinitionConfig' :: Text
name = Text
pName_,
        $sel:valueKey:MetricDefinitionConfig' :: Text
valueKey = Text
pValueKey_
      }

-- | The EventBridge event pattern that defines how the metric is recorded.
--
-- For more information about EventBridge event patterns, see
-- <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html Amazon EventBridge event patterns>.
metricDefinitionConfig_eventPattern :: Lens.Lens' MetricDefinitionConfig (Prelude.Maybe Prelude.Text)
metricDefinitionConfig_eventPattern :: Lens' MetricDefinitionConfig (Maybe Text)
metricDefinitionConfig_eventPattern = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricDefinitionConfig' {Maybe Text
eventPattern :: Maybe Text
$sel:eventPattern:MetricDefinitionConfig' :: MetricDefinitionConfig -> Maybe Text
eventPattern} -> Maybe Text
eventPattern) (\s :: MetricDefinitionConfig
s@MetricDefinitionConfig' {} Maybe Text
a -> MetricDefinitionConfig
s {$sel:eventPattern:MetricDefinitionConfig' :: Maybe Text
eventPattern = Maybe Text
a} :: MetricDefinitionConfig)

-- | A label for the units that the metric is measuring.
metricDefinitionConfig_unitLabel :: Lens.Lens' MetricDefinitionConfig (Prelude.Maybe Prelude.Text)
metricDefinitionConfig_unitLabel :: Lens' MetricDefinitionConfig (Maybe Text)
metricDefinitionConfig_unitLabel = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricDefinitionConfig' {Maybe Text
unitLabel :: Maybe Text
$sel:unitLabel:MetricDefinitionConfig' :: MetricDefinitionConfig -> Maybe Text
unitLabel} -> Maybe Text
unitLabel) (\s :: MetricDefinitionConfig
s@MetricDefinitionConfig' {} Maybe Text
a -> MetricDefinitionConfig
s {$sel:unitLabel:MetricDefinitionConfig' :: Maybe Text
unitLabel = Maybe Text
a} :: MetricDefinitionConfig)

-- | The entity, such as a user or session, that does an action that causes a
-- metric value to be recorded. An example is @userDetails.userID@.
metricDefinitionConfig_entityIdKey :: Lens.Lens' MetricDefinitionConfig Prelude.Text
metricDefinitionConfig_entityIdKey :: Lens' MetricDefinitionConfig Text
metricDefinitionConfig_entityIdKey = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricDefinitionConfig' {Text
entityIdKey :: Text
$sel:entityIdKey:MetricDefinitionConfig' :: MetricDefinitionConfig -> Text
entityIdKey} -> Text
entityIdKey) (\s :: MetricDefinitionConfig
s@MetricDefinitionConfig' {} Text
a -> MetricDefinitionConfig
s {$sel:entityIdKey:MetricDefinitionConfig' :: Text
entityIdKey = Text
a} :: MetricDefinitionConfig)

-- | A name for the metric.
metricDefinitionConfig_name :: Lens.Lens' MetricDefinitionConfig Prelude.Text
metricDefinitionConfig_name :: Lens' MetricDefinitionConfig Text
metricDefinitionConfig_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricDefinitionConfig' {Text
name :: Text
$sel:name:MetricDefinitionConfig' :: MetricDefinitionConfig -> Text
name} -> Text
name) (\s :: MetricDefinitionConfig
s@MetricDefinitionConfig' {} Text
a -> MetricDefinitionConfig
s {$sel:name:MetricDefinitionConfig' :: Text
name = Text
a} :: MetricDefinitionConfig)

-- | The value that is tracked to produce the metric.
metricDefinitionConfig_valueKey :: Lens.Lens' MetricDefinitionConfig Prelude.Text
metricDefinitionConfig_valueKey :: Lens' MetricDefinitionConfig Text
metricDefinitionConfig_valueKey = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricDefinitionConfig' {Text
valueKey :: Text
$sel:valueKey:MetricDefinitionConfig' :: MetricDefinitionConfig -> Text
valueKey} -> Text
valueKey) (\s :: MetricDefinitionConfig
s@MetricDefinitionConfig' {} Text
a -> MetricDefinitionConfig
s {$sel:valueKey:MetricDefinitionConfig' :: Text
valueKey = Text
a} :: MetricDefinitionConfig)

instance Prelude.Hashable MetricDefinitionConfig where
  hashWithSalt :: Int -> MetricDefinitionConfig -> Int
hashWithSalt Int
_salt MetricDefinitionConfig' {Maybe Text
Text
valueKey :: Text
name :: Text
entityIdKey :: Text
unitLabel :: Maybe Text
eventPattern :: Maybe Text
$sel:valueKey:MetricDefinitionConfig' :: MetricDefinitionConfig -> Text
$sel:name:MetricDefinitionConfig' :: MetricDefinitionConfig -> Text
$sel:entityIdKey:MetricDefinitionConfig' :: MetricDefinitionConfig -> Text
$sel:unitLabel:MetricDefinitionConfig' :: MetricDefinitionConfig -> Maybe Text
$sel:eventPattern:MetricDefinitionConfig' :: MetricDefinitionConfig -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
eventPattern
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
unitLabel
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
entityIdKey
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
valueKey

instance Prelude.NFData MetricDefinitionConfig where
  rnf :: MetricDefinitionConfig -> ()
rnf MetricDefinitionConfig' {Maybe Text
Text
valueKey :: Text
name :: Text
entityIdKey :: Text
unitLabel :: Maybe Text
eventPattern :: Maybe Text
$sel:valueKey:MetricDefinitionConfig' :: MetricDefinitionConfig -> Text
$sel:name:MetricDefinitionConfig' :: MetricDefinitionConfig -> Text
$sel:entityIdKey:MetricDefinitionConfig' :: MetricDefinitionConfig -> Text
$sel:unitLabel:MetricDefinitionConfig' :: MetricDefinitionConfig -> Maybe Text
$sel:eventPattern:MetricDefinitionConfig' :: MetricDefinitionConfig -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
eventPattern
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
unitLabel
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
entityIdKey
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
valueKey

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