{-# 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.CloudWatchLogs.Types.MetricFilter
-- 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.CloudWatchLogs.Types.MetricFilter where

import Amazonka.CloudWatchLogs.Types.MetricTransformation
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

-- | Metric filters express how CloudWatch Logs would extract metric
-- observations from ingested log events and transform them into metric
-- data in a CloudWatch metric.
--
-- /See:/ 'newMetricFilter' smart constructor.
data MetricFilter = MetricFilter'
  { -- | The creation time of the metric filter, expressed as the number of
    -- milliseconds after @Jan 1, 1970 00:00:00 UTC@.
    MetricFilter -> Maybe Natural
creationTime :: Prelude.Maybe Prelude.Natural,
    -- | The name of the metric filter.
    MetricFilter -> Maybe Text
filterName :: Prelude.Maybe Prelude.Text,
    MetricFilter -> Maybe Text
filterPattern :: Prelude.Maybe Prelude.Text,
    -- | The name of the log group.
    MetricFilter -> Maybe Text
logGroupName :: Prelude.Maybe Prelude.Text,
    -- | The metric transformations.
    MetricFilter -> Maybe (NonEmpty MetricTransformation)
metricTransformations :: Prelude.Maybe (Prelude.NonEmpty MetricTransformation)
  }
  deriving (MetricFilter -> MetricFilter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: MetricFilter -> MetricFilter -> Bool
$c/= :: MetricFilter -> MetricFilter -> Bool
== :: MetricFilter -> MetricFilter -> Bool
$c== :: MetricFilter -> MetricFilter -> Bool
Prelude.Eq, ReadPrec [MetricFilter]
ReadPrec MetricFilter
Int -> ReadS MetricFilter
ReadS [MetricFilter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [MetricFilter]
$creadListPrec :: ReadPrec [MetricFilter]
readPrec :: ReadPrec MetricFilter
$creadPrec :: ReadPrec MetricFilter
readList :: ReadS [MetricFilter]
$creadList :: ReadS [MetricFilter]
readsPrec :: Int -> ReadS MetricFilter
$creadsPrec :: Int -> ReadS MetricFilter
Prelude.Read, Int -> MetricFilter -> ShowS
[MetricFilter] -> ShowS
MetricFilter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [MetricFilter] -> ShowS
$cshowList :: [MetricFilter] -> ShowS
show :: MetricFilter -> String
$cshow :: MetricFilter -> String
showsPrec :: Int -> MetricFilter -> ShowS
$cshowsPrec :: Int -> MetricFilter -> ShowS
Prelude.Show, forall x. Rep MetricFilter x -> MetricFilter
forall x. MetricFilter -> Rep MetricFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep MetricFilter x -> MetricFilter
$cfrom :: forall x. MetricFilter -> Rep MetricFilter x
Prelude.Generic)

-- |
-- Create a value of 'MetricFilter' 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:
--
-- 'creationTime', 'metricFilter_creationTime' - The creation time of the metric filter, expressed as the number of
-- milliseconds after @Jan 1, 1970 00:00:00 UTC@.
--
-- 'filterName', 'metricFilter_filterName' - The name of the metric filter.
--
-- 'filterPattern', 'metricFilter_filterPattern' - Undocumented member.
--
-- 'logGroupName', 'metricFilter_logGroupName' - The name of the log group.
--
-- 'metricTransformations', 'metricFilter_metricTransformations' - The metric transformations.
newMetricFilter ::
  MetricFilter
newMetricFilter :: MetricFilter
newMetricFilter =
  MetricFilter'
    { $sel:creationTime:MetricFilter' :: Maybe Natural
creationTime = forall a. Maybe a
Prelude.Nothing,
      $sel:filterName:MetricFilter' :: Maybe Text
filterName = forall a. Maybe a
Prelude.Nothing,
      $sel:filterPattern:MetricFilter' :: Maybe Text
filterPattern = forall a. Maybe a
Prelude.Nothing,
      $sel:logGroupName:MetricFilter' :: Maybe Text
logGroupName = forall a. Maybe a
Prelude.Nothing,
      $sel:metricTransformations:MetricFilter' :: Maybe (NonEmpty MetricTransformation)
metricTransformations = forall a. Maybe a
Prelude.Nothing
    }

-- | The creation time of the metric filter, expressed as the number of
-- milliseconds after @Jan 1, 1970 00:00:00 UTC@.
metricFilter_creationTime :: Lens.Lens' MetricFilter (Prelude.Maybe Prelude.Natural)
metricFilter_creationTime :: Lens' MetricFilter (Maybe Natural)
metricFilter_creationTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricFilter' {Maybe Natural
creationTime :: Maybe Natural
$sel:creationTime:MetricFilter' :: MetricFilter -> Maybe Natural
creationTime} -> Maybe Natural
creationTime) (\s :: MetricFilter
s@MetricFilter' {} Maybe Natural
a -> MetricFilter
s {$sel:creationTime:MetricFilter' :: Maybe Natural
creationTime = Maybe Natural
a} :: MetricFilter)

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

