{-# 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.QuickSight.Types.FolderSearchFilter
-- 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.QuickSight.Types.FolderSearchFilter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import Amazonka.QuickSight.Types.FilterOperator
import Amazonka.QuickSight.Types.FolderFilterAttribute

-- | Searches a folder by a filter.
--
-- /See:/ 'newFolderSearchFilter' smart constructor.
data FolderSearchFilter = FolderSearchFilter'
  { -- | The comparison operator that you want to use as a filter. For example,
    -- @\"Operator\": \"StringEquals\"@.
    FolderSearchFilter -> Maybe FilterOperator
operator :: Prelude.Maybe FilterOperator,
    -- | The value of the named item (in this example, @PARENT_FOLDER_ARN@), that
    -- you want to use as a filter. For example,
    -- @\"Value\": \"arn:aws:quicksight:us-east-1:1:folder\/folderId\"@.
    FolderSearchFilter -> Maybe Text
value :: Prelude.Maybe Prelude.Text,
    -- | The name of the value that you want to use as a filter. For example,
    -- @\"Name\": \"PARENT_FOLDER_ARN\"@.
    FolderSearchFilter -> Maybe FolderFilterAttribute
name :: Prelude.Maybe FolderFilterAttribute
  }
  deriving (FolderSearchFilter -> FolderSearchFilter -> Bool
(FolderSearchFilter -> FolderSearchFilter -> Bool)
-> (FolderSearchFilter -> FolderSearchFilter -> Bool)
-> Eq FolderSearchFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: FolderSearchFilter -> FolderSearchFilter -> Bool
$c/= :: FolderSearchFilter -> FolderSearchFilter -> Bool
== :: FolderSearchFilter -> FolderSearchFilter -> Bool
$c== :: FolderSearchFilter -> FolderSearchFilter -> Bool
Prelude.Eq, ReadPrec [FolderSearchFilter]
ReadPrec FolderSearchFilter
Int -> ReadS FolderSearchFilter
ReadS [FolderSearchFilter]
(Int -> ReadS FolderSearchFilter)
-> ReadS [FolderSearchFilter]
-> ReadPrec FolderSearchFilter
-> ReadPrec [FolderSearchFilter]
-> Read FolderSearchFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [FolderSearchFilter]
$creadListPrec :: ReadPrec [FolderSearchFilter]
readPrec :: ReadPrec FolderSearchFilter
$creadPrec :: ReadPrec FolderSearchFilter
readList :: ReadS [FolderSearchFilter]
$creadList :: ReadS [FolderSearchFilter]
readsPrec :: Int -> ReadS FolderSearchFilter
$creadsPrec :: Int -> ReadS FolderSearchFilter
Prelude.Read, Int -> FolderSearchFilter -> ShowS
[FolderSearchFilter] -> ShowS
FolderSearchFilter -> String
(Int -> FolderSearchFilter -> ShowS)
-> (FolderSearchFilter -> String)
-> ([FolderSearchFilter] -> ShowS)
-> Show FolderSearchFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [FolderSearchFilter] -> ShowS
$cshowList :: [FolderSearchFilter] -> ShowS
show :: FolderSearchFilter -> String
$cshow :: FolderSearchFilter -> String
showsPrec :: Int -> FolderSearchFilter -> ShowS
$cshowsPrec :: Int -> FolderSearchFilter -> ShowS
Prelude.Show, (forall x. FolderSearchFilter -> Rep FolderSearchFilter x)
-> (forall x. Rep FolderSearchFilter x -> FolderSearchFilter)
-> Generic FolderSearchFilter
forall x. Rep FolderSearchFilter x -> FolderSearchFilter
forall x. FolderSearchFilter -> Rep FolderSearchFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep FolderSearchFilter x -> FolderSearchFilter
$cfrom :: forall x. FolderSearchFilter -> Rep FolderSearchFilter x
Prelude.Generic)

-- |
-- Create a value of 'FolderSearchFilter' 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:
--
-- 'operator', 'folderSearchFilter_operator' - The comparison operator that you want to use as a filter. For example,
-- @\"Operator\": \"StringEquals\"@.
--
-- 'value', 'folderSearchFilter_value' - The value of the named item (in this example, @PARENT_FOLDER_ARN@), that
-- you want to use as a filter. For example,
-- @\"Value\": \"arn:aws:quicksight:us-east-1:1:folder\/folderId\"@.
--
-- 'name', 'folderSearchFilter_name' - The name of the value that you want to use as a filter. For example,
-- @\"Name\": \"PARENT_FOLDER_ARN\"@.
newFolderSearchFilter ::
  FolderSearchFilter
newFolderSearchFilter :: FolderSearchFilter
newFolderSearchFilter =
  FolderSearchFilter' :: Maybe FilterOperator
-> Maybe Text -> Maybe FolderFilterAttribute -> FolderSearchFilter
FolderSearchFilter'
    { $sel:operator:FolderSearchFilter' :: Maybe FilterOperator
operator = Maybe FilterOperator
forall a. Maybe a
Prelude.Nothing,
      $sel:value:FolderSearchFilter' :: Maybe Text
value = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:name:FolderSearchFilter' :: Maybe FolderFilterAttribute
name = Maybe FolderFilterAttribute
forall a. Maybe a
Prelude.Nothing
    }

-- | The comparison operator that you want to use as a filter. For example,
-- @\"Operator\": \"StringEquals\"@.
folderSearchFilter_operator :: Lens.Lens' FolderSearchFilter (Prelude.Maybe FilterOperator)
folderSearchFilter_operator :: (Maybe FilterOperator -> f (Maybe FilterOperator))
-> FolderSearchFilter -> f FolderSearchFilter
folderSearchFilter_operator = (FolderSearchFilter -> Maybe FilterOperator)
-> (FolderSearchFilter
    -> Maybe FilterOperator -> FolderSearchFilter)
-> Lens
     FolderSearchFilter
     FolderSearchFilter
     (Maybe FilterOperator)
     (Maybe FilterOperator)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FolderSearchFilter' {Maybe FilterOperator
operator :: Maybe FilterOperator
$sel:operator:FolderSearchFilter' :: FolderSearchFilter -> Maybe FilterOperator
operator} -> Maybe FilterOperator
operator) (\s :: FolderSearchFilter
s@FolderSearchFilter' {} Maybe FilterOperator
a -> FolderSearchFilter
s {$sel:operator:FolderSearchFilter' :: Maybe FilterOperator
operator = Maybe FilterOperator
a} :: FolderSearchFilter)

