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

-- | The @Filter@ is used to identify objects that the S3 Intelligent-Tiering
-- configuration applies to.
--
-- /See:/ 'newIntelligentTieringFilter' smart constructor.
data IntelligentTieringFilter = IntelligentTieringFilter'
  { IntelligentTieringFilter -> Maybe Tag
tag :: Prelude.Maybe Tag,
    -- | An object key name prefix that identifies the subset of objects to which
    -- the rule applies.
    --
    -- Replacement must be made for object keys containing special characters
    -- (such as carriage returns) when using XML requests. For more
    -- information, see
    -- <https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints XML related object key constraints>.
    IntelligentTieringFilter -> 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.
    IntelligentTieringFilter -> Maybe IntelligentTieringAndOperator
and :: Prelude.Maybe IntelligentTieringAndOperator
  }
  deriving (IntelligentTieringFilter -> IntelligentTieringFilter -> Bool
(IntelligentTieringFilter -> IntelligentTieringFilter -> Bool)
-> (IntelligentTieringFilter -> IntelligentTieringFilter -> Bool)
-> Eq IntelligentTieringFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: IntelligentTieringFilter -> IntelligentTieringFilter -> Bool
$c/= :: IntelligentTieringFilter -> IntelligentTieringFilter -> Bool
== :: IntelligentTieringFilter -> IntelligentTieringFilter -> Bool
$c== :: IntelligentTieringFilter -> IntelligentTieringFilter -> Bool
Prelude.Eq, ReadPrec [IntelligentTieringFilter]
ReadPrec IntelligentTieringFilter
Int -> ReadS IntelligentTieringFilter
ReadS [IntelligentTieringFilter]
(Int -> ReadS IntelligentTieringFilter)
-> ReadS [IntelligentTieringFilter]
-> ReadPrec IntelligentTieringFilter
-> ReadPrec [IntelligentTieringFilter]
-> Read IntelligentTieringFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [IntelligentTieringFilter]
$creadListPrec :: ReadPrec [IntelligentTieringFilter]
readPrec :: ReadPrec IntelligentTieringFilter
$creadPrec :: ReadPrec IntelligentTieringFilter
readList :: ReadS [IntelligentTieringFilter]
$creadList :: ReadS [IntelligentTieringFilter]
readsPrec :: Int -> ReadS IntelligentTieringFilter
$creadsPrec :: Int -> ReadS IntelligentTieringFilter
Prelude.Read, Int -> IntelligentTieringFilter -> ShowS
[IntelligentTieringFilter] -> ShowS
IntelligentTieringFilter -> String
(Int -> IntelligentTieringFilter -> ShowS)
-> (IntelligentTieringFilter -> String)
-> ([IntelligentTieringFilter] -> ShowS)
-> Show IntelligentTieringFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [IntelligentTieringFilter] -> ShowS
$cshowList :: [IntelligentTieringFilter] -> ShowS
show :: IntelligentTieringFilter -> String
$cshow :: IntelligentTieringFilter -> String
showsPrec :: Int -> IntelligentTieringFilter -> ShowS
$cshowsPrec :: Int -> IntelligentTieringFilter -> ShowS
Prelude.Show, (forall x.
 IntelligentTieringFilter -> Rep IntelligentTieringFilter x)
-> (forall x.
    Rep IntelligentTieringFilter x -> IntelligentTieringFilter)
-> Generic IntelligentTieringFilter
forall x.
Rep IntelligentTieringFilter x -> IntelligentTieringFilter
forall x.
IntelligentTieringFilter -> Rep IntelligentTieringFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep IntelligentTieringFilter x -> IntelligentTieringFilter
$cfrom :: forall x.
IntelligentTieringFilter -> Rep IntelligentTieringFilter x
Prelude.Generic)

-- |
-- Create a value of 'IntelligentTieringFilter' 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', 'intelligentTieringFilter_tag' - Undocumented member.
--
-- 'prefix', 'intelligentTieringFilter_prefix' - An object key name prefix that identifies the subset of objects to which
-- the rule applies.
--
-- Replacement must be made for object keys containing special characters
-- (such as carriage returns) when using XML requests. For more
-- information, see
-- <https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints XML related object key constraints>.
--
-- 'and', 'intelligentTieringFilter_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.
newIntelligentTieringFilter ::
  IntelligentTieringFilter
newIntelligentTieringFilter :: IntelligentTieringFilter
newIntelligentTieringFilter =
  IntelligentTieringFilter' :: Maybe Tag
