{-# 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.MetricDefinition
-- 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.MetricDefinition 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 is being used to evaluate the
-- variations during a launch or experiment.
--
-- /See:/ 'newMetricDefinition' smart constructor.
data MetricDefinition = MetricDefinition'
  { -- | The entity, such as a user or session, that does an action that causes a
    -- metric value to be recorded.
    MetricDefinition -> Maybe Text
entityIdKey :: Prelude.Maybe Prelude.Text,
    -- | 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>.
    MetricDefinition -> Maybe Text
eventPattern :: Prelude.Maybe Prelude.Text,
    -- | The name of the metric.
    MetricDefinition -> Maybe Text
name :: Prelude.Maybe Prelude.Text,
    -- | The label for the units that the metric is measuring.
    MetricDefinition -> Maybe Text
unitLabel :: Prelude.Maybe Prelude.Text,
    -- | The value that is tracked to produce the metric.
    MetricDefinition -> Maybe Text
valueKey :: Prelude.Maybe Prelude.Text
  }
  deriving (MetricDefinition -> MetricDefinition -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: MetricDefinition -> MetricDefinition -> Bool
$c/= :: MetricDefinition -> MetricDefinition -> Bool
== :: MetricDefinition -> MetricDefinition -> Bool
$c== :: MetricDefinition -> MetricDefinition -> Bool
Prelude.Eq, ReadPrec [MetricDefinition]
ReadPrec MetricDefinition
Int -> ReadS MetricDefinition
ReadS [MetricDefinition]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [MetricDefinition]
$creadListPrec :: ReadPrec [MetricDefinition]
readPrec :: ReadPrec MetricDefinition
$creadPrec :: ReadPrec MetricDefinition
readList :: ReadS [MetricDefinition]
$creadList :: ReadS [MetricDefinition]
readsPrec :: Int -> ReadS MetricDefinition
$creadsPrec :: Int -> ReadS MetricDefinition
Prelude.Read, Int -> MetricDefinition -> ShowS
[MetricDefinition] -> ShowS
MetricDefinition -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [MetricDefinition] -> ShowS
$cshowList :: [MetricDefinition] -> ShowS
show :: MetricDefinition -> String
$cshow :: MetricDefinition -> String
showsPrec :: Int -> MetricDefinition -> ShowS
$cshowsPrec :: Int -> MetricDefinition -> ShowS
Prelude.Show, forall x. Rep MetricDefinition x -> MetricDefinition
forall x. MetricDefinition -> Rep MetricDefinition x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep MetricDefinition x -> MetricDefinition
$cfrom :: forall x. MetricDefinition -> Rep MetricDefinition x
Prelude.Generic)

-- |
-- Create a value of 'MetricDefinition' 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:
--
-- 'entityIdKey', 'metricDefinition_entityIdKey' - The entity, such as a user or session, that does an action that causes a
-- metric value to be recorded.
--
-- 'eventPattern', 'metricDefinition_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>.
--
-- 'name', 'metricDefinition_name' - The name of the metric.
--
-- 'unitLabel', 'metricDefinition_unitLabel' - The label for the units that the metric is measuring.
--
-- 'valueKey', 'metricDefinition_valueKey' - The value that is tracked to produce the metric.
newMetricDefinition ::
  MetricDefinition
newMetricDefinition :: MetricDefinition
newMetricDefinition =
  MetricDefinition'
    { $sel:entityIdKey:MetricDefinition' :: Maybe Text
entityIdKey = forall a. Maybe a
Prelude.Nothing,
      $sel:eventPattern:MetricDefinition' :: Maybe Text
eventPattern = forall a. Maybe a
Prelude.Nothing,
      $sel:name:MetricDefinition' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing,
      $sel:unitLabel:MetricDefinition' :: Maybe Text
unitLabel = forall a. Maybe a
Prelude.Nothing,
      $sel:valueKey:MetricDefinition' :: Maybe Text
valueKey = forall a. Maybe a
Prelude.Nothing
    }

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

-- | 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>.
metricDefinition_eventPattern :: Lens.Lens' MetricDefinition (Prelude.Maybe Prelude.Text)
metricDefinition_eventPattern :: Lens' MetricDefinition (Maybe Text)
metricDefinition_eventPattern = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricDefinition' {Maybe Text
eventPattern :: Maybe Text
$sel:eventPattern:MetricDefinition' :: MetricDefinition -> Maybe Text
eventPattern} -> Maybe Text
eventPattern) (\s :: MetricDefinition
s@MetricDefinition' {} Maybe Text
a -> MetricDefinition
s {$sel:eventPattern:MetricDefinition' :: Maybe Text
eventPattern = Maybe Text
a} :: MetricDefinition)

-- | The name of the metric.
metricDefinition_name :: Lens.Lens' MetricDefinition (Prelude.Maybe Prelude.Text)
metricDefinition_name :: Lens' MetricDefinition (Maybe Text)
metricDefinition_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricDefinition' {Maybe Text
name :: Maybe Text
$sel:name:MetricDefinition' :: MetricDefinition -> Maybe Text
name} -> Maybe Text
name) (\s :: MetricDefinition
s@MetricDefinition' {} Maybe Text
a -> MetricDefinition
s {$sel:name:MetricDefinition' :: Maybe Text
name = Maybe Text
a} :: MetricDefinition)

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

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

instance Data.FromJSON MetricDefinition where
  parseJSON :: Value -> Parser MetricDefinition
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"MetricDefinition"
      ( \Object
x ->
          Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> MetricDefinition
MetricDefinition'
            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
"entityIdKey")
            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
"eventPattern")
            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
"name")
            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
"unitLabel")
            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
"valueKey")
      )

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

instance Prelude.NFData MetricDefinition where
  rnf :: MetricDefinition -> ()
rnf MetricDefinition' {Maybe Text
valueKey :: Maybe Text
unitLabel :: Maybe Text
name :: Maybe Text
eventPattern :: Maybe Text
entityIdKey :: Maybe Text
$sel:valueKey:MetricDefinition' :: MetricDefinition -> Maybe Text
$sel:unitLabel:MetricDefinition' :: MetricDefinition -> Maybe Text
$sel:name:MetricDefinition' :: MetricDefinition -> Maybe Text
$sel:eventPattern:MetricDefinition' :: MetricDefinition -> Maybe Text
$sel:entityIdKey:MetricDefinition' :: MetricDefinition -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
entityIdKey
      seq :: forall a b. a -> b -> b
`Prelude.seq` 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
name
      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 Maybe Text
valueKey