{-# 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.AnalyticsFilter
-- 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.AnalyticsFilter 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.AnalyticsAndOperator
import Amazonka.S3.Types.Tag

-- | The filter used to describe a set of objects for analyses. A filter must
-- have exactly one prefix, one tag, or one conjunction
-- (AnalyticsAndOperator). If no filter is provided, all objects will be
-- considered in any analysis.
--
-- /See:/ 'newAnalyticsFilter' smart constructor.
data AnalyticsFilter = AnalyticsFilter'
  { -- | The tag to use when evaluating an analytics filter.
    AnalyticsFilter -> Maybe Tag
tag :: Prelude.Maybe Tag,
    -- | The prefix to use when evaluating an analytics filter.
    AnalyticsFilter -> Maybe Text
prefix :: Prelude.Maybe Prelude.Text,
    -- | A conjunction (logical AND) of predicates, which is used in evaluating
    -- an analytics filter. The operator must have at least two predicates.
    AnalyticsFilter -> Maybe AnalyticsAndOperator
and :: Prelude.Maybe AnalyticsAndOperator
  }
  deriving (AnalyticsFilter -> AnalyticsFilter -> Bool
(AnalyticsFilter -> AnalyticsFilter -> Bool)
-> (AnalyticsFilter -> AnalyticsFilter -> Bool)
-> Eq AnalyticsFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AnalyticsFilter -> AnalyticsFilter -> Bool
$c/= :: AnalyticsFilter -> AnalyticsFilter -> Bool
== :: AnalyticsFilter -> AnalyticsFilter -> Bool
$c== :: AnalyticsFilter -> AnalyticsFilter -> Bool
Prelude.Eq, ReadPrec [AnalyticsFilter]
ReadPrec AnalyticsFilter
Int -> ReadS AnalyticsFilter
ReadS [AnalyticsFilter]
(Int -> ReadS AnalyticsFilter)
-> ReadS [AnalyticsFilter]
-> ReadPrec AnalyticsFilter
-> ReadPrec [AnalyticsFilter]
-> Read AnalyticsFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AnalyticsFilter]
$creadListPrec :: ReadPrec [AnalyticsFilter]
readPrec :: ReadPrec AnalyticsFilter
$creadPrec :: ReadPrec AnalyticsFilter
readList :: ReadS [AnalyticsFilter]
$creadList :: ReadS [AnalyticsFilter]
readsPrec :: Int -> ReadS AnalyticsFilter
$creadsPrec :: Int -> ReadS AnalyticsFilter
Prelude.Read, Int -> AnalyticsFilter -> ShowS
[AnalyticsFilter] -> ShowS
AnalyticsFilter -> String
(Int -> AnalyticsFilter -> ShowS)
-> (AnalyticsFilter -> String)
-> ([AnalyticsFilter] -> ShowS)
-> Show AnalyticsFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AnalyticsFilter] -> ShowS
$cshowList :: [AnalyticsFilter] -> ShowS
show :: AnalyticsFilter -> String
$cshow :: AnalyticsFilter -> String
showsPrec :: Int -> AnalyticsFilter -> ShowS
$cshowsPrec :: Int -> AnalyticsFilter -> ShowS
Prelude.Show, (forall x. AnalyticsFilter -> Rep AnalyticsFilter x)
-> (forall x. Rep AnalyticsFilter x -> AnalyticsFilter)
-> Generic AnalyticsFilter
forall x. Rep AnalyticsFilter x -> AnalyticsFilter
forall x. AnalyticsFilter -> Rep AnalyticsFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep AnalyticsFilter x -> AnalyticsFilter
$cfrom :: forall x. AnalyticsFilter -> Rep AnalyticsFilter x
Prelude.Generic)

-- |
-- Create a value of 'AnalyticsFilter' 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', 'analyticsFilter_tag' - The tag to use when evaluating an analytics filter.
--
-- 'prefix', 'analyticsFilter_prefix' - The prefix to use when evaluating an analytics filter.
--
-- 'and', 'analyticsFilter_and' - A conjunction (logical AND) of predicates, which is used in evaluating
-- an analytics filter. The operator must have at least two predicates.
newAnalyticsFilter ::
  AnalyticsFilter
newAnalyticsFilter :: AnalyticsFilter
newAnalyticsFilter =
  AnalyticsFilter' :: Maybe Tag
-> Maybe Text -> Maybe AnalyticsAndOperator -> AnalyticsFilter
AnalyticsFilter'
    { $sel:tag:AnalyticsFilter' :: Maybe Tag
tag = Maybe Tag
forall a. Maybe a
Prelude.Nothing,
      $sel:prefix:AnalyticsFilter' :: Maybe Text
prefix = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:and:AnalyticsFilter' :: Maybe AnalyticsAndOperator
and = Maybe AnalyticsAndOperator
forall a. Maybe a
Prelude.Nothing
    }