-> Maybe Text
-> Maybe IntelligentTieringAndOperator
-> IntelligentTieringFilter
IntelligentTieringFilter'
    { $sel:tag:IntelligentTieringFilter' :: Maybe Tag
tag = Maybe Tag
forall a. Maybe a
Prelude.Nothing,
      $sel:prefix:IntelligentTieringFilter' :: Maybe Text
prefix = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:and:IntelligentTieringFilter' :: Maybe IntelligentTieringAndOperator
and = Maybe IntelligentTieringAndOperator
forall a. Maybe a
Prelude.Nothing
    }

-- | Undocumented member.
intelligentTieringFilter_tag :: Lens.Lens' IntelligentTieringFilter (Prelude.Maybe Tag)
intelligentTieringFilter_tag :: (Maybe Tag -> f (Maybe Tag))
-> IntelligentTieringFilter -> f IntelligentTieringFilter
intelligentTieringFilter_tag = (IntelligentTieringFilter -> Maybe Tag)
-> (IntelligentTieringFilter
    -> Maybe Tag -> IntelligentTieringFilter)
-> Lens
     IntelligentTieringFilter
     IntelligentTieringFilter
     (Maybe Tag)
     (Maybe Tag)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\IntelligentTieringFilter' {Maybe Tag
tag :: Maybe Tag
$sel:tag:IntelligentTieringFilter' :: IntelligentTieringFilter -> Maybe Tag
tag} -> Maybe Tag
tag) (\s :: IntelligentTieringFilter
s@IntelligentTieringFilter' {} Maybe Tag
a -> IntelligentTieringFilter
s {$sel:tag:IntelligentTieringFilter' :: Maybe Tag
tag = Maybe Tag
a} :: IntelligentTieringFilter)

-- | An object key name prefix that identifies the subset of objects to which
-- the rule applies.
--
-- Replacement must be made for object keys containing special characters
-- (such as carriage returns) when using XML requests. For more
-- information, see
-- <https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints XML related object key constraints>.
intelligentTieringFilter_prefix :: Lens.Lens' IntelligentTieringFilter (Prelude.Maybe Prelude.Text)
intelligentTieringFilter_prefix :: (Maybe Text -> f (Maybe Text))
-> IntelligentTieringFilter -> f IntelligentTieringFilter
intelligentTieringFilter_prefix = (IntelligentTieringFilter -> Maybe Text)
-> (IntelligentTieringFilter
    -> Maybe Text -> IntelligentTieringFilter)
-> Lens
     IntelligentTieringFilter
     IntelligentTieringFilter
     (Maybe Text)
     (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\IntelligentTieringFilter' {Maybe Text
prefix :: Maybe Text
$sel:prefix:IntelligentTieringFilter' :: IntelligentTieringFilter -> Maybe Text
prefix} -> Maybe Text
prefix) (\s :: IntelligentTieringFilter
s@IntelligentTieringFilter' {} Maybe Text
a -> IntelligentTieringFilter
s {$sel:prefix:IntelligentTieringFilter' :: Maybe Text
prefix = Maybe Text
a} :: IntelligentTieringFilter)

-- | 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.
intelligentTieringFilter_and :: Lens.Lens' IntelligentTieringFilter (Prelude.Maybe IntelligentTieringAndOperator)
intelligentTieringFilter_and :: (Maybe IntelligentTieringAndOperator
 -> f (Maybe IntelligentTieringAndOperator))
-> IntelligentTieringFilter -> f IntelligentTieringFilter
intelligentTieringFilter_and = (IntelligentTieringFilter -> Maybe IntelligentTieringAndOperator)
-> (IntelligentTieringFilter
    -> Maybe IntelligentTieringAndOperator -> IntelligentTieringFilter)
-> Lens
     IntelligentTieringFilter
     IntelligentTieringFilter
     (Maybe IntelligentTieringAndOperator)
     (Maybe IntelligentTieringAndOperator)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\IntelligentTieringFilter' {Maybe IntelligentTieringAndOperator
and :: Maybe IntelligentTieringAndOperator
$sel:and:IntelligentTieringFilter' :: IntelligentTieringFilter -> Maybe IntelligentTieringAndOperator
and} -> Maybe IntelligentTieringAndOperator
and) (\s :: IntelligentTieringFilter
s@IntelligentTieringFilter' {} Maybe IntelligentTieringAndOperator
a -> IntelligentTieringFilter
s {$sel:and:IntelligentTieringFilter' :: Maybe IntelligentTieringAndOperator
and = Maybe IntelligentTieringAndOperator
a} :: IntelligentTieringFilter)

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

instance Prelude.Hashable IntelligentTieringFilter

instance Prelude.NFData IntelligentTieringFilter

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