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

-- | The @Filter@ is used to identify objects that a Lifecycle Rule applies
-- to. A @Filter@ must have exactly one of @Prefix@, @Tag@, or @And@
-- specified.
--
-- /See:/ 'newLifecycleRuleFilter' smart constructor.
data LifecycleRuleFilter = LifecycleRuleFilter'
  { -- | This tag must exist in the object\'s tag set in order for the rule to
    -- apply.
    LifecycleRuleFilter -> Maybe Tag
tag :: Prelude.Maybe Tag,
    -- | Prefix identifying one or more 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>.
    LifecycleRuleFilter -> Maybe Text
prefix :: Prelude.Maybe Prelude.Text,
    LifecycleRuleFilter -> Maybe LifecycleRuleAndOperator
and :: Prelude.Maybe LifecycleRuleAndOperator
  }
  deriving (LifecycleRuleFilter -> LifecycleRuleFilter -> Bool
(LifecycleRuleFilter -> LifecycleRuleFilter -> Bool)
-> (LifecycleRuleFilter -> LifecycleRuleFilter -> Bool)
-> Eq LifecycleRuleFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: LifecycleRuleFilter -> LifecycleRuleFilter -> Bool
$c/= :: LifecycleRuleFilter -> LifecycleRuleFilter -> Bool
== :: LifecycleRuleFilter -> LifecycleRuleFilter -> Bool
$c== :: LifecycleRuleFilter -> LifecycleRuleFilter -> Bool
Prelude.Eq, ReadPrec [LifecycleRuleFilter]
ReadPrec LifecycleRuleFilter
Int -> ReadS LifecycleRuleFilter
ReadS [LifecycleRuleFilter]
(Int -> ReadS LifecycleRuleFilter)
-> ReadS [LifecycleRuleFilter]
-> ReadPrec LifecycleRuleFilter
-> ReadPrec [LifecycleRuleFilter]
-> Read LifecycleRuleFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [LifecycleRuleFilter]
$creadListPrec :: ReadPrec [LifecycleRuleFilter]
readPrec :: ReadPrec LifecycleRuleFilter
$creadPrec :: ReadPrec LifecycleRuleFilter
readList :: ReadS [LifecycleRuleFilter]
$creadList :: ReadS [LifecycleRuleFilter]
readsPrec :: Int -> ReadS LifecycleRuleFilter
$creadsPrec :: Int -> ReadS LifecycleRuleFilter
Prelude.Read, Int -> LifecycleRuleFilter -> ShowS
[LifecycleRuleFilter] -> ShowS
LifecycleRuleFilter -> String
(Int -> LifecycleRuleFilter -> ShowS)
-> (LifecycleRuleFilter -> String)
-> ([LifecycleRuleFilter] -> ShowS)
-> Show LifecycleRuleFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [LifecycleRuleFilter] -> ShowS
$cshowList :: [LifecycleRuleFilter] -> ShowS
show :: LifecycleRuleFilter -> String
$cshow :: LifecycleRuleFilter -> String
showsPrec :: Int -> LifecycleRuleFilter -> ShowS
$cshowsPrec :: Int -> LifecycleRuleFilter -> ShowS
Prelude.Show, (forall x. LifecycleRuleFilter -> Rep LifecycleRuleFilter x)
-> (forall x. Rep LifecycleRuleFilter x -> LifecycleRuleFilter)
-> Generic LifecycleRuleFilter
forall x. Rep LifecycleRuleFilter x -> LifecycleRuleFilter
forall x. LifecycleRuleFilter -> Rep LifecycleRuleFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep LifecycleRuleFilter x -> LifecycleRuleFilter
$cfrom :: forall x. LifecycleRuleFilter -> Rep LifecycleRuleFilter x
Prelude.Generic)

-- |
-- Create a value of 'LifecycleRuleFilter' 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', 'lifecycleRuleFilter_tag' - This tag must exist in the object\'s tag set in order for the rule to
-- apply.
--
-- 'prefix', 'lifecycleRuleFilter_prefix' - Prefix identifying one or more 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', 'lifecycleRuleFilter_and' - Undocumented member.
newLifecycleRuleFilter ::
  LifecycleRuleFilter
newLifecycleRuleFilter :: LifecycleRuleFilter
newLifecycleRuleFilter =
  LifecycleRuleFilter' :: Maybe Tag
