{-# 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.SecretsManager.Types.Filter
-- 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.SecretsManager.Types.Filter 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.SecretsManager.Types.FilterNameStringType

-- | Allows you to add filters when you use the search function in Secrets
-- Manager. For more information, see
-- <https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html Find secrets in Secrets Manager>.
--
-- /See:/ 'newFilter' smart constructor.
data Filter = Filter'
  { -- | The following are keys you can use:
    --
    -- -   __description__: Prefix match, not case-sensitive.
    --
    -- -   __name__: Prefix match, case-sensitive.
    --
    -- -   __tag-key__: Prefix match, case-sensitive.
    --
    -- -   __tag-value__: Prefix match, case-sensitive.
    --
    -- -   __primary-region__: Prefix match, case-sensitive.
    --
    -- -   __all__: Breaks the filter value string into words and then searches
    --     all attributes for matches. Not case-sensitive.
    Filter -> Maybe FilterNameStringType
key :: Prelude.Maybe FilterNameStringType,
    -- | The keyword to filter for.
    --
    -- You can prefix your search value with an exclamation mark (@!@) in order
    -- to perform negation filters.
    Filter -> Maybe (NonEmpty Text)
values :: Prelude.Maybe (Prelude.NonEmpty Prelude.Text)
  }
  deriving (Filter -> Filter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Filter -> Filter -> Bool
$c/= :: Filter -> Filter -> Bool
== :: Filter -> Filter -> Bool
$c== :: Filter -> Filter -> Bool
Prelude.Eq, ReadPrec [Filter]
ReadPrec Filter
Int -> ReadS Filter
ReadS [Filter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Filter]
$creadListPrec :: ReadPrec [Filter]
readPrec :: ReadPrec Filter
$creadPrec :: ReadPrec Filter
readList :: ReadS [Filter]
$creadList :: ReadS [Filter]
readsPrec :: Int -> ReadS Filter
$creadsPrec :: Int -> ReadS Filter
Prelude.Read, Int -> Filter -> ShowS
[Filter] -> ShowS
Filter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Filter] -> ShowS
$cshowList :: [Filter] -> ShowS
show :: Filter -> String
$cshow :: Filter -> String
showsPrec :: Int -> Filter -> ShowS
$cshowsPrec :: Int -> Filter -> ShowS
Prelude.Show, forall x. Rep Filter x -> Filter
forall x. Filter -> Rep Filter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Filter x -> Filter
$cfrom :: forall x. Filter -> Rep Filter x
Prelude.Generic)

-- |
-- Create a value of 'Filter' 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:
--
-- 'key', 'filter_key' - The following are keys you can use:
--
-- -   __description__: Prefix match, not case-sensitive.
--
-- -   __name__: Prefix match, case-sensitive.
--
-- -   __tag-key__: Prefix match, case-sensitive.
--
-- -   __tag-value__: Prefix match, case-sensitive.
--
-- -   __primary-region__: Prefix match, case-sensitive.
--
-- -   __all__: Breaks the filter value string into words and then searches
--     all attributes for matches. Not case-sensitive.
--
-- 'values', 'filter_values' - The keyword to filter for.
--
-- You can prefix your search value with an exclamation mark (@!@) in order
-- to perform negation filters.
newFilter ::
  Filter
newFilter :: Filter
newFilter =
  Filter'
    { $sel:key:Filter' :: Maybe FilterNameStringType
key = forall a. Maybe a
Prelude.Nothing,
      $sel:values:Filter' :: Maybe (NonEmpty Text)
values = forall a. Maybe a
Prelude.Nothing
    }

-- | The following are keys you can use:
--
-- -   __description__: Prefix match, not case-sensitive.
--
-- -   __name__: Prefix match, case-sensitive.
--
-- -   __tag-key__: Prefix match, case-sensitive.
--
-- -   __tag-value__: Prefix match, case-sensitive.
--
-- -   __primary-region__: Prefix match, case-sensitive.
--
-- -   __all__: Breaks the filter value string into words and then searches
--     all attributes for matches. Not case-sensitive.
filter_key :: Lens.Lens' Filter (Prelude.Maybe FilterNameStringType)
filter_key :: Lens' Filter (Maybe FilterNameStringType)
filter_key = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Filter' {Maybe FilterNameStringType
key :: Maybe FilterNameStringType
$sel:key:Filter' :: Filter -> Maybe FilterNameStringType
key} -> Maybe FilterNameStringType
key) (\s :: Filter
s@Filter' {} Maybe FilterNameStringType
a -> Filter
s {$sel:key:Filter' :: Maybe FilterNameStringType
key = Maybe FilterNameStringType
a} :: Filter)

-- | The keyword to filter for.
--
-- You can prefix your search value with an exclamation mark (@!@) in order
-- to perform negation filters.
filter_values :: Lens.Lens' Filter (Prelude.Maybe (Prelude.NonEmpty Prelude.Text))
filter_values :: Lens' Filter (Maybe (NonEmpty Text))
filter_values = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Filter' {Maybe (NonEmpty Text)
values :: Maybe (NonEmpty Text)
$sel:values:Filter' :: Filter -> Maybe (NonEmpty Text)
values} -> Maybe (NonEmpty Text)
values) (\s :: Filter
s@Filter' {} Maybe (NonEmpty Text)
a -> Filter
s {$sel:values:Filter' :: Maybe (NonEmpty Text)
values = Maybe (NonEmpty Text)
a} :: Filter) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Prelude.Hashable Filter where
  hashWithSalt :: Int -> Filter -> Int
hashWithSalt Int
_salt Filter' {Maybe (NonEmpty Text)
Maybe FilterNameStringType
values :: Maybe (NonEmpty Text)
key :: Maybe FilterNameStringType
$sel:values:Filter' :: Filter -> Maybe (NonEmpty Text)
$sel:key:Filter' :: Filter -> Maybe FilterNameStringType
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe FilterNameStringType
key
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty Text)
values

instance Prelude.NFData Filter where
  rnf :: Filter -> ()
rnf Filter' {Maybe (NonEmpty Text)
Maybe FilterNameStringType
values :: Maybe (NonEmpty Text)
key :: Maybe FilterNameStringType
$sel:values:Filter' :: Filter -> Maybe (NonEmpty Text)
$sel:key:Filter' :: Filter -> Maybe FilterNameStringType
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe FilterNameStringType
key seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty Text)
values

instance Data.ToJSON Filter where
  toJSON :: Filter -> Value
toJSON Filter' {Maybe (NonEmpty Text)
Maybe FilterNameStringType
values :: Maybe (NonEmpty Text)
key :: Maybe FilterNameStringType
$sel:values:Filter' :: Filter -> Maybe (NonEmpty Text)
$sel:key:Filter' :: Filter -> Maybe FilterNameStringType
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Key" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe FilterNameStringType
key,
            (Key
"Values" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (NonEmpty Text)
values
          ]
      )