{-# 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.S3KeyFilter
-- 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.S3KeyFilter 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.FilterRule

-- | A container for object key name prefix and suffix filtering rules.
--
-- /See:/ 'newS3KeyFilter' smart constructor.
data S3KeyFilter = S3KeyFilter'
  { S3KeyFilter -> Maybe [FilterRule]
filterRules :: Prelude.Maybe [FilterRule]
  }
  deriving (S3KeyFilter -> S3KeyFilter -> Bool
(S3KeyFilter -> S3KeyFilter -> Bool)
-> (S3KeyFilter -> S3KeyFilter -> Bool) -> Eq S3KeyFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: S3KeyFilter -> S3KeyFilter -> Bool
$c/= :: S3KeyFilter -> S3KeyFilter -> Bool
== :: S3KeyFilter -> S3KeyFilter -> Bool
$c== :: S3KeyFilter -> S3KeyFilter -> Bool
Prelude.Eq, ReadPrec [S3KeyFilter]
ReadPrec S3KeyFilter
Int -> ReadS S3KeyFilter
ReadS [S3KeyFilter]
(Int -> ReadS S3KeyFilter)
-> ReadS [S3KeyFilter]
-> ReadPrec S3KeyFilter
-> ReadPrec [S3KeyFilter]
-> Read S3KeyFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [S3KeyFilter]
$creadListPrec :: ReadPrec [S3KeyFilter]
readPrec :: ReadPrec S3KeyFilter
$creadPrec :: ReadPrec S3KeyFilter
readList :: ReadS [S3KeyFilter]
$creadList :: ReadS [S3KeyFilter]
readsPrec :: Int -> ReadS S3KeyFilter
$creadsPrec :: Int -> ReadS S3KeyFilter
Prelude.Read, Int -> S3KeyFilter -> ShowS
[S3KeyFilter] -> ShowS
S3KeyFilter -> String
(Int -> S3KeyFilter -> ShowS)
-> (S3KeyFilter -> String)
-> ([S3KeyFilter] -> ShowS)
-> Show S3KeyFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [S3KeyFilter] -> ShowS
$cshowList :: [S3KeyFilter] -> ShowS
show :: S3KeyFilter -> String
$cshow :: S3KeyFilter -> String
showsPrec :: Int -> S3KeyFilter -> ShowS
$cshowsPrec :: Int -> S3KeyFilter -> ShowS
Prelude.Show, (forall x. S3KeyFilter -> Rep S3KeyFilter x)
-> (forall x. Rep S3KeyFilter x -> S3KeyFilter)
-> Generic S3KeyFilter
forall x. Rep S3KeyFilter x -> S3KeyFilter
forall x. S3KeyFilter -> Rep S3KeyFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep S3KeyFilter x -> S3KeyFilter
$cfrom :: forall x. S3KeyFilter -> Rep S3KeyFilter x
Prelude.Generic)

-- |
-- Create a value of 'S3KeyFilter' 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:
--
-- 'filterRules', 's3KeyFilter_filterRules' - Undocumented member.
newS3KeyFilter ::
  S3KeyFilter
newS3KeyFilter :: S3KeyFilter
newS3KeyFilter =
  S3KeyFilter' :: Maybe [FilterRule] -> S3KeyFilter
S3KeyFilter' {$sel:filterRules:S3KeyFilter' :: Maybe [FilterRule]
filterRules = Maybe [FilterRule]
forall a. Maybe a
Prelude.Nothing}

-- | Undocumented member.
s3KeyFilter_filterRules :: Lens.Lens' S3KeyFilter (Prelude.Maybe [FilterRule])
s3KeyFilter_filterRules :: (Maybe [FilterRule] -> f (Maybe [FilterRule]))
-> S3KeyFilter -> f S3KeyFilter
s3KeyFilter_filterRules = (S3KeyFilter -> Maybe [FilterRule])
-> (S3KeyFilter -> Maybe [FilterRule] -> S3KeyFilter)
-> Lens
     S3KeyFilter S3KeyFilter (Maybe [FilterRule]) (Maybe [FilterRule])
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\S3KeyFilter' {Maybe [FilterRule]
filterRules :: Maybe [FilterRule]
$sel:filterRules:S3KeyFilter' :: S3KeyFilter -> Maybe [FilterRule]
filterRules} -> Maybe [FilterRule]
filterRules) (\s :: S3KeyFilter
s@S3KeyFilter' {} Maybe [FilterRule]
a -> S3KeyFilter
s {$sel:filterRules:S3KeyFilter' :: Maybe [FilterRule]
filterRules = Maybe [FilterRule]
a} :: S3KeyFilter) ((Maybe [FilterRule] -> f (Maybe [FilterRule]))
 -> S3KeyFilter -> f S3KeyFilter)
-> ((Maybe [FilterRule] -> f (Maybe [FilterRule]))
    -> Maybe [FilterRule] -> f (Maybe [FilterRule]))
-> (Maybe [FilterRule] -> f (Maybe [FilterRule]))
-> S3KeyFilter
-> f S3KeyFilter
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso [FilterRule] [FilterRule] [FilterRule] [FilterRule]
-> Iso
     (Maybe [FilterRule])
     (Maybe [FilterRule])
     (Maybe [FilterRule])
     (Maybe [FilterRule])
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 [FilterRule] [FilterRule] [FilterRule] [FilterRule]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Core.FromXML S3KeyFilter where
  parseXML :: [Node] -> Either String S3KeyFilter
parseXML [Node]
x =
    Maybe [FilterRule] -> S3KeyFilter
S3KeyFilter'
      (Maybe [FilterRule] -> S3KeyFilter)
-> Either String (Maybe [FilterRule]) -> Either String S3KeyFilter
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (([Node] -> Either String [FilterRule])
-> [Node] -> Either String (Maybe [FilterRule])
forall (f :: * -> *) a b.
Applicative f =>
([a] -> f b) -> [a] -> f (Maybe b)
Core.may (Text -> [Node] -> Either String [FilterRule]
forall a. FromXML a => Text -> [Node] -> Either String [a]
Core.parseXMLList Text
"FilterRule") [Node]
x)

instance Prelude.Hashable S3KeyFilter

instance Prelude.NFData S3KeyFilter

instance Core.ToXML S3KeyFilter where
  toXML :: S3KeyFilter -> XML
toXML S3KeyFilter' {Maybe [FilterRule]
filterRules :: Maybe [FilterRule]
$sel:filterRules:S3KeyFilter' :: S3KeyFilter -> Maybe [FilterRule]
..} =
    [XML] -> XML
forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ Maybe XML -> XML
forall a. ToXML a => a -> XML
Core.toXML
          ( Name -> [FilterRule] -> XML
forall a. (IsList a, ToXML (Item a)) => Name -> a -> XML
Core.toXMLList Name
"FilterRule"
              ([FilterRule] -> XML) -> Maybe [FilterRule] -> Maybe XML
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [FilterRule]
filterRules
          )
      ]