-> Maybe Text
-> Maybe LifecycleRuleAndOperator
-> LifecycleRuleFilter
LifecycleRuleFilter'
    { $sel:tag:LifecycleRuleFilter' :: Maybe Tag
tag = Maybe Tag
forall a. Maybe a
Prelude.Nothing,
      $sel:prefix:LifecycleRuleFilter' :: Maybe Text
prefix = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:and:LifecycleRuleFilter' :: Maybe LifecycleRuleAndOperator
and = Maybe LifecycleRuleAndOperator
forall a. Maybe a
Prelude.Nothing
    }

-- | This tag must exist in the object\'s tag set in order for the rule to
-- apply.
lifecycleRuleFilter_tag :: Lens.Lens' LifecycleRuleFilter (Prelude.Maybe Tag)
lifecycleRuleFilter_tag :: (Maybe Tag -> f (Maybe Tag))
-> LifecycleRuleFilter -> f LifecycleRuleFilter
lifecycleRuleFilter_tag = (LifecycleRuleFilter -> Maybe Tag)
-> (LifecycleRuleFilter -> Maybe Tag -> LifecycleRuleFilter)
-> Lens
     LifecycleRuleFilter LifecycleRuleFilter (Maybe Tag) (Maybe Tag)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\LifecycleRuleFilter' {Maybe Tag
tag :: Maybe Tag
$sel:tag:LifecycleRuleFilter' :: LifecycleRuleFilter -> Maybe Tag
tag} -> Maybe Tag
tag) (\s :: LifecycleRuleFilter
s@LifecycleRuleFilter' {} Maybe Tag
a -> LifecycleRuleFilter
s {$sel:tag:LifecycleRuleFilter' :: Maybe Tag
tag = Maybe Tag
a} :: LifecycleRuleFilter)

-- | Prefix identifying one or more 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>.
lifecycleRuleFilter_prefix :: Lens.Lens' LifecycleRuleFilter (Prelude.Maybe Prelude.Text)
lifecycleRuleFilter_prefix :: (Maybe Text -> f (Maybe Text))
-> LifecycleRuleFilter -> f LifecycleRuleFilter
lifecycleRuleFilter_prefix = (LifecycleRuleFilter -> Maybe Text)
-> (LifecycleRuleFilter -> Maybe Text -> LifecycleRuleFilter)
-> Lens
     LifecycleRuleFilter LifecycleRuleFilter (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\LifecycleRuleFilter' {Maybe Text
prefix :: Maybe Text
$sel:prefix:LifecycleRuleFilter' :: LifecycleRuleFilter -> Maybe Text
prefix} -> Maybe Text
prefix) (\s :: LifecycleRuleFilter
s@LifecycleRuleFilter' {} Maybe Text
a -> LifecycleRuleFilter
s {$sel:prefix:LifecycleRuleFilter' :: Maybe Text
prefix = Maybe Text
a} :: LifecycleRuleFilter)

-- | Undocumented member.
lifecycleRuleFilter_and :: Lens.Lens' LifecycleRuleFilter (Prelude.Maybe LifecycleRuleAndOperator)
lifecycleRuleFilter_and :: (Maybe LifecycleRuleAndOperator
 -> f (Maybe LifecycleRuleAndOperator))
-> LifecycleRuleFilter -> f LifecycleRuleFilter
lifecycleRuleFilter_and = (LifecycleRuleFilter -> Maybe LifecycleRuleAndOperator)
-> (LifecycleRuleFilter
    -> Maybe LifecycleRuleAndOperator -> LifecycleRuleFilter)
-> Lens
     LifecycleRuleFilter
     LifecycleRuleFilter
     (Maybe LifecycleRuleAndOperator)
     (Maybe LifecycleRuleAndOperator)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\LifecycleRuleFilter' {Maybe LifecycleRuleAndOperator
and :: Maybe LifecycleRuleAndOperator
$sel:and:LifecycleRuleFilter' :: LifecycleRuleFilter -> Maybe LifecycleRuleAndOperator
and} -> Maybe LifecycleRuleAndOperator
and) (\s :: LifecycleRuleFilter
s@LifecycleRuleFilter' {} Maybe LifecycleRuleAndOperator
a -> LifecycleRuleFilter
s {$sel:and:LifecycleRuleFilter' :: Maybe LifecycleRuleAndOperator
and = Maybe LifecycleRuleAndOperator
a} :: LifecycleRuleFilter)

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

instance Prelude.Hashable LifecycleRuleFilter

instance Prelude.NFData LifecycleRuleFilter

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