{-# 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-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.S3.Types.FilterRule where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
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 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,
    -- | The value that the filter searches for in object key names.
    FilterRule -> Maybe Text
value :: Prelude.Maybe Prelude.Text
  }
  deriving (FilterRule -> FilterRule -> Bool
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]
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
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. 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:
--
-- '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/.
--
-- 'value', 'filterRule_value' - The value that the filter searches for in object key names.
newFilterRule ::
  FilterRule
newFilterRule :: FilterRule
newFilterRule =
  FilterRule'
    { $sel:name:FilterRule' :: Maybe FilterRuleName
name = forall a. Maybe a
Prelude.Nothing,
      $sel:value:FilterRule' :: Maybe Text
value = forall a. Maybe a
Prelude.Nothing
    }

-- | 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 :: Lens' FilterRule (Maybe FilterRuleName)
filterRule_name = 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)

-- | The value that the filter searches for in object key names.
filterRule_value :: Lens.Lens' FilterRule (Prelude.Maybe Prelude.Text)
filterRule_value :: Lens' FilterRule (Maybe Text)
filterRule_value = 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)

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

instance Prelude.Hashable FilterRule where
  hashWithSalt :: Int -> FilterRule -> Int
hashWithSalt Int
_salt FilterRule' {Maybe Text
Maybe FilterRuleName
value :: Maybe Text
name :: Maybe FilterRuleName
$sel:value:FilterRule' :: FilterRule -> Maybe Text
$sel:name:FilterRule' :: FilterRule -> Maybe FilterRuleName
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe FilterRuleName
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
value

instance Prelude.NFData FilterRule where
  rnf :: FilterRule -> ()
rnf FilterRule' {Maybe Text
Maybe FilterRuleName
value :: Maybe Text
name :: Maybe FilterRuleName
$sel:value:FilterRule' :: FilterRule -> Maybe Text
$sel:name:FilterRule' :: FilterRule -> Maybe FilterRuleName
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe FilterRuleName
name seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
value

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