{-# 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.S3.Types.MetricsFilter
-- 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.S3.Types.MetricsFilter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import Amazonka.S3.Internal
import Amazonka.S3.Types.MetricsAndOperator
import Amazonka.S3.Types.Tag

-- | Specifies a metrics configuration filter. The metrics configuration only
-- includes objects that meet the filter\'s criteria. A filter must be a
-- prefix, an object tag, an access point ARN, or a conjunction
-- (MetricsAndOperator). For more information, see
-- <https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html PutBucketMetricsConfiguration>.
--
-- /See:/ 'newMetricsFilter' smart constructor.
data MetricsFilter = MetricsFilter'
  { -- | The tag used when evaluating a metrics filter.
    MetricsFilter -> Maybe Tag
tag :: Prelude.Maybe Tag,
    -- | The prefix used when evaluating a metrics filter.
    MetricsFilter -> Maybe Text
prefix :: Prelude.Maybe Prelude.Text,
    -- | A conjunction (logical AND) of predicates, which is used in evaluating a
    -- metrics filter. The operator must have at least two predicates, and an
    -- object must match all of the predicates in order for the filter to
    -- apply.
    MetricsFilter -> Maybe MetricsAndOperator
and :: Prelude.Maybe MetricsAndOperator,
    -- | The access point ARN used when evaluating a metrics filter.
    MetricsFilter -> Maybe Text
accessPointArn :: Prelude.Maybe Prelude.Text
  }
  deriving (MetricsFilter -> MetricsFilter -> Bool
(MetricsFilter -> MetricsFilter -> Bool)
-> (MetricsFilter -> MetricsFilter -> Bool) -> Eq MetricsFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: MetricsFilter -> MetricsFilter -> Bool
$c/= :: MetricsFilter -> MetricsFilter -> Bool
== :: MetricsFilter -> MetricsFilter -> Bool
$c== :: MetricsFilter -> MetricsFilter -> Bool
Prelude.Eq, ReadPrec [MetricsFilter]
ReadPrec MetricsFilter
Int -> ReadS MetricsFilter
ReadS [MetricsFilter]
(Int -> ReadS MetricsFilter)
-> ReadS [MetricsFilter]
-> ReadPrec MetricsFilter
-> ReadPrec [MetricsFilter]
-> Read MetricsFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [MetricsFilter]
$creadListPrec :: ReadPrec [MetricsFilter]
readPrec :: ReadPrec MetricsFilter
$creadPrec :: ReadPrec MetricsFilter
readList :: ReadS [MetricsFilter]
$creadList :: ReadS [MetricsFilter]
readsPrec :: Int -> ReadS MetricsFilter
$creadsPrec :: Int -> ReadS MetricsFilter
Prelude.Read, Int -> MetricsFilter -> ShowS
[MetricsFilter] -> ShowS
MetricsFilter -> String
(Int -> MetricsFilter -> ShowS)
-> (MetricsFilter -> String)
-> ([MetricsFilter] -> ShowS)
-> Show MetricsFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [MetricsFilter] -> ShowS
$cshowList :: [MetricsFilter] -> ShowS
show :: MetricsFilter -> String
$cshow :: MetricsFilter -> String
showsPrec :: Int -> MetricsFilter -> ShowS
$cshowsPrec :: Int -> MetricsFilter -> ShowS
Prelude.Show, (forall x. MetricsFilter -> Rep MetricsFilter x)
-> (forall x. Rep MetricsFilter x -> MetricsFilter)
-> Generic MetricsFilter
forall x. Rep MetricsFilter x -> MetricsFilter
forall x. MetricsFilter -> Rep MetricsFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep MetricsFilter x -> MetricsFilter
$cfrom :: forall x. MetricsFilter -> Rep MetricsFilter x
Prelude.Generic)

-- |
-- Create a value of 'MetricsFilter' 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:
--
-- 'tag', 'metricsFilter_tag' - The tag used when evaluating a metrics filter.
--
-- 'prefix', 'metricsFilter_prefix' - The prefix used when evaluating a metrics filter.
--
-- 'and', 'metricsFilter_and' - A conjunction (logical AND) of predicates, which is used in evaluating a
-- metrics filter. The operator must have at least two predicates, and an
-- object must match all of the predicates in order for the filter to
-- apply.
--
-- 'accessPointArn', 'metricsFilter_accessPointArn' - The access point ARN used when evaluating a metrics filter.
newMetricsFilter ::
  MetricsFilter
newMetricsFilter :: MetricsFilter
newMetricsFilter =
  MetricsFilter' :: Maybe Tag
-> Maybe Text
-> Maybe MetricsAndOperator
-> Maybe Text
-> MetricsFilter
MetricsFilter'
    { $sel:tag:MetricsFilter' :: Maybe Tag
tag = Maybe Tag
forall a. Maybe a
Prelude.Nothing,
      $sel:prefix:MetricsFilter' :: Maybe Text
prefix = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:and:MetricsFilter' :: Maybe MetricsAndOperator
and = Maybe MetricsAndOperator
forall a. Maybe a
Prelude.Nothing,
      $sel:accessPointArn:MetricsFilter' :: Maybe Text
accessPointArn = Maybe Text
forall a. Maybe a
Prelude.Nothing
    }

-- | The tag used when evaluating a metrics filter.
metricsFilter_tag :: Lens.Lens' MetricsFilter (Prelude.Maybe Tag)
metricsFilter_tag :: (Maybe Tag -> f (Maybe Tag)) -> MetricsFilter -> f MetricsFilter
metricsFilter_tag = (MetricsFilter -> Maybe Tag)
-> (MetricsFilter -> Maybe Tag -> MetricsFilter)
-> Lens MetricsFilter MetricsFilter (Maybe Tag) (Maybe Tag)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricsFilter' {Maybe Tag
tag :: Maybe Tag
$sel:tag:MetricsFilter' :: MetricsFilter -> Maybe Tag
tag} -> Maybe Tag
tag) (\s :: MetricsFilter
s@MetricsFilter' {} Maybe Tag
a -> MetricsFilter
s {$sel:tag:MetricsFilter' :: Maybe Tag
tag = Maybe Tag
a} :: MetricsFilter)