-- | The tag to use when evaluating an analytics filter.
analyticsFilter_tag :: Lens.Lens' AnalyticsFilter (Prelude.Maybe Tag)
analyticsFilter_tag :: (Maybe Tag -> f (Maybe Tag))
-> AnalyticsFilter -> f AnalyticsFilter
analyticsFilter_tag = (AnalyticsFilter -> Maybe Tag)
-> (AnalyticsFilter -> Maybe Tag -> AnalyticsFilter)
-> Lens AnalyticsFilter AnalyticsFilter (Maybe Tag) (Maybe Tag)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AnalyticsFilter' {Maybe Tag
tag :: Maybe Tag
$sel:tag:AnalyticsFilter' :: AnalyticsFilter -> Maybe Tag
tag} -> Maybe Tag
tag) (\s :: AnalyticsFilter
s@AnalyticsFilter' {} Maybe Tag
a -> AnalyticsFilter
s {$sel:tag:AnalyticsFilter' :: Maybe Tag
tag = Maybe Tag
a} :: AnalyticsFilter)

-- | The prefix to use when evaluating an analytics filter.
analyticsFilter_prefix :: Lens.Lens' AnalyticsFilter (Prelude.Maybe Prelude.Text)
analyticsFilter_prefix :: (Maybe Text -> f (Maybe Text))
-> AnalyticsFilter -> f AnalyticsFilter
analyticsFilter_prefix = (AnalyticsFilter -> Maybe Text)
-> (AnalyticsFilter -> Maybe Text -> AnalyticsFilter)
-> Lens AnalyticsFilter AnalyticsFilter (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AnalyticsFilter' {Maybe Text
prefix :: Maybe Text
$sel:prefix:AnalyticsFilter' :: AnalyticsFilter -> Maybe Text
prefix} -> Maybe Text
prefix) (\s :: AnalyticsFilter
s@AnalyticsFilter' {} Maybe Text
a -> AnalyticsFilter
s {$sel:prefix:AnalyticsFilter' :: Maybe Text
prefix = Maybe Text
a} :: AnalyticsFilter)

-- | A conjunction (logical AND) of predicates, which is used in evaluating
-- an analytics filter. The operator must have at least two predicates.
analyticsFilter_and :: Lens.Lens' AnalyticsFilter (Prelude.Maybe AnalyticsAndOperator)
analyticsFilter_and :: (Maybe AnalyticsAndOperator -> f (Maybe AnalyticsAndOperator))
-> AnalyticsFilter -> f AnalyticsFilter
analyticsFilter_and = (AnalyticsFilter -> Maybe AnalyticsAndOperator)
-> (AnalyticsFilter
    -> Maybe AnalyticsAndOperator -> AnalyticsFilter)
-> Lens
     AnalyticsFilter
     AnalyticsFilter
     (Maybe AnalyticsAndOperator)
     (Maybe AnalyticsAndOperator)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AnalyticsFilter' {Maybe AnalyticsAndOperator
and :: Maybe AnalyticsAndOperator
$sel:and:AnalyticsFilter' :: AnalyticsFilter -> Maybe AnalyticsAndOperator
and} -> Maybe AnalyticsAndOperator
and) (\s :: AnalyticsFilter
s@AnalyticsFilter' {} Maybe AnalyticsAndOperator
a -> AnalyticsFilter
s {$sel:and:AnalyticsFilter' :: Maybe AnalyticsAndOperator
and = Maybe AnalyticsAndOperator
a} :: AnalyticsFilter)

instance Core.FromXML AnalyticsFilter where
  parseXML :: [Node] -> Either String AnalyticsFilter
parseXML [Node]
x =
    Maybe Tag
-> Maybe Text -> Maybe AnalyticsAndOperator -> AnalyticsFilter
AnalyticsFilter'
      (Maybe Tag
 -> Maybe Text -> Maybe AnalyticsAndOperator -> AnalyticsFilter)
-> Either String (Maybe Tag)
-> Either
     String
     (Maybe Text -> Maybe AnalyticsAndOperator -> AnalyticsFilter)
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 AnalyticsAndOperator -> AnalyticsFilter)
-> Either String (Maybe Text)
-> Either String (Maybe AnalyticsAndOperator -> AnalyticsFilter)
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 AnalyticsAndOperator -> AnalyticsFilter)
-> Either String (Maybe AnalyticsAndOperator)
-> Either String AnalyticsFilter
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x [Node] -> Text -> Either String (Maybe AnalyticsAndOperator)
forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Core..@? Text
"And")

instance Prelude.Hashable AnalyticsFilter

instance Prelude.NFData AnalyticsFilter

instance Core.ToXML AnalyticsFilter where
  toXML :: AnalyticsFilter -> XML
toXML AnalyticsFilter' {Maybe Text
Maybe Tag
Maybe AnalyticsAndOperator
and :: Maybe AnalyticsAndOperator
prefix :: Maybe Text
tag :: Maybe Tag
$sel:and:AnalyticsFilter' :: AnalyticsFilter -> Maybe AnalyticsAndOperator
$sel:prefix:AnalyticsFilter' :: AnalyticsFilter -> Maybe Text
$sel:tag:AnalyticsFilter' :: AnalyticsFilter -> 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 AnalyticsAndOperator -> XML
forall a. ToXML a => Name -> a -> XML
Core.@= Maybe AnalyticsAndOperator
and
      ]