-- | The value of the named item (in this example, @PARENT_FOLDER_ARN@), that
-- you want to use as a filter. For example,
-- @\"Value\": \"arn:aws:quicksight:us-east-1:1:folder\/folderId\"@.
folderSearchFilter_value :: Lens.Lens' FolderSearchFilter (Prelude.Maybe Prelude.Text)
folderSearchFilter_value :: (Maybe Text -> f (Maybe Text))
-> FolderSearchFilter -> f FolderSearchFilter
folderSearchFilter_value = (FolderSearchFilter -> Maybe Text)
-> (FolderSearchFilter -> Maybe Text -> FolderSearchFilter)
-> Lens
     FolderSearchFilter FolderSearchFilter (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FolderSearchFilter' {Maybe Text
value :: Maybe Text
$sel:value:FolderSearchFilter' :: FolderSearchFilter -> Maybe Text
value} -> Maybe Text
value) (\s :: FolderSearchFilter
s@FolderSearchFilter' {} Maybe Text
a -> FolderSearchFilter
s {$sel:value:FolderSearchFilter' :: Maybe Text
value = Maybe Text
a} :: FolderSearchFilter)

-- | The name of the value that you want to use as a filter. For example,
-- @\"Name\": \"PARENT_FOLDER_ARN\"@.
folderSearchFilter_name :: Lens.Lens' FolderSearchFilter (Prelude.Maybe FolderFilterAttribute)
folderSearchFilter_name :: (Maybe FolderFilterAttribute -> f (Maybe FolderFilterAttribute))
-> FolderSearchFilter -> f FolderSearchFilter
folderSearchFilter_name = (FolderSearchFilter -> Maybe FolderFilterAttribute)
-> (FolderSearchFilter
    -> Maybe FolderFilterAttribute -> FolderSearchFilter)
-> Lens
     FolderSearchFilter
     FolderSearchFilter
     (Maybe FolderFilterAttribute)
     (Maybe FolderFilterAttribute)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FolderSearchFilter' {Maybe FolderFilterAttribute
name :: Maybe FolderFilterAttribute
$sel:name:FolderSearchFilter' :: FolderSearchFilter -> Maybe FolderFilterAttribute
name} -> Maybe FolderFilterAttribute
name) (\s :: FolderSearchFilter
s@FolderSearchFilter' {} Maybe FolderFilterAttribute
a -> FolderSearchFilter
s {$sel:name:FolderSearchFilter' :: Maybe FolderFilterAttribute
name = Maybe FolderFilterAttribute
a} :: FolderSearchFilter)

instance Prelude.Hashable FolderSearchFilter

instance Prelude.NFData FolderSearchFilter

instance Core.ToJSON FolderSearchFilter where
  toJSON :: FolderSearchFilter -> Value
toJSON FolderSearchFilter' {Maybe Text
Maybe FilterOperator
Maybe FolderFilterAttribute
name :: Maybe FolderFilterAttribute
value :: Maybe Text
operator :: Maybe FilterOperator
$sel:name:FolderSearchFilter' :: FolderSearchFilter -> Maybe FolderFilterAttribute
$sel:value:FolderSearchFilter' :: FolderSearchFilter -> Maybe Text
$sel:operator:FolderSearchFilter' :: FolderSearchFilter -> Maybe FilterOperator
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"Operator" Text -> FilterOperator -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (FilterOperator -> Pair) -> Maybe FilterOperator -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe FilterOperator
operator,
            (Text
"Value" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
value,
            (Text
"Name" Text -> FolderFilterAttribute -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (FolderFilterAttribute -> Pair)
-> Maybe FolderFilterAttribute -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe FolderFilterAttribute
name
          ]
      )