-- | The prefix used when evaluating a metrics filter.
metricsFilter_prefix :: Lens.Lens' MetricsFilter (Prelude.Maybe Prelude.Text)
metricsFilter_prefix :: (Maybe Text -> f (Maybe Text)) -> MetricsFilter -> f MetricsFilter
metricsFilter_prefix = (MetricsFilter -> Maybe Text)
-> (MetricsFilter -> Maybe Text -> MetricsFilter)
-> Lens MetricsFilter MetricsFilter (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricsFilter' {Maybe Text
prefix :: Maybe Text
$sel:prefix:MetricsFilter' :: MetricsFilter -> Maybe Text
prefix} -> Maybe Text
prefix) (\s :: MetricsFilter
s@MetricsFilter' {} Maybe Text
a -> MetricsFilter
s {$sel:prefix:MetricsFilter' :: Maybe Text
prefix = Maybe Text
a} :: MetricsFilter)

-- | A conjunction (logical AND) of predicates, which is used in evaluating a
-- metrics filter. The operator must have at least two predicates, and an
-- object must match all of the predicates in order for the filter to
-- apply.
metricsFilter_and :: Lens.Lens' MetricsFilter (Prelude.Maybe MetricsAndOperator)
metricsFilter_and :: (Maybe MetricsAndOperator -> f (Maybe MetricsAndOperator))
-> MetricsFilter -> f MetricsFilter
metricsFilter_and = (MetricsFilter -> Maybe MetricsAndOperator)
-> (MetricsFilter -> Maybe MetricsAndOperator -> MetricsFilter)
-> Lens
     MetricsFilter
     MetricsFilter
     (Maybe MetricsAndOperator)
     (Maybe MetricsAndOperator)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricsFilter' {Maybe MetricsAndOperator
and :: Maybe MetricsAndOperator
$sel:and:MetricsFilter' :: MetricsFilter -> Maybe MetricsAndOperator
and} -> Maybe MetricsAndOperator
and) (\s :: MetricsFilter
s@MetricsFilter' {} Maybe MetricsAndOperator
a -> MetricsFilter
s {$sel:and:MetricsFilter' :: Maybe MetricsAndOperator
and = Maybe MetricsAndOperator
a} :: MetricsFilter)

