{-# 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.CustomFilterListConfiguration
-- 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.QuickSight.Types.CustomFilterListConfiguration 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.QuickSight.Types.CategoryFilterMatchOperator
import Amazonka.QuickSight.Types.CategoryFilterSelectAllOptions
import Amazonka.QuickSight.Types.FilterNullOption

-- | A list of custom filter values.
--
-- /See:/ 'newCustomFilterListConfiguration' smart constructor.
data CustomFilterListConfiguration = CustomFilterListConfiguration'
  { -- | The list of category values for the filter.
    CustomFilterListConfiguration -> Maybe [Text]
categoryValues :: Prelude.Maybe [Prelude.Text],
    -- | Select all of the values. Null is not the assigned value of select all.
    --
    -- -   @FILTER_ALL_VALUES@
    CustomFilterListConfiguration
-> Maybe CategoryFilterSelectAllOptions
selectAllOptions :: Prelude.Maybe CategoryFilterSelectAllOptions,
    -- | The match operator that is used to determine if a filter should be
    -- applied.
    CustomFilterListConfiguration -> CategoryFilterMatchOperator
matchOperator :: CategoryFilterMatchOperator,
    -- | This option determines how null values should be treated when filtering
    -- data.
    --
    -- -   @ALL_VALUES@: Include null values in filtered results.
    --
    -- -   @NULLS_ONLY@: Only include null values in filtered results.
    --
    -- -   @NON_NULLS_ONLY@: Exclude null values from filtered results.
    CustomFilterListConfiguration -> FilterNullOption
nullOption :: FilterNullOption
  }
  deriving (CustomFilterListConfiguration
-> CustomFilterListConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CustomFilterListConfiguration
-> CustomFilterListConfiguration -> Bool
$c/= :: CustomFilterListConfiguration
-> CustomFilterListConfiguration -> Bool
== :: CustomFilterListConfiguration
-> CustomFilterListConfiguration -> Bool
$c== :: CustomFilterListConfiguration
-> CustomFilterListConfiguration -> Bool
Prelude.Eq, ReadPrec [CustomFilterListConfiguration]
ReadPrec CustomFilterListConfiguration
Int -> ReadS CustomFilterListConfiguration
ReadS [CustomFilterListConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CustomFilterListConfiguration]
$creadListPrec :: ReadPrec [CustomFilterListConfiguration]
readPrec :: ReadPrec CustomFilterListConfiguration
$creadPrec :: ReadPrec CustomFilterListConfiguration
readList :: ReadS [CustomFilterListConfiguration]
$creadList :: ReadS [CustomFilterListConfiguration]
readsPrec :: Int -> ReadS CustomFilterListConfiguration
$creadsPrec :: Int -> ReadS CustomFilterListConfiguration
Prelude.Read, Int -> CustomFilterListConfiguration -> ShowS
[CustomFilterListConfiguration] -> ShowS
CustomFilterListConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CustomFilterListConfiguration] -> ShowS
$cshowList :: [CustomFilterListConfiguration] -> ShowS
show :: CustomFilterListConfiguration -> String
$cshow :: CustomFilterListConfiguration -> String
showsPrec :: Int -> CustomFilterListConfiguration -> ShowS
$cshowsPrec :: Int -> CustomFilterListConfiguration -> ShowS
Prelude.Show, forall x.
Rep CustomFilterListConfiguration x
-> CustomFilterListConfiguration
forall x.
CustomFilterListConfiguration
-> Rep CustomFilterListConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CustomFilterListConfiguration x
-> CustomFilterListConfiguration
$cfrom :: forall x.
CustomFilterListConfiguration
-> Rep CustomFilterListConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'CustomFilterListConfiguration' 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:
--
-- 'categoryValues', 'customFilterListConfiguration_categoryValues' - The list of category values for the filter.
--
-- 'selectAllOptions', 'customFilterListConfiguration_selectAllOptions' - Select all of the values. Null is not the assigned value of select all.
--
-- -   @FILTER_ALL_VALUES@
--
-- 'matchOperator', 'customFilterListConfiguration_matchOperator' - The match operator that is used to determine if a filter should be
-- applied.
--
-- 'nullOption', 'customFilterListConfiguration_nullOption' - This option determines how null values should be treated when filtering
-- data.
--
-- -   @ALL_VALUES@: Include null values in filtered results.
--
-- -   @NULLS_ONLY@: Only include null values in filtered results.
--
-- -   @NON_NULLS_ONLY@: Exclude null values from filtered results.
newCustomFilterListConfiguration ::
  -- | 'matchOperator'
  CategoryFilterMatchOperator ->
  -- | 'nullOption'
  FilterNullOption ->
  CustomFilterListConfiguration
newCustomFilterListConfiguration :: CategoryFilterMatchOperator
-> FilterNullOption -> CustomFilterListConfiguration
newCustomFilterListConfiguration
  CategoryFilterMatchOperator
pMatchOperator_
  FilterNullOption
pNullOption_ =
    CustomFilterListConfiguration'
      { $sel:categoryValues:CustomFilterListConfiguration' :: Maybe [Text]
categoryValues =
          forall a. Maybe a
Prelude.Nothing,
        $sel:selectAllOptions:CustomFilterListConfiguration' :: Maybe CategoryFilterSelectAllOptions
selectAllOptions = forall a. Maybe a
Prelude.Nothing,
        $sel:matchOperator:CustomFilterListConfiguration' :: CategoryFilterMatchOperator
matchOperator = CategoryFilterMatchOperator
pMatchOperator_,
        $sel:nullOption:CustomFilterListConfiguration' :: FilterNullOption
nullOption = FilterNullOption
pNullOption_
      }

-- | The list of category values for the filter.
customFilterListConfiguration_categoryValues :: Lens.Lens' CustomFilterListConfiguration (Prelude.Maybe [Prelude.Text])
customFilterListConfiguration_categoryValues :: Lens' CustomFilterListConfiguration (Maybe [Text])
customFilterListConfiguration_categoryValues = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CustomFilterListConfiguration' {Maybe [Text]
categoryValues :: Maybe [Text]
$sel:categoryValues:CustomFilterListConfiguration' :: CustomFilterListConfiguration -> Maybe [Text]
categoryValues} -> Maybe [Text]
categoryValues) (\s :: CustomFilterListConfiguration
s@CustomFilterListConfiguration' {} Maybe [Text]
a -> CustomFilterListConfiguration
s {$sel:categoryValues:CustomFilterListConfiguration' :: Maybe [Text]
categoryValues = Maybe [Text]
a} :: CustomFilterListConfiguration) 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

