{-# 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.CustomFilterConfiguration
-- 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.CustomFilterConfiguration 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 custom filter that filters based on a single value. This filter can be
-- partially matched.
--
-- /See:/ 'newCustomFilterConfiguration' smart constructor.
data CustomFilterConfiguration = CustomFilterConfiguration'
  { -- | The category value for the filter.
    --
    -- This field is mutually exclusive to @ParameterName@.
    CustomFilterConfiguration -> Maybe Text
categoryValue :: Prelude.Maybe Prelude.Text,
    -- | The parameter whose value should be used for the filter value.
    --
    -- This field is mutually exclusive to @CategoryValue@.
    CustomFilterConfiguration -> Maybe Text
parameterName :: Prelude.Maybe Prelude.Text,
    -- | Select all of the values. Null is not the assigned value of select all.
    --
    -- -   @FILTER_ALL_VALUES@
    CustomFilterConfiguration -> Maybe CategoryFilterSelectAllOptions
selectAllOptions :: Prelude.Maybe CategoryFilterSelectAllOptions,
    -- | The match operator that is used to determine if a filter should be
    -- applied.
    CustomFilterConfiguration -> 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.
    CustomFilterConfiguration -> FilterNullOption
nullOption :: FilterNullOption
  }
  deriving (CustomFilterConfiguration -> CustomFilterConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CustomFilterConfiguration -> CustomFilterConfiguration -> Bool
$c/= :: CustomFilterConfiguration -> CustomFilterConfiguration -> Bool
== :: CustomFilterConfiguration -> CustomFilterConfiguration -> Bool
$c== :: CustomFilterConfiguration -> CustomFilterConfiguration -> Bool
Prelude.Eq, ReadPrec [CustomFilterConfiguration]
ReadPrec CustomFilterConfiguration
Int -> ReadS CustomFilterConfiguration
ReadS [CustomFilterConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CustomFilterConfiguration]
$creadListPrec :: ReadPrec [CustomFilterConfiguration]
readPrec :: ReadPrec CustomFilterConfiguration
$creadPrec :: ReadPrec CustomFilterConfiguration
readList :: ReadS [CustomFilterConfiguration]
$creadList :: ReadS [CustomFilterConfiguration]
readsPrec :: Int -> ReadS CustomFilterConfiguration
$creadsPrec :: Int -> ReadS CustomFilterConfiguration
Prelude.Read, Int -> CustomFilterConfiguration -> ShowS
[CustomFilterConfiguration] -> ShowS
CustomFilterConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CustomFilterConfiguration] -> ShowS
$cshowList :: [CustomFilterConfiguration] -> ShowS
show :: CustomFilterConfiguration -> String
$cshow :: CustomFilterConfiguration -> String
showsPrec :: Int -> CustomFilterConfiguration -> ShowS
$cshowsPrec :: Int -> CustomFilterConfiguration -> ShowS
Prelude.Show, forall x.
Rep CustomFilterConfiguration x -> CustomFilterConfiguration
forall x.
CustomFilterConfiguration -> Rep CustomFilterConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CustomFilterConfiguration x -> CustomFilterConfiguration
$cfrom :: forall x.
CustomFilterConfiguration -> Rep CustomFilterConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'CustomFilterConfiguration' 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:
--
-- 'categoryValue', 'customFilterConfiguration_categoryValue' - The category value for the filter.
--
-- This field is mutually exclusive to @ParameterName@.
--
-- 'parameterName', 'customFilterConfiguration_parameterName' - The parameter whose value should be used for the filter value.
--
-- This field is mutually exclusive to @CategoryValue@.
--
-- 'selectAllOptions', 'customFilterConfiguration_selectAllOptions' - Select all of the values. Null is not the assigned value of select all.
--
-- -   @FILTER_ALL_VALUES@
--
-- 'matchOperator', 'customFilterConfiguration_matchOperator' - The match operator that is used to determine if a filter should be
-- applied.
--
-- 'nullOption', 'customFilterConfiguration_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.
newCustomFilterConfiguration ::
  -- | 'matchOperator'
  CategoryFilterMatchOperator ->
  -- | 'nullOption'
  FilterNullOption ->
  CustomFilterConfiguration
newCustomFilterConfiguration :: CategoryFilterMatchOperator
-> FilterNullOption -> CustomFilterConfiguration
newCustomFilterConfiguration
  CategoryFilterMatchOperator
pMatchOperator_
  FilterNullOption
pNullOption_ =
    CustomFilterConfiguration'
      { $sel:categoryValue:CustomFilterConfiguration' :: Maybe Text
categoryValue =
          forall a. Maybe a
Prelude.Nothing,
        $sel:parameterName:CustomFilterConfiguration' :: Maybe Text
parameterName = forall a. Maybe a
Prelude.Nothing,
        $sel:selectAllOptions:CustomFilterConfiguration' :: Maybe CategoryFilterSelectAllOptions
selectAllOptions = forall a. Maybe a
Prelude.Nothing,
        $sel:matchOperator:CustomFilterConfiguration' :: CategoryFilterMatchOperator
matchOperator = CategoryFilterMatchOperator
pMatchOperator_,
        $sel:nullOption:CustomFilterConfiguration' :: FilterNullOption
nullOption = FilterNullOption
pNullOption_
      }

-- | The category value for the filter.
--
-- This field is mutually exclusive to @ParameterName@.
customFilterConfiguration_categoryValue :: Lens.Lens' CustomFilterConfiguration (Prelude.Maybe Prelude.Text)
customFilterConfiguration_categoryValue :: Lens' CustomFilterConfiguration (Maybe Text)
customFilterConfiguration_categoryValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CustomFilterConfiguration' {Maybe Text
categoryValue :: Maybe Text
$sel:categoryValue:CustomFilterConfiguration' :: CustomFilterConfiguration -> Maybe Text
categoryValue} -> Maybe Text
categoryValue) (\s :: CustomFilterConfiguration
s@CustomFilterConfiguration' {} Maybe Text
a -> CustomFilterConfiguration
s {$sel:categoryValue:CustomFilterConfiguration' :: Maybe Text
categoryValue = Maybe Text
a} :: CustomFilterConfiguration)