-- | The access point ARN used when evaluating a metrics filter.
metricsFilter_accessPointArn :: Lens.Lens' MetricsFilter (Prelude.Maybe Prelude.Text)
metricsFilter_accessPointArn :: (Maybe Text -> f (Maybe Text)) -> MetricsFilter -> f MetricsFilter
metricsFilter_accessPointArn = (MetricsFilter -> Maybe Text)
-> (MetricsFilter -> Maybe Text -> MetricsFilter)
-> Lens MetricsFilter MetricsFilter (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\MetricsFilter' {Maybe Text
accessPointArn :: Maybe Text
$sel:accessPointArn:MetricsFilter' :: MetricsFilter -> Maybe Text
accessPointArn} -> Maybe Text
accessPointArn) (\s :: MetricsFilter
s@MetricsFilter' {} Maybe Text
a -> MetricsFilter
s {$sel:accessPointArn:MetricsFilter' :: Maybe Text
accessPointArn = Maybe Text
a} :: MetricsFilter)

instance Core.FromXML MetricsFilter where
  parseXML :: [Node] -> Either String MetricsFilter
parseXML [Node]
x =
    Maybe Tag
-> Maybe Text
-> Maybe MetricsAndOperator
-> Maybe Text
-> MetricsFilter
MetricsFilter'
      (Maybe Tag
 -> Maybe Text
 -> Maybe MetricsAndOperator
 -> Maybe Text
 -> MetricsFilter)
-> Either String (Maybe Tag)
-> Either
     String
     (Maybe Text
      -> Maybe MetricsAndOperator -> Maybe Text -> MetricsFilter)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x [Node] -> Text -> Either String (Maybe Tag)
forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Core..@? Text
"Tag")
      Either
  String
  (Maybe Text
   -> Maybe MetricsAndOperator -> Maybe Text -> MetricsFilter)
-> Either String (Maybe Text)
-> Either
     String (Maybe MetricsAndOperator -> Maybe Text -> MetricsFilter)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x [Node] -> Text -> Either String (Maybe Text)
forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Core..@? Text
"Prefix")
      Either
  String (Maybe MetricsAndOperator -> Maybe Text -> MetricsFilter)
-> Either String (Maybe MetricsAndOperator)
-> Either String (Maybe Text -> MetricsFilter)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x [Node] -> Text -> Either String (Maybe MetricsAndOperator)
forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Core..@? Text
"And")
      Either String (Maybe Text -> MetricsFilter)
-> Either String (Maybe Text) -> Either String MetricsFilter
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x [Node] -> Text -> Either String (Maybe Text)
forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Core..@? Text
"AccessPointArn")

instance Prelude.Hashable MetricsFilter

instance Prelude.NFData MetricsFilter

instance Core.ToXML MetricsFilter where
  toXML :: MetricsFilter -> XML
toXML MetricsFilter' {Maybe Text
Maybe Tag
Maybe MetricsAndOperator
accessPointArn :: Maybe Text
and :: Maybe MetricsAndOperator
prefix :: Maybe Text
tag :: Maybe Tag
$sel:accessPointArn:MetricsFilter' :: MetricsFilter -> Maybe Text
$sel:and:MetricsFilter' :: MetricsFilter -> Maybe MetricsAndOperator
$sel:prefix:MetricsFilter' :: MetricsFilter -> Maybe Text
$sel:tag:MetricsFilter' :: MetricsFilter -> Maybe Tag
..} =
    [XML] -> XML
forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ Name
"Tag" Name -> Maybe Tag -> XML
forall a. ToXML a => Name -> a -> XML
Core.@= Maybe Tag
tag,
        Name
"Prefix" Name -> Maybe Text -> XML
forall a. ToXML a => Name -> a -> XML
Core.@= Maybe Text
prefix,
        Name
"And" Name -> Maybe MetricsAndOperator -> XML
forall a. ToXML a => Name -> a -> XML
Core.@= Maybe MetricsAndOperator
and,
        Name
"AccessPointArn" Name -> Maybe Text -> XML
forall a. ToXML a => Name -> a -> XML
Core.@= Maybe Text
accessPointArn
      ]