{-# 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.QuickSight.Types.MetricComparisonComputation
-- 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.QuickSight.Types.MetricComparisonComputation 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
import Amazonka.QuickSight.Types.DimensionField
import Amazonka.QuickSight.Types.MeasureField

-- | The metric comparison computation configuration.
--
-- /See:/ 'newMetricComparisonComputation' smart constructor.
data MetricComparisonComputation = MetricComparisonComputation'
  { -- | The name of a computation.
    MetricComparisonComputation -> Maybe Text
name :: Prelude.Maybe Prelude.Text,
    -- | The ID for a computation.
    MetricComparisonComputation -> Text
computationId :: Prelude.Text,
    -- | The time field that is used in a computation.
    MetricComparisonComputation -> DimensionField
time :: DimensionField,
    -- | The field that is used in a metric comparison from value setup.
    MetricComparisonComputation -> MeasureField
fromValue :: MeasureField,
    -- | The field that is used in a metric comparison to value setup.
    MetricComparisonComputation -> MeasureField
targetValue :: MeasureField
  }
  deriving (MetricComparisonComputation -> MetricComparisonComputation -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: MetricComparisonComputation -> MetricComparisonComputation -> Bool
$c/= :: MetricComparisonComputation -> MetricComparisonComputation -> Bool
== :: MetricComparisonComputation -> MetricComparisonComputation -> Bool
$c== :: MetricComparisonComputation -> MetricComparisonComputation -> Bool
Prelude.Eq, Int -> MetricComparisonComputation -> ShowS
[MetricComparisonComputation] -> ShowS
MetricComparisonComputation -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [MetricComparisonComputation] -> ShowS
$cshowList :: [MetricComparisonComputation] -> ShowS
show :: MetricComparisonComputation -> String
$cshow :: MetricComparisonComputation -> String
showsPrec :: Int -> MetricComparisonComputation -> ShowS
$cshowsPrec :: Int -> MetricComparisonComputation -> ShowS
Prelude.Show, forall x.
Rep MetricComparisonComputation x -> MetricComparisonComputation
forall x.
MetricComparisonComputation -> Rep MetricComparisonComputation x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep MetricComparisonComputation x -> MetricComparisonComputation
$cfrom :: forall x.
MetricComparisonComputation -> Rep MetricComparisonComputation x
Prelude.Generic)

-- |
-- Create a value of 'MetricComparisonComputation' 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:
--
-- 'name', 'metricComparisonComputation_name' - The name of a computation.
--
-- 'computationId', 'metricComparisonComputation_computationId' - The ID for a computation.
--
-- 'time', 'metricComparisonComputation_time' - The time field that is used in a computation.
--
-- 'fromValue', 'metricComparisonComputation_fromValue' - The field that is used in a metric comparison from value setup.
--
-- 'targetValue', 'metricComparisonComputation_targetValue' - The field that is used in a metric comparison to value setup.
newMetricComparisonComputation ::
  -- | 'computationId'
  Prelude.Text ->
  -- | 'time'
  DimensionField ->
  -- | 'fromValue'
  MeasureField ->
  -- | 'targetValue'
  MeasureField ->
  MetricComparisonComputation
newMetricComparisonComputation :: Text
-> DimensionField
-> MeasureField
-> MeasureField
-> MetricComparisonComputation
newMetricComparisonComputation
  Text
pComputationId_
  DimensionField
pTime_
  MeasureField
pFromValue_
  MeasureField
pTargetValue_ =
    MetricComparisonComputation'
      { $sel:name:MetricComparisonComputation' :: Maybe Text
name =
          forall a. Maybe a
Prelude.Nothing,
        $sel:computationId:MetricComparisonComputation' :: Text
computationId = Text
pComputationId_,
        $sel:time:MetricComparisonComputation' :: DimensionField
time = DimensionField
pTime_,
        $sel:fromValue:MetricComparisonComputation' :: MeasureField
fromValue = MeasureField
pFromValue_,
        $sel:targetValue:MetricComparisonComputation' :: MeasureField
targetValue = MeasureField
pTargetValue_
      }

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

-- | The ID for a computation.
metricComparisonComputation_computationId :: Lens.Lens' MetricComparisonComputation Prelude.Text
metricComparisonComputation_computationId :: Lens' MetricComparisonComputation Text
metricComparisonComputation_computationId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricComparisonComputation' {Text
computationId :: Text
$sel:computationId:MetricComparisonComputation' :: MetricComparisonComputation -> Text
computationId} -> Text
computationId) (\s :: MetricComparisonComputation
s@MetricComparisonComputation' {} Text
a -> MetricComparisonComputation
s {$sel:computationId:MetricComparisonComputation' :: Text
computationId = Text
a} :: MetricComparisonComputation)

-- | The time field that is used in a computation.
metricComparisonComputation_time :: Lens.Lens' MetricComparisonComputation DimensionField
metricComparisonComputation_time :: Lens' MetricComparisonComputation DimensionField
metricComparisonComputation_time = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricComparisonComputation' {DimensionField
time :: DimensionField
$sel:time:MetricComparisonComputation' :: MetricComparisonComputation -> DimensionField
time} -> DimensionField
time) (\s :: MetricComparisonComputation
s@MetricComparisonComputation' {} DimensionField
a -> MetricComparisonComputation
s {$sel:time:MetricComparisonComputation' :: DimensionField
time = DimensionField
a} :: MetricComparisonComputation)

