{-# 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.InventoryFilter
-- 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.InventoryFilter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import Amazonka.S3.Internal

-- | Specifies an inventory filter. The inventory only includes objects that
-- meet the filter\'s criteria.
--
-- /See:/ 'newInventoryFilter' smart constructor.
data InventoryFilter = InventoryFilter'
  { -- | The prefix that an object must have to be included in the inventory
    -- results.
    InventoryFilter -> Text
prefix :: Prelude.Text
  }
  deriving (InventoryFilter -> InventoryFilter -> Bool
(InventoryFilter -> InventoryFilter -> Bool)
-> (InventoryFilter -> InventoryFilter -> Bool)
-> Eq InventoryFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: InventoryFilter -> InventoryFilter -> Bool
$c/= :: InventoryFilter -> InventoryFilter -> Bool
== :: InventoryFilter -> InventoryFilter -> Bool
$c== :: InventoryFilter -> InventoryFilter -> Bool
Prelude.Eq, ReadPrec [InventoryFilter]
ReadPrec InventoryFilter
Int -> ReadS InventoryFilter
ReadS [InventoryFilter]
(Int -> ReadS InventoryFilter)
-> ReadS [InventoryFilter]
-> ReadPrec InventoryFilter
-> ReadPrec [InventoryFilter]
-> Read InventoryFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [InventoryFilter]
$creadListPrec :: ReadPrec [InventoryFilter]
readPrec :: ReadPrec InventoryFilter
$creadPrec :: ReadPrec InventoryFilter
readList :: ReadS [InventoryFilter]
$creadList :: ReadS [InventoryFilter]
readsPrec :: Int -> ReadS InventoryFilter
$creadsPrec :: Int -> ReadS InventoryFilter
Prelude.Read, Int -> InventoryFilter -> ShowS
[InventoryFilter] -> ShowS
InventoryFilter -> String
(Int -> InventoryFilter -> ShowS)
-> (InventoryFilter -> String)
-> ([InventoryFilter] -> ShowS)
-> Show InventoryFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [InventoryFilter] -> ShowS
$cshowList :: [InventoryFilter] -> ShowS
show :: InventoryFilter -> String
$cshow :: InventoryFilter -> String
showsPrec :: Int -> InventoryFilter -> ShowS
$cshowsPrec :: Int -> InventoryFilter -> ShowS
Prelude.Show, (forall x. InventoryFilter -> Rep InventoryFilter x)
-> (forall x. Rep InventoryFilter x -> InventoryFilter)
-> Generic InventoryFilter
forall x. Rep InventoryFilter x -> InventoryFilter
forall x. InventoryFilter -> Rep InventoryFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep InventoryFilter x -> InventoryFilter
$cfrom :: forall x. InventoryFilter -> Rep InventoryFilter x
Prelude.Generic)

-- |
-- Create a value of 'InventoryFilter' 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:
--
-- 'prefix', 'inventoryFilter_prefix' - The prefix that an object must have to be included in the inventory
-- results.
newInventoryFilter ::
  -- | 'prefix'
  Prelude.Text ->
  InventoryFilter
newInventoryFilter :: Text -> InventoryFilter
newInventoryFilter Text
pPrefix_ =
  InventoryFilter' :: Text -> InventoryFilter
InventoryFilter' {$sel:prefix:InventoryFilter' :: Text
prefix = Text
pPrefix_}

-- | The prefix that an object must have to be included in the inventory
-- results.
inventoryFilter_prefix :: Lens.Lens' InventoryFilter Prelude.Text
inventoryFilter_prefix :: (Text -> f Text) -> InventoryFilter -> f InventoryFilter
inventoryFilter_prefix = (InventoryFilter -> Text)
-> (InventoryFilter -> Text -> InventoryFilter)
-> Lens InventoryFilter InventoryFilter Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InventoryFilter' {Text
prefix :: Text
$sel:prefix:InventoryFilter' :: InventoryFilter -> Text
prefix} -> Text
prefix) (\s :: InventoryFilter
s@InventoryFilter' {} Text
a -> InventoryFilter
s {$sel:prefix:InventoryFilter' :: Text
prefix = Text
a} :: InventoryFilter)

instance Core.FromXML InventoryFilter where
  parseXML :: [Node] -> Either String InventoryFilter
parseXML [Node]
x =
    Text -> InventoryFilter
InventoryFilter' (Text -> InventoryFilter)
-> Either String Text -> Either String InventoryFilter
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x [Node] -> Text -> Either String Text
forall a. FromXML a => [Node] -> Text -> Either String a
Core..@ Text
"Prefix")

instance Prelude.Hashable InventoryFilter

instance Prelude.NFData InventoryFilter

instance Core.ToXML InventoryFilter where
  toXML :: InventoryFilter -> XML
toXML InventoryFilter' {Text
prefix :: Text
$sel:prefix:InventoryFilter' :: InventoryFilter -> Text
..} =
    [XML] -> XML
forall a. Monoid a => [a] -> a
Prelude.mconcat [Name
"Prefix" Name -> Text -> XML
forall a. ToXML a => Name -> a -> XML
Core.@= Text
prefix]