-- | Select all of the values. Null is not the assigned value of select all.
--
-- -   @FILTER_ALL_VALUES@
customFilterListConfiguration_selectAllOptions :: Lens.Lens' CustomFilterListConfiguration (Prelude.Maybe CategoryFilterSelectAllOptions)
customFilterListConfiguration_selectAllOptions :: Lens'
  CustomFilterListConfiguration
  (Maybe CategoryFilterSelectAllOptions)
customFilterListConfiguration_selectAllOptions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CustomFilterListConfiguration' {Maybe CategoryFilterSelectAllOptions
selectAllOptions :: Maybe CategoryFilterSelectAllOptions
$sel:selectAllOptions:CustomFilterListConfiguration' :: CustomFilterListConfiguration
-> Maybe CategoryFilterSelectAllOptions
selectAllOptions} -> Maybe CategoryFilterSelectAllOptions
selectAllOptions) (\s :: CustomFilterListConfiguration
s@CustomFilterListConfiguration' {} Maybe CategoryFilterSelectAllOptions
a -> CustomFilterListConfiguration
s {$sel:selectAllOptions:CustomFilterListConfiguration' :: Maybe CategoryFilterSelectAllOptions
selectAllOptions = Maybe CategoryFilterSelectAllOptions
a} :: CustomFilterListConfiguration)

-- | The match operator that is used to determine if a filter should be
-- applied.
customFilterListConfiguration_matchOperator :: Lens.Lens' CustomFilterListConfiguration CategoryFilterMatchOperator
customFilterListConfiguration_matchOperator :: Lens' CustomFilterListConfiguration CategoryFilterMatchOperator
customFilterListConfiguration_matchOperator = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CustomFilterListConfiguration' {CategoryFilterMatchOperator
matchOperator :: CategoryFilterMatchOperator
$sel:matchOperator:CustomFilterListConfiguration' :: CustomFilterListConfiguration -> CategoryFilterMatchOperator
matchOperator} -> CategoryFilterMatchOperator
matchOperator) (\s :: CustomFilterListConfiguration
s@CustomFilterListConfiguration' {} CategoryFilterMatchOperator
a -> CustomFilterListConfiguration
s {$sel:matchOperator:CustomFilterListConfiguration' :: CategoryFilterMatchOperator
matchOperator = CategoryFilterMatchOperator
a} :: CustomFilterListConfiguration)

-- | This option determines how null values should be treated when filtering
-- data.
--
-- -   @ALL_VALUES@: Include null values in filtered results.
--
-- -   @NULLS_ONLY@: Only include null values in filtered results.
--
-- -   @NON_NULLS_ONLY@: Exclude null values from filtered results.
customFilterListConfiguration_nullOption :: Lens.Lens' CustomFilterListConfiguration FilterNullOption
customFilterListConfiguration_nullOption :: Lens' CustomFilterListConfiguration FilterNullOption
customFilterListConfiguration_nullOption = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CustomFilterListConfiguration' {FilterNullOption
nullOption :: FilterNullOption
$sel:nullOption:CustomFilterListConfiguration' :: CustomFilterListConfiguration -> FilterNullOption
nullOption} -> FilterNullOption
nullOption) (\s :: CustomFilterListConfiguration
s@CustomFilterListConfiguration' {} FilterNullOption
a -> CustomFilterListConfiguration
s {$sel:nullOption:CustomFilterListConfiguration' :: FilterNullOption
nullOption = FilterNullOption
a} :: CustomFilterListConfiguration)

