{-# 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-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- 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.Lens as Lens
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,
    -- | The name of the log group.
    MetricFilter -> Maybe Text
logGroupName :: Prelude.Maybe Prelude.Text,
    MetricFilter -> Maybe Text
filterPattern :: Prelude.Maybe Prelude.Text,
    -- | The metric transformations.
    MetricFilter -> Maybe (NonEmpty MetricTransformation)
metricTransformations :: Prelude.Maybe (Prelude.NonEmpty MetricTransformation)
  }
  deriving (MetricFilter -> MetricFilter -> Bool
(MetricFilter -> MetricFilter -> Bool)
-> (MetricFilter -> MetricFilter -> Bool) -> Eq MetricFilter
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]
(Int -> ReadS MetricFilter)
-> ReadS [MetricFilter]
-> ReadPrec MetricFilter
-> ReadPrec [MetricFilter]
-> Read 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
(Int -> MetricFilter -> ShowS)
-> (MetricFilter -> String)
-> ([MetricFilter] -> ShowS)
-> Show MetricFilter
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. MetricFilter -> Rep MetricFilter x)
-> (forall x. Rep MetricFilter x -> MetricFilter)
-> Generic MetricFilter
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.
--
-- 'logGroupName', 'metricFilter_logGroupName' - The name of the log group.
--
-- 'filterPattern', 'metricFilter_filterPattern' - Undocumented member.
--
-- 'metricTransformations', 'metricFilter_metricTransformations' - The metric transformations.
newMetricFilter ::
  MetricFilter
newMetricFilter :: MetricFilter
newMetricFilter =
  MetricFilter' :: Maybe Natural
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe (NonEmpty MetricTransformation)
-> MetricFilter
MetricFilter'
    { $sel:creationTime:MetricFilter' :: Maybe Natural
creationTime = Maybe Natural
forall a. Maybe a
Prelude.Nothing,
      $sel:filterName:MetricFilter' :: Maybe Text
filterName = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:logGroupName:MetricFilter' :: Maybe Text
logGroupName = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:filterPattern:MetricFilter' :: Maybe Text
filterPattern = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:metricTransformations:MetricFilter' :: Maybe (NonEmpty MetricTransformation)
metricTransformations = Maybe (NonEmpty MetricTransformation)
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 :: (Maybe Natural -> f (Maybe Natural))
-> MetricFilter -> f MetricFilter
metricFilter_creationTime = (MetricFilter -> Maybe Natural)
-> (MetricFilter -> Maybe Natural -> MetricFilter)
-> Lens MetricFilter MetricFilter (Maybe Natural) (Maybe Natural)
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 :: (Maybe Text -> f (Maybe Text)) -> MetricFilter -> f MetricFilter
metricFilter_filterName = (MetricFilter -> Maybe Text)
-> (MetricFilter -> Maybe Text -> MetricFilter)
-> Lens MetricFilter MetricFilter (Maybe Text) (Maybe Text)
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)

-- | The name of the log group.
metricFilter_logGroupName :: Lens.Lens' MetricFilter (Prelude.Maybe Prelude.Text)
metricFilter_logGroupName :: (Maybe Text -> f (Maybe Text)) -> MetricFilter -> f MetricFilter
metricFilter_logGroupName = (MetricFilter -> Maybe Text)
-> (MetricFilter -> Maybe Text -> MetricFilter)
-> Lens MetricFilter MetricFilter (Maybe Text) (Maybe Text)
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)

-- | Undocumented member.
metricFilter_filterPattern :: Lens.Lens' MetricFilter (Prelude.Maybe Prelude.Text)
metricFilter_filterPattern :: (Maybe Text -> f (Maybe Text)) -> MetricFilter -> f MetricFilter
metricFilter_filterPattern = (MetricFilter -> Maybe Text)
-> (MetricFilter -> Maybe Text -> MetricFilter)
-> Lens MetricFilter MetricFilter (Maybe Text) (Maybe Text)
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 metric transformations.
metricFilter_metricTransformations :: Lens.Lens' MetricFilter (Prelude.Maybe (Prelude.NonEmpty MetricTransformation))
metricFilter_metricTransformations :: (Maybe (NonEmpty MetricTransformation)
 -> f (Maybe (NonEmpty MetricTransformation)))