-- | The parameter whose value should be used for the filter value.
--
-- This field is mutually exclusive to @CategoryValue@.
customFilterConfiguration_parameterName :: Lens.Lens' CustomFilterConfiguration (Prelude.Maybe Prelude.Text)
customFilterConfiguration_parameterName :: Lens' CustomFilterConfiguration (Maybe Text)
customFilterConfiguration_parameterName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CustomFilterConfiguration' {Maybe Text
parameterName :: Maybe Text
$sel:parameterName:CustomFilterConfiguration' :: CustomFilterConfiguration -> Maybe Text
parameterName} -> Maybe Text
parameterName) (\s :: CustomFilterConfiguration
s@CustomFilterConfiguration' {} Maybe Text
a -> CustomFilterConfiguration
s {$sel:parameterName:CustomFilterConfiguration' :: Maybe Text
parameterName = Maybe Text
a} :: CustomFilterConfiguration)

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

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

-- | 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.
customFilterConfiguration_nullOption :: Lens.Lens' CustomFilterConfiguration FilterNullOption
customFilterConfiguration_nullOption :: Lens' CustomFilterConfiguration FilterNullOption
customFilterConfiguration_nullOption = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CustomFilterConfiguration' {FilterNullOption
nullOption :: FilterNullOption
$sel:nullOption:CustomFilterConfiguration' :: CustomFilterConfiguration -> FilterNullOption
nullOption} -> FilterNullOption
nullOption) (\s :: CustomFilterConfiguration
s@CustomFilterConfiguration' {} FilterNullOption
a -> CustomFilterConfiguration
s {$sel:nullOption:CustomFilterConfiguration' :: FilterNullOption
nullOption = FilterNullOption
a} :: CustomFilterConfiguration)