instance Data.FromJSON CustomFilterListConfiguration where
  parseJSON :: Value -> Parser CustomFilterListConfiguration
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"CustomFilterListConfiguration"
      ( \Object
x ->
          Maybe [Text]
-> Maybe CategoryFilterSelectAllOptions
-> CategoryFilterMatchOperator
-> FilterNullOption
-> CustomFilterListConfiguration
CustomFilterListConfiguration'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"CategoryValues" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"SelectAllOptions")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"MatchOperator")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"NullOption")
      )

instance
  Prelude.Hashable
    CustomFilterListConfiguration
  where
  hashWithSalt :: Int -> CustomFilterListConfiguration -> Int
hashWithSalt Int
_salt CustomFilterListConfiguration' {Maybe [Text]
Maybe CategoryFilterSelectAllOptions
CategoryFilterMatchOperator
FilterNullOption
nullOption :: FilterNullOption
matchOperator :: CategoryFilterMatchOperator
selectAllOptions :: Maybe CategoryFilterSelectAllOptions
categoryValues :: Maybe [Text]
$sel:nullOption:CustomFilterListConfiguration' :: CustomFilterListConfiguration -> FilterNullOption
$sel:matchOperator:CustomFilterListConfiguration' :: CustomFilterListConfiguration -> CategoryFilterMatchOperator
$sel:selectAllOptions:CustomFilterListConfiguration' :: CustomFilterListConfiguration
-> Maybe CategoryFilterSelectAllOptions
$sel:categoryValues:CustomFilterListConfiguration' :: CustomFilterListConfiguration -> Maybe [Text]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
categoryValues
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe CategoryFilterSelectAllOptions
selectAllOptions
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` CategoryFilterMatchOperator
matchOperator
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` FilterNullOption
nullOption

instance Prelude.NFData CustomFilterListConfiguration where
  rnf :: CustomFilterListConfiguration -> ()
rnf CustomFilterListConfiguration' {Maybe [Text]
Maybe CategoryFilterSelectAllOptions
CategoryFilterMatchOperator
FilterNullOption
nullOption :: FilterNullOption
matchOperator :: CategoryFilterMatchOperator
selectAllOptions :: Maybe CategoryFilterSelectAllOptions
categoryValues :: Maybe [Text]
$sel:nullOption:CustomFilterListConfiguration' :: CustomFilterListConfiguration -> FilterNullOption
$sel:matchOperator:CustomFilterListConfiguration' :: CustomFilterListConfiguration -> CategoryFilterMatchOperator
$sel:selectAllOptions:CustomFilterListConfiguration' :: CustomFilterListConfiguration
-> Maybe CategoryFilterSelectAllOptions
$sel:categoryValues:CustomFilterListConfiguration' :: CustomFilterListConfiguration -> Maybe [Text]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
categoryValues
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe CategoryFilterSelectAllOptions
selectAllOptions
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf CategoryFilterMatchOperator
matchOperator
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf FilterNullOption
nullOption

instance Data.ToJSON CustomFilterListConfiguration where
  toJSON :: CustomFilterListConfiguration -> Value
toJSON CustomFilterListConfiguration' {Maybe [Text]
Maybe CategoryFilterSelectAllOptions
CategoryFilterMatchOperator
FilterNullOption
nullOption :: FilterNullOption
matchOperator :: CategoryFilterMatchOperator
selectAllOptions :: Maybe CategoryFilterSelectAllOptions
categoryValues :: Maybe [Text]
$sel:nullOption:CustomFilterListConfiguration' :: CustomFilterListConfiguration -> FilterNullOption
$sel:matchOperator:CustomFilterListConfiguration' :: CustomFilterListConfiguration -> CategoryFilterMatchOperator
$sel:selectAllOptions:CustomFilterListConfiguration' :: CustomFilterListConfiguration
-> Maybe CategoryFilterSelectAllOptions
$sel:categoryValues:CustomFilterListConfiguration' :: CustomFilterListConfiguration -> Maybe [Text]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"CategoryValues" 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 [Text]
categoryValues,
            (Key
"SelectAllOptions" 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 CategoryFilterSelectAllOptions
selectAllOptions,
            forall a. a -> Maybe a
Prelude.Just (Key
"MatchOperator" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= CategoryFilterMatchOperator
matchOperator),
            forall a. a -> Maybe a
Prelude.Just (Key
"NullOption" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= FilterNullOption
nullOption)
          ]
      )