-> MetricFilter -> f MetricFilter
metricFilter_metricTransformations = (MetricFilter -> Maybe (NonEmpty MetricTransformation))
-> (MetricFilter
    -> Maybe (NonEmpty MetricTransformation) -> MetricFilter)
-> Lens
     MetricFilter
     MetricFilter
     (Maybe (NonEmpty MetricTransformation))
     (Maybe (NonEmpty MetricTransformation))
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) ((Maybe (NonEmpty MetricTransformation)
  -> f (Maybe (NonEmpty MetricTransformation)))
 -> MetricFilter -> f MetricFilter)
-> ((Maybe (NonEmpty MetricTransformation)
     -> f (Maybe (NonEmpty MetricTransformation)))
    -> Maybe (NonEmpty MetricTransformation)
    -> f (Maybe (NonEmpty MetricTransformation)))
-> (Maybe (NonEmpty MetricTransformation)
    -> f (Maybe (NonEmpty MetricTransformation)))
-> MetricFilter
-> f MetricFilter
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso
  (NonEmpty MetricTransformation)
  (NonEmpty MetricTransformation)
  (NonEmpty MetricTransformation)
  (NonEmpty MetricTransformation)
-> Iso
     (Maybe (NonEmpty MetricTransformation))
     (Maybe (NonEmpty MetricTransformation))
     (Maybe (NonEmpty MetricTransformation))
     (Maybe (NonEmpty MetricTransformation))
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 AnIso
  (NonEmpty MetricTransformation)
  (NonEmpty MetricTransformation)
  (NonEmpty MetricTransformation)
  (NonEmpty MetricTransformation)
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Core.FromJSON MetricFilter where
  parseJSON :: Value -> Parser MetricFilter
parseJSON =
    String
-> (Object -> Parser MetricFilter) -> Value -> Parser MetricFilter
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"MetricFilter"
      ( \Object
x ->
          Maybe Natural
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe (NonEmpty MetricTransformation)
-> MetricFilter
MetricFilter'
            (Maybe Natural
 -> Maybe Text
 -> Maybe Text
 -> Maybe Text
 -> Maybe (NonEmpty MetricTransformation)
 -> MetricFilter)
-> Parser (Maybe Natural)
-> Parser
     (Maybe Text
      -> Maybe Text
      -> Maybe Text
      -> Maybe (NonEmpty MetricTransformation)
      -> MetricFilter)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser (Maybe Natural)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"creationTime")
            Parser
  (Maybe Text
   -> Maybe Text
   -> Maybe Text
   -> Maybe (NonEmpty MetricTransformation)
   -> MetricFilter)
-> Parser (Maybe Text)
-> Parser
     (Maybe Text
      -> Maybe Text
      -> Maybe (NonEmpty MetricTransformation)
      -> MetricFilter)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Text)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"filterName")
            Parser
  (Maybe Text
   -> Maybe Text
   -> Maybe (NonEmpty MetricTransformation)
   -> MetricFilter)
-> Parser (Maybe Text)
-> Parser
     (Maybe Text
      -> Maybe (NonEmpty MetricTransformation) -> MetricFilter)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Text)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"logGroupName")
            Parser
  (Maybe Text
   -> Maybe (NonEmpty MetricTransformation) -> MetricFilter)
-> Parser (Maybe Text)
-> Parser (Maybe (NonEmpty MetricTransformation) -> MetricFilter)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Text)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"filterPattern")
            Parser (Maybe (NonEmpty MetricTransformation) -> MetricFilter)
-> Parser (Maybe (NonEmpty MetricTransformation))
-> Parser MetricFilter
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe (NonEmpty MetricTransformation))
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"metricTransformations")
      )

instance Prelude.Hashable MetricFilter

instance Prelude.NFData MetricFilter