-- | The field that is used in a metric comparison from value setup.
metricComparisonComputation_fromValue :: Lens.Lens' MetricComparisonComputation MeasureField
metricComparisonComputation_fromValue :: Lens' MetricComparisonComputation MeasureField
metricComparisonComputation_fromValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricComparisonComputation' {MeasureField
fromValue :: MeasureField
$sel:fromValue:MetricComparisonComputation' :: MetricComparisonComputation -> MeasureField
fromValue} -> MeasureField
fromValue) (\s :: MetricComparisonComputation
s@MetricComparisonComputation' {} MeasureField
a -> MetricComparisonComputation
s {$sel:fromValue:MetricComparisonComputation' :: MeasureField
fromValue = MeasureField
a} :: MetricComparisonComputation)

-- | The field that is used in a metric comparison to value setup.
metricComparisonComputation_targetValue :: Lens.Lens' MetricComparisonComputation MeasureField
metricComparisonComputation_targetValue :: Lens' MetricComparisonComputation MeasureField
metricComparisonComputation_targetValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricComparisonComputation' {MeasureField
targetValue :: MeasureField
$sel:targetValue:MetricComparisonComputation' :: MetricComparisonComputation -> MeasureField
targetValue} -> MeasureField
targetValue) (\s :: MetricComparisonComputation
s@MetricComparisonComputation' {} MeasureField
a -> MetricComparisonComputation
s {$sel:targetValue:MetricComparisonComputation' :: MeasureField
targetValue = MeasureField
a} :: MetricComparisonComputation)

instance Data.FromJSON MetricComparisonComputation where
  parseJSON :: Value -> Parser MetricComparisonComputation
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"MetricComparisonComputation"
      ( \Object
x ->
          Maybe Text
-> Text
-> DimensionField
-> MeasureField
-> MeasureField
-> MetricComparisonComputation
MetricComparisonComputation'
            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
"Name")
            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
"ComputationId")
            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
"Time")
            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
"FromValue")
            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
"TargetValue")
      )

instance Prelude.Hashable MetricComparisonComputation where
  hashWithSalt :: Int -> MetricComparisonComputation -> Int
hashWithSalt Int
_salt MetricComparisonComputation' {Maybe Text
Text
MeasureField
DimensionField
targetValue :: MeasureField
fromValue :: MeasureField
time :: DimensionField
computationId :: Text
name :: Maybe Text
$sel:targetValue:MetricComparisonComputation' :: MetricComparisonComputation -> MeasureField
$sel:fromValue:MetricComparisonComputation' :: MetricComparisonComputation -> MeasureField
$sel:time:MetricComparisonComputation' :: MetricComparisonComputation -> DimensionField
$sel:computationId:MetricComparisonComputation' :: MetricComparisonComputation -> Text
$sel:name:MetricComparisonComputation' :: MetricComparisonComputation -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
computationId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` DimensionField
time
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` MeasureField
fromValue
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` MeasureField
targetValue

instance Prelude.NFData MetricComparisonComputation where
  rnf :: MetricComparisonComputation -> ()
rnf MetricComparisonComputation' {Maybe Text
Text
MeasureField
DimensionField
targetValue :: MeasureField
fromValue :: MeasureField
time :: DimensionField
computationId :: Text
name :: Maybe Text
$sel:targetValue:MetricComparisonComputation' :: MetricComparisonComputation -> MeasureField
$sel:fromValue:MetricComparisonComputation' :: MetricComparisonComputation -> MeasureField
$sel:time:MetricComparisonComputation' :: MetricComparisonComputation -> DimensionField
$sel:computationId:MetricComparisonComputation' :: MetricComparisonComputation -> Text
$sel:name:MetricComparisonComputation' :: MetricComparisonComputation -> Maybe Text
..} =
    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 Text
computationId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf DimensionField
time
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf MeasureField
fromValue
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf MeasureField
targetValue

instance Data.ToJSON MetricComparisonComputation where
  toJSON :: MetricComparisonComputation -> Value
toJSON MetricComparisonComputation' {Maybe Text
Text
MeasureField
DimensionField
targetValue :: MeasureField
fromValue :: MeasureField
time :: DimensionField
computationId :: Text
name :: Maybe Text
$sel:targetValue:MetricComparisonComputation' :: MetricComparisonComputation -> MeasureField
$sel:fromValue:MetricComparisonComputation' :: MetricComparisonComputation -> MeasureField
$sel:time:MetricComparisonComputation' :: MetricComparisonComputation -> DimensionField
$sel:computationId:MetricComparisonComputation' :: MetricComparisonComputation -> Text
$sel:name:MetricComparisonComputation' :: MetricComparisonComputation -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Name" 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
name,
            forall a. a -> Maybe a
Prelude.Just (Key
"ComputationId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
computationId),
            forall a. a -> Maybe a
Prelude.Just (Key
"Time" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= DimensionField
time),
            forall a. a -> Maybe a
Prelude.Just (Key
"FromValue" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= MeasureField
fromValue),
            forall a. a -> Maybe a
Prelude.Just (Key
"TargetValue" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= MeasureField
targetValue)
          ]
      )