{-# 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.LookoutMetrics.Types.DataQualityMetric
-- 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.LookoutMetrics.Types.DataQualityMetric where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.LookoutMetrics.Types.DataQualityMetricType
import qualified Amazonka.Prelude as Prelude

-- | An array that describes a data quality metric. Each @DataQualityMetric@
-- object contains the data quality metric name, its value, a description
-- of the metric, and the affected column.
--
-- /See:/ 'newDataQualityMetric' smart constructor.
data DataQualityMetric = DataQualityMetric'
  { -- | A description of the data quality metric.
    DataQualityMetric -> Maybe Text
metricDescription :: Prelude.Maybe Prelude.Text,
    -- | The name of the data quality metric.
    DataQualityMetric -> Maybe DataQualityMetricType
metricType :: Prelude.Maybe DataQualityMetricType,
    -- | The value of the data quality metric.
    DataQualityMetric -> Maybe Double
metricValue :: Prelude.Maybe Prelude.Double,
    -- | The column that is being monitored.
    DataQualityMetric -> Maybe Text
relatedColumnName :: Prelude.Maybe Prelude.Text
  }
  deriving (DataQualityMetric -> DataQualityMetric -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DataQualityMetric -> DataQualityMetric -> Bool
$c/= :: DataQualityMetric -> DataQualityMetric -> Bool
== :: DataQualityMetric -> DataQualityMetric -> Bool
$c== :: DataQualityMetric -> DataQualityMetric -> Bool
Prelude.Eq, ReadPrec [DataQualityMetric]
ReadPrec DataQualityMetric
Int -> ReadS DataQualityMetric
ReadS [DataQualityMetric]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DataQualityMetric]
$creadListPrec :: ReadPrec [DataQualityMetric]
readPrec :: ReadPrec DataQualityMetric
$creadPrec :: ReadPrec DataQualityMetric
readList :: ReadS [DataQualityMetric]
$creadList :: ReadS [DataQualityMetric]
readsPrec :: Int -> ReadS DataQualityMetric
$creadsPrec :: Int -> ReadS DataQualityMetric
Prelude.Read, Int -> DataQualityMetric -> ShowS
[DataQualityMetric] -> ShowS
DataQualityMetric -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DataQualityMetric] -> ShowS
$cshowList :: [DataQualityMetric] -> ShowS
show :: DataQualityMetric -> String
$cshow :: DataQualityMetric -> String
showsPrec :: Int -> DataQualityMetric -> ShowS
$cshowsPrec :: Int -> DataQualityMetric -> ShowS
Prelude.Show, forall x. Rep DataQualityMetric x -> DataQualityMetric
forall x. DataQualityMetric -> Rep DataQualityMetric x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DataQualityMetric x -> DataQualityMetric
$cfrom :: forall x. DataQualityMetric -> Rep DataQualityMetric x
Prelude.Generic)

-- |
-- Create a value of 'DataQualityMetric' 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:
--
-- 'metricDescription', 'dataQualityMetric_metricDescription' - A description of the data quality metric.
--
-- 'metricType', 'dataQualityMetric_metricType' - The name of the data quality metric.
--
-- 'metricValue', 'dataQualityMetric_metricValue' - The value of the data quality metric.
--
-- 'relatedColumnName', 'dataQualityMetric_relatedColumnName' - The column that is being monitored.
newDataQualityMetric ::
  DataQualityMetric
newDataQualityMetric :: DataQualityMetric
newDataQualityMetric =
  DataQualityMetric'
    { $sel:metricDescription:DataQualityMetric' :: Maybe Text
metricDescription =
        forall a. Maybe a
Prelude.Nothing,
      $sel:metricType:DataQualityMetric' :: Maybe DataQualityMetricType
metricType = forall a. Maybe a
Prelude.Nothing,
      $sel:metricValue:DataQualityMetric' :: Maybe Double
metricValue = forall a. Maybe a
Prelude.Nothing,
      $sel:relatedColumnName:DataQualityMetric' :: Maybe Text
relatedColumnName = forall a. Maybe a
Prelude.Nothing
    }

-- | A description of the data quality metric.
dataQualityMetric_metricDescription :: Lens.Lens' DataQualityMetric (Prelude.Maybe Prelude.Text)
dataQualityMetric_metricDescription :: Lens' DataQualityMetric (Maybe Text)
dataQualityMetric_metricDescription = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataQualityMetric' {Maybe Text
metricDescription :: Maybe Text
$sel:metricDescription:DataQualityMetric' :: DataQualityMetric -> Maybe Text
metricDescription} -> Maybe Text
metricDescription) (\s :: DataQualityMetric
s@DataQualityMetric' {} Maybe Text
a -> DataQualityMetric
s {$sel:metricDescription:DataQualityMetric' :: Maybe Text
metricDescription = Maybe Text
a} :: DataQualityMetric)