-- | Undocumented member.
metricFilter_filterPattern :: Lens.Lens' MetricFilter (Prelude.Maybe Prelude.Text)
metricFilter_filterPattern :: Lens' MetricFilter (Maybe Text)
metricFilter_filterPattern = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricFilter' {Maybe Text
filterPattern :: Maybe Text
$sel:filterPattern:MetricFilter' :: MetricFilter -> Maybe Text
filterPattern} -> Maybe Text
filterPattern) (\s :: MetricFilter
s@MetricFilter' {} Maybe Text
a -> MetricFilter
s {$sel:filterPattern:MetricFilter' :: Maybe Text
filterPattern = Maybe Text
a} :: MetricFilter)

-- | The name of the log group.
metricFilter_logGroupName :: Lens.Lens' MetricFilter (Prelude.Maybe Prelude.Text)
metricFilter_logGroupName :: Lens' MetricFilter (Maybe Text)
metricFilter_logGroupName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricFilter' {Maybe Text
logGroupName :: Maybe Text
$sel:logGroupName:MetricFilter' :: MetricFilter -> Maybe Text
logGroupName} -> Maybe Text
logGroupName) (\s :: MetricFilter
s@MetricFilter' {} Maybe Text
a -> MetricFilter
s {$sel:logGroupName:MetricFilter' :: Maybe Text
logGroupName = Maybe Text
a} :: MetricFilter)

-- | The metric transformations.
metricFilter_metricTransformations :: Lens.Lens' MetricFilter (Prelude.Maybe (Prelude.NonEmpty MetricTransformation))
metricFilter_metricTransformations :: Lens' MetricFilter (Maybe (NonEmpty MetricTransformation))
metricFilter_metricTransformations = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricFilter' {Maybe (NonEmpty MetricTransformation)
metricTransformations :: Maybe (NonEmpty MetricTransformation)
$sel:metricTransformations:MetricFilter' :: MetricFilter -> Maybe (NonEmpty MetricTransformation)
metricTransformations} -> Maybe (NonEmpty MetricTransformation)
metricTransformations) (\s :: MetricFilter
s@MetricFilter' {} Maybe (NonEmpty MetricTransformation)
a -> MetricFilter
s {$sel:metricTransformations:MetricFilter' :: Maybe (NonEmpty MetricTransformation)
metricTransformations = Maybe (NonEmpty MetricTransformation)
a} :: MetricFilter) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Data.FromJSON MetricFilter where
  parseJSON :: Value -> Parser MetricFilter
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"MetricFilter"
      ( \Object
x ->
          Maybe Natural
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe (NonEmpty MetricTransformation)
-> MetricFilter
MetricFilter'
            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
"creationTime")
            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
"filterName")
            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
"filterPattern")
            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
"logGroupName")
            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
"metricTransformations")
      )

instance Prelude.Hashable MetricFilter where
  hashWithSalt :: Int -> MetricFilter -> Int
hashWithSalt Int
_salt MetricFilter' {Maybe Natural
Maybe (NonEmpty MetricTransformation)
Maybe Text
metricTransformations :: Maybe (NonEmpty MetricTransformation)
logGroupName :: Maybe Text
filterPattern :: Maybe Text
filterName :: Maybe Text
creationTime :: Maybe Natural
$sel:metricTransformations:MetricFilter' :: MetricFilter -> Maybe (NonEmpty MetricTransformation)
$sel:logGroupName:MetricFilter' :: MetricFilter -> Maybe Text
$sel:filterPattern:MetricFilter' :: MetricFilter -> Maybe Text
$sel:filterName:MetricFilter' :: MetricFilter -> Maybe Text
$sel:creationTime:MetricFilter' :: MetricFilter -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
creationTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
filterName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
filterPattern
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
logGroupName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty MetricTransformation)
metricTransformations

instance Prelude.NFData MetricFilter where
  rnf :: MetricFilter -> ()
rnf MetricFilter' {Maybe Natural
Maybe (NonEmpty MetricTransformation)
Maybe Text
metricTransformations :: Maybe (NonEmpty MetricTransformation)
logGroupName :: Maybe Text
filterPattern :: Maybe Text
filterName :: Maybe Text
creationTime :: Maybe Natural
$sel:metricTransformations:MetricFilter' :: MetricFilter -> Maybe (NonEmpty MetricTransformation)
$sel:logGroupName:MetricFilter' :: MetricFilter -> Maybe Text
$sel:filterPattern:MetricFilter' :: MetricFilter -> Maybe Text
$sel:filterName:MetricFilter' :: MetricFilter -> Maybe Text
$sel:creationTime:MetricFilter' :: MetricFilter -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
creationTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
filterName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
filterPattern
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
logGroupName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty MetricTransformation)
metricTransformations