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

-- | Specifies the Amazon S3 object key name to filter on and whether to
-- filter on the suffix or prefix of the key name.
--
-- /See:/ 'newFilterRule' smart constructor.
data FilterRule = FilterRule'
  { -- | The value that the filter searches for in object key names.
    FilterRule -> Maybe Text
value :: Prelude.Maybe Prelude.Text,
    -- | The object key name prefix or suffix identifying one or more objects to
    -- which the filtering rule applies. The maximum length is 1,024
    -- characters. Overlapping prefixes and suffixes are not supported. For
    -- more information, see
    -- <https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html Configuring Event Notifications>
    -- in the /Amazon S3 User Guide/.
    FilterRule -> Maybe FilterRuleName
name :: Prelude.Maybe FilterRuleName
  }
  deriving (FilterRule -> FilterRule -> Bool
(FilterRule -> FilterRule -> Bool)
-> (FilterRule -> FilterRule -> Bool) -> Eq FilterRule
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: FilterRule -> FilterRule -> Bool
$c/= :: FilterRule -> FilterRule -> Bool
== :: FilterRule -> FilterRule -> Bool
$c== :: FilterRule -> FilterRule -> Bool
Prelude.Eq, ReadPrec [FilterRule]
ReadPrec FilterRule
Int -> ReadS FilterRule
ReadS [FilterRule]
(Int -> ReadS FilterRule)
-> ReadS [FilterRule]
-> ReadPrec FilterRule
-> ReadPrec [FilterRule]
-> Read FilterRule
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [FilterRule]
$creadListPrec :: ReadPrec [FilterRule]
readPrec :: ReadPrec FilterRule
$creadPrec :: ReadPrec FilterRule
readList :: ReadS [FilterRule]
$creadList :: ReadS [FilterRule]
readsPrec :: Int -> ReadS FilterRule
$creadsPrec :: Int -> ReadS FilterRule
Prelude.Read, Int -> FilterRule -> ShowS
[FilterRule] -> ShowS
FilterRule -> String
(Int -> FilterRule -> ShowS)
-> (FilterRule -> String)
-> ([FilterRule] -> ShowS)
-> Show FilterRule
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [FilterRule] -> ShowS
$cshowList :: [FilterRule] -> ShowS
show :: FilterRule -> String
$cshow :: FilterRule -> String
showsPrec :: Int -> FilterRule -> ShowS
$cshowsPrec :: Int -> FilterRule -> ShowS
Prelude.Show, (forall x. FilterRule -> Rep FilterRule x)
-> (forall x. Rep FilterRule x -> FilterRule) -> Generic FilterRule
forall x. Rep FilterRule x -> FilterRule
forall x. FilterRule -> Rep FilterRule x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep FilterRule x -> FilterRule
$cfrom :: forall x. FilterRule -> Rep FilterRule x
Prelude.Generic)

-- |
-- Create a value of 'FilterRule' 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:
--
-- 'value', 'filterRule_value' - The value that the filter searches for in object key names.
--
-- 'name', 'filterRule_name' - The object key name prefix or suffix identifying one or more objects to
-- which the filtering rule applies. The maximum length is 1,024
-- characters. Overlapping prefixes and suffixes are not supported. For
-- more information, see
-- <https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html Configuring Event Notifications>
-- in the /Amazon S3 User Guide/.
newFilterRule ::
  FilterRule
newFilterRule :: FilterRule
newFilterRule =
  FilterRule' :: Maybe Text -> Maybe FilterRuleName -> FilterRule
FilterRule'
    { $sel:value:FilterRule' :: Maybe Text
value = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:name:FilterRule' :: Maybe FilterRuleName
name = Maybe FilterRuleName
forall a. Maybe a
Prelude.Nothing
    }

-- | The value that the filter searches for in object key names.
filterRule_value :: Lens.Lens' FilterRule (Prelude.Maybe Prelude.Text)
filterRule_value :: (Maybe Text -> f (Maybe Text)) -> FilterRule -> f FilterRule
filterRule_value = (FilterRule -> Maybe Text)
-> (FilterRule -> Maybe Text -> FilterRule)
-> Lens FilterRule FilterRule (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FilterRule' {Maybe Text
value :: Maybe Text
$sel:value:FilterRule' :: FilterRule -> Maybe Text
value} -> Maybe Text
value) (\s :: FilterRule
s@FilterRule' {} Maybe Text
a -> FilterRule
s {$sel:value:FilterRule' :: Maybe Text
value = Maybe Text
a} :: FilterRule)

-- | The object key name prefix or suffix identifying one or more objects to
-- which the filtering rule applies. The maximum length is 1,024
-- characters. Overlapping prefixes and suffixes are not supported. For
-- more information, see
-- <https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html Configuring Event Notifications>
-- in the /Amazon S3 User Guide/.
filterRule_name :: Lens.Lens' FilterRule (Prelude.Maybe FilterRuleName)
filterRule_name :: (Maybe FilterRuleName -> f (Maybe FilterRuleName))
-> FilterRule -> f FilterRule
filterRule_name = (FilterRule -> Maybe FilterRuleName)
-> (FilterRule -> Maybe FilterRuleName -> FilterRule)
-> Lens
     FilterRule FilterRule (Maybe FilterRuleName) (Maybe FilterRuleName)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FilterRule' {Maybe FilterRuleName
name :: Maybe FilterRuleName
$sel:name:FilterRule' :: FilterRule -> Maybe FilterRuleName
name} -> Maybe FilterRuleName
name) (\s :: FilterRule
s@FilterRule' {} Maybe FilterRuleName
a -> FilterRule
s {$sel:name:FilterRule' :: Maybe FilterRuleName
name = Maybe FilterRuleName
a} :: FilterRule)

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

instance Prelude.Hashable FilterRule

instance Prelude.NFData FilterRule

instance Core.ToXML FilterRule where
  toXML :: FilterRule -> XML
toXML FilterRule' {Maybe Text
Maybe FilterRuleName
name :: Maybe FilterRuleName
value :: Maybe Text
$sel:name:FilterRule' :: FilterRule -> Maybe FilterRuleName
$sel:value:FilterRule' :: FilterRule -> Maybe Text
..} =
    [XML] -> XML
forall a. Monoid a => [a] -> a
Prelude.mconcat
      [Name
"Value" Name -> Maybe Text -> XML
forall a. ToXML a => Name -> a -> XML
Core.@= Maybe Text
value, Name
"Name" Name -> Maybe FilterRuleName -> XML
forall a. ToXML a => Name -> a -> XML
Core.@= Maybe FilterRuleName
name]