instance Data.FromJSON CustomFilterConfiguration where
  parseJSON :: Value -> Parser CustomFilterConfiguration
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"CustomFilterConfiguration"
      ( \Object
x ->
          Maybe Text
-> Maybe Text
-> Maybe CategoryFilterSelectAllOptions
-> CategoryFilterMatchOperator
-> FilterNullOption
-> CustomFilterConfiguration
CustomFilterConfiguration'
            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
"CategoryValue")
            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
"ParameterName")
            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 CustomFilterConfiguration where
  hashWithSalt :: Int -> CustomFilterConfiguration -> Int
hashWithSalt Int
_salt CustomFilterConfiguration' {Maybe Text
Maybe CategoryFilterSelectAllOptions
CategoryFilterMatchOperator
FilterNullOption
nullOption :: FilterNullOption
matchOperator :: CategoryFilterMatchOperator
selectAllOptions :: Maybe CategoryFilterSelectAllOptions
parameterName :: Maybe Text
categoryValue :: Maybe Text
$sel:nullOption:CustomFilterConfiguration' :: CustomFilterConfiguration -> FilterNullOption
$sel:matchOperator:CustomFilterConfiguration' :: CustomFilterConfiguration -> CategoryFilterMatchOperator
$sel:selectAllOptions:CustomFilterConfiguration' :: CustomFilterConfiguration -> Maybe CategoryFilterSelectAllOptions
$sel:parameterName:CustomFilterConfiguration' :: CustomFilterConfiguration -> Maybe Text
$sel:categoryValue:CustomFilterConfiguration' :: CustomFilterConfiguration -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
categoryValue
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
parameterName
      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 CustomFilterConfiguration where
  rnf :: CustomFilterConfiguration -> ()
rnf CustomFilterConfiguration' {Maybe Text
Maybe CategoryFilterSelectAllOptions
CategoryFilterMatchOperator
FilterNullOption
nullOption :: FilterNullOption
matchOperator :: CategoryFilterMatchOperator
selectAllOptions :: Maybe CategoryFilterSelectAllOptions
parameterName :: Maybe Text
categoryValue :: Maybe Text
$sel:nullOption:CustomFilterConfiguration' :: CustomFilterConfiguration -> FilterNullOption
$sel:matchOperator:CustomFilterConfiguration' :: CustomFilterConfiguration -> CategoryFilterMatchOperator
$sel:selectAllOptions:CustomFilterConfiguration' :: CustomFilterConfiguration -> Maybe CategoryFilterSelectAllOptions
$sel:parameterName:CustomFilterConfiguration' :: CustomFilterConfiguration -> Maybe Text
$sel:categoryValue:CustomFilterConfiguration' :: CustomFilterConfiguration -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
categoryValue
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
parameterName
      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 CustomFilterConfiguration where
  toJSON :: CustomFilterConfiguration -> Value
toJSON CustomFilterConfiguration' {Maybe Text
Maybe CategoryFilterSelectAllOptions
CategoryFilterMatchOperator
FilterNullOption
nullOption :: FilterNullOption
matchOperator :: CategoryFilterMatchOperator
selectAllOptions :: Maybe CategoryFilterSelectAllOptions
parameterName :: Maybe Text
categoryValue :: Maybe Text
$sel:nullOption:CustomFilterConfiguration' :: CustomFilterConfiguration -> FilterNullOption
$sel:matchOperator:CustomFilterConfiguration' :: CustomFilterConfiguration -> CategoryFilterMatchOperator
$sel:selectAllOptions:CustomFilterConfiguration' :: CustomFilterConfiguration -> Maybe CategoryFilterSelectAllOptions
$sel:parameterName:CustomFilterConfiguration' :: CustomFilterConfiguration -> Maybe Text
$sel:categoryValue:CustomFilterConfiguration' :: CustomFilterConfiguration -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"CategoryValue" 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
categoryValue,
            (Key
"ParameterName" 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
parameterName,
            (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)
          ]
      )