-- | The name of the data quality metric.
dataQualityMetric_metricType :: Lens.Lens' DataQualityMetric (Prelude.Maybe DataQualityMetricType)
dataQualityMetric_metricType :: Lens' DataQualityMetric (Maybe DataQualityMetricType)
dataQualityMetric_metricType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataQualityMetric' {Maybe DataQualityMetricType
metricType :: Maybe DataQualityMetricType
$sel:metricType:DataQualityMetric' :: DataQualityMetric -> Maybe DataQualityMetricType
metricType} -> Maybe DataQualityMetricType
metricType) (\s :: DataQualityMetric
s@DataQualityMetric' {} Maybe DataQualityMetricType
a -> DataQualityMetric
s {$sel:metricType:DataQualityMetric' :: Maybe DataQualityMetricType
metricType = Maybe DataQualityMetricType
a} :: DataQualityMetric)

-- | The value of the data quality metric.
dataQualityMetric_metricValue :: Lens.Lens' DataQualityMetric (Prelude.Maybe Prelude.Double)
dataQualityMetric_metricValue :: Lens' DataQualityMetric (Maybe Double)
dataQualityMetric_metricValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataQualityMetric' {Maybe Double
metricValue :: Maybe Double
$sel:metricValue:DataQualityMetric' :: DataQualityMetric -> Maybe Double
metricValue} -> Maybe Double
metricValue) (\s :: DataQualityMetric
s@DataQualityMetric' {} Maybe Double
a -> DataQualityMetric
s {$sel:metricValue:DataQualityMetric' :: Maybe Double
metricValue = Maybe Double
a} :: DataQualityMetric)

-- | The column that is being monitored.
dataQualityMetric_relatedColumnName :: Lens.Lens' DataQualityMetric (Prelude.Maybe Prelude.Text)
dataQualityMetric_relatedColumnName :: Lens' DataQualityMetric (Maybe Text)
dataQualityMetric_relatedColumnName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataQualityMetric' {Maybe Text
relatedColumnName :: Maybe Text
$sel:relatedColumnName:DataQualityMetric' :: DataQualityMetric -> Maybe Text
relatedColumnName} -> Maybe Text
relatedColumnName) (\s :: DataQualityMetric
s@DataQualityMetric' {} Maybe Text
a -> DataQualityMetric
s {$sel:relatedColumnName:DataQualityMetric' :: Maybe Text
relatedColumnName = Maybe Text
a} :: DataQualityMetric)

instance Data.FromJSON DataQualityMetric where
  parseJSON :: Value -> Parser DataQualityMetric
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DataQualityMetric"
      ( \Object
x ->
          Maybe Text
-> Maybe DataQualityMetricType
-> Maybe Double
-> Maybe Text
-> DataQualityMetric
DataQualityMetric'
            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
"MetricDescription")
            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
"MetricType")
            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
"MetricValue")
            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
"RelatedColumnName")
      )

instance Prelude.Hashable DataQualityMetric where
  hashWithSalt :: Int -> DataQualityMetric -> Int
hashWithSalt Int
_salt DataQualityMetric' {Maybe Double
Maybe Text
Maybe DataQualityMetricType
relatedColumnName :: Maybe Text
metricValue :: Maybe Double
metricType :: Maybe DataQualityMetricType
metricDescription :: Maybe Text
$sel:relatedColumnName:DataQualityMetric' :: DataQualityMetric -> Maybe Text
$sel:metricValue:DataQualityMetric' :: DataQualityMetric -> Maybe Double
$sel:metricType:DataQualityMetric' :: DataQualityMetric -> Maybe DataQualityMetricType
$sel:metricDescription:DataQualityMetric' :: DataQualityMetric -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
metricDescription
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe DataQualityMetricType
metricType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Double
metricValue
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
relatedColumnName

instance Prelude.NFData DataQualityMetric where
  rnf :: DataQualityMetric -> ()
rnf DataQualityMetric' {Maybe Double
Maybe Text
Maybe DataQualityMetricType
relatedColumnName :: Maybe Text
metricValue :: Maybe Double
metricType :: Maybe DataQualityMetricType
metricDescription :: Maybe Text
$sel:relatedColumnName:DataQualityMetric' :: DataQualityMetric -> Maybe Text
$sel:metricValue:DataQualityMetric' :: DataQualityMetric -> Maybe Double
$sel:metricType:DataQualityMetric' :: DataQualityMetric -> Maybe DataQualityMetricType
$sel:metricDescription:DataQualityMetric' :: DataQualityMetric -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
metricDescription
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe DataQualityMetricType
metricType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Double
metricValue
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
relatedColumnName