{-# 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.DrillDownFilter
-- 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.DrillDownFilter 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.CategoryDrillDownFilter
import Amazonka.QuickSight.Types.NumericEqualityDrillDownFilter
import Amazonka.QuickSight.Types.TimeRangeDrillDownFilter

-- | The drill down filter for the column hierarchies.
--
-- This is a union type structure. For this structure to be valid, only one
-- of the attributes can be defined.
--
-- /See:/ 'newDrillDownFilter' smart constructor.
data DrillDownFilter = DrillDownFilter'
  { -- | The category type drill down filter. This filter is used for string type
    -- columns.
    DrillDownFilter -> Maybe CategoryDrillDownFilter
categoryFilter :: Prelude.Maybe CategoryDrillDownFilter,
    -- | The numeric equality type drill down filter. This filter is used for
    -- number type columns.
    DrillDownFilter -> Maybe NumericEqualityDrillDownFilter
numericEqualityFilter :: Prelude.Maybe NumericEqualityDrillDownFilter,
    -- | The time range drill down filter. This filter is used for date time
    -- columns.
    DrillDownFilter -> Maybe TimeRangeDrillDownFilter
timeRangeFilter :: Prelude.Maybe TimeRangeDrillDownFilter
  }
  deriving (DrillDownFilter -> DrillDownFilter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DrillDownFilter -> DrillDownFilter -> Bool
$c/= :: DrillDownFilter -> DrillDownFilter -> Bool
== :: DrillDownFilter -> DrillDownFilter -> Bool
$c== :: DrillDownFilter -> DrillDownFilter -> Bool
Prelude.Eq, ReadPrec [DrillDownFilter]
ReadPrec DrillDownFilter
Int -> ReadS DrillDownFilter
ReadS [DrillDownFilter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DrillDownFilter]
$creadListPrec :: ReadPrec [DrillDownFilter]
readPrec :: ReadPrec DrillDownFilter
$creadPrec :: ReadPrec DrillDownFilter
readList :: ReadS [DrillDownFilter]
$creadList :: ReadS [DrillDownFilter]
readsPrec :: Int -> ReadS DrillDownFilter
$creadsPrec :: Int -> ReadS DrillDownFilter
Prelude.Read, Int -> DrillDownFilter -> ShowS
[DrillDownFilter] -> ShowS
DrillDownFilter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DrillDownFilter] -> ShowS
$cshowList :: [DrillDownFilter] -> ShowS
show :: DrillDownFilter -> String
$cshow :: DrillDownFilter -> String
showsPrec :: Int -> DrillDownFilter -> ShowS
$cshowsPrec :: Int -> DrillDownFilter -> ShowS
Prelude.Show, forall x. Rep DrillDownFilter x -> DrillDownFilter
forall x. DrillDownFilter -> Rep DrillDownFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DrillDownFilter x -> DrillDownFilter
$cfrom :: forall x. DrillDownFilter -> Rep DrillDownFilter x
Prelude.Generic)

-- |
-- Create a value of 'DrillDownFilter' 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:
--
-- 'categoryFilter', 'drillDownFilter_categoryFilter' - The category type drill down filter. This filter is used for string type
-- columns.
--
-- 'numericEqualityFilter', 'drillDownFilter_numericEqualityFilter' - The numeric equality type drill down filter. This filter is used for
-- number type columns.
--
-- 'timeRangeFilter', 'drillDownFilter_timeRangeFilter' - The time range drill down filter. This filter is used for date time
-- columns.
newDrillDownFilter ::
  DrillDownFilter
newDrillDownFilter :: DrillDownFilter
newDrillDownFilter =
  DrillDownFilter'
    { $sel:categoryFilter:DrillDownFilter' :: Maybe CategoryDrillDownFilter
categoryFilter = forall a. Maybe a
Prelude.Nothing,
      $sel:numericEqualityFilter:DrillDownFilter' :: Maybe NumericEqualityDrillDownFilter
numericEqualityFilter = forall a. Maybe a
Prelude.Nothing,
      $sel:timeRangeFilter:DrillDownFilter' :: Maybe TimeRangeDrillDownFilter
timeRangeFilter = forall a. Maybe a
Prelude.Nothing
    }

-- | The category type drill down filter. This filter is used for string type
-- columns.
drillDownFilter_categoryFilter :: Lens.Lens' DrillDownFilter (Prelude.Maybe CategoryDrillDownFilter)
drillDownFilter_categoryFilter :: Lens' DrillDownFilter (Maybe CategoryDrillDownFilter)
drillDownFilter_categoryFilter = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DrillDownFilter' {Maybe CategoryDrillDownFilter
categoryFilter :: Maybe CategoryDrillDownFilter
$sel:categoryFilter:DrillDownFilter' :: DrillDownFilter -> Maybe CategoryDrillDownFilter
categoryFilter} -> Maybe CategoryDrillDownFilter
categoryFilter) (\s :: DrillDownFilter
s@DrillDownFilter' {} Maybe CategoryDrillDownFilter
a -> DrillDownFilter
s {$sel:categoryFilter:DrillDownFilter' :: Maybe CategoryDrillDownFilter
categoryFilter = Maybe CategoryDrillDownFilter
a} :: DrillDownFilter)

-- | The numeric equality type drill down filter. This filter is used for
-- number type columns.
drillDownFilter_numericEqualityFilter :: Lens.Lens' DrillDownFilter (Prelude.Maybe NumericEqualityDrillDownFilter)
drillDownFilter_numericEqualityFilter :: Lens' DrillDownFilter (Maybe NumericEqualityDrillDownFilter)
drillDownFilter_numericEqualityFilter = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DrillDownFilter' {Maybe NumericEqualityDrillDownFilter
numericEqualityFilter :: Maybe NumericEqualityDrillDownFilter
$sel:numericEqualityFilter:DrillDownFilter' :: DrillDownFilter -> Maybe NumericEqualityDrillDownFilter
numericEqualityFilter} -> Maybe NumericEqualityDrillDownFilter
numericEqualityFilter) (\s :: DrillDownFilter
s@DrillDownFilter' {} Maybe NumericEqualityDrillDownFilter
a -> DrillDownFilter
s {$sel:numericEqualityFilter:DrillDownFilter' :: Maybe NumericEqualityDrillDownFilter
numericEqualityFilter = Maybe NumericEqualityDrillDownFilter
a} :: DrillDownFilter)

-- | The time range drill down filter. This filter is used for date time
-- columns.
drillDownFilter_timeRangeFilter :: Lens.Lens' DrillDownFilter (Prelude.Maybe TimeRangeDrillDownFilter)
drillDownFilter_timeRangeFilter :: Lens' DrillDownFilter (Maybe TimeRangeDrillDownFilter)
drillDownFilter_timeRangeFilter = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DrillDownFilter' {Maybe TimeRangeDrillDownFilter
timeRangeFilter :: Maybe TimeRangeDrillDownFilter
$sel:timeRangeFilter:DrillDownFilter' :: DrillDownFilter -> Maybe TimeRangeDrillDownFilter
timeRangeFilter} -> Maybe TimeRangeDrillDownFilter
timeRangeFilter) (\s :: DrillDownFilter
s@DrillDownFilter' {} Maybe TimeRangeDrillDownFilter
a -> DrillDownFilter
s {$sel:timeRangeFilter:DrillDownFilter' :: Maybe TimeRangeDrillDownFilter
timeRangeFilter = Maybe TimeRangeDrillDownFilter
a} :: DrillDownFilter)

instance Data.FromJSON DrillDownFilter where
  parseJSON :: Value -> Parser DrillDownFilter
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DrillDownFilter"
      ( \Object
x ->
          Maybe CategoryDrillDownFilter
-> Maybe NumericEqualityDrillDownFilter
-> Maybe TimeRangeDrillDownFilter
-> DrillDownFilter
DrillDownFilter'
            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
"CategoryFilter")
            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
"NumericEqualityFilter")
            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
"TimeRangeFilter")
      )

instance Prelude.Hashable DrillDownFilter where
  hashWithSalt :: Int -> DrillDownFilter -> Int
hashWithSalt Int
_salt DrillDownFilter' {Maybe CategoryDrillDownFilter
Maybe NumericEqualityDrillDownFilter
Maybe TimeRangeDrillDownFilter
timeRangeFilter :: Maybe TimeRangeDrillDownFilter
numericEqualityFilter :: Maybe NumericEqualityDrillDownFilter
categoryFilter :: Maybe CategoryDrillDownFilter
$sel:timeRangeFilter:DrillDownFilter' :: DrillDownFilter -> Maybe TimeRangeDrillDownFilter
$sel:numericEqualityFilter:DrillDownFilter' :: DrillDownFilter -> Maybe NumericEqualityDrillDownFilter
$sel:categoryFilter:DrillDownFilter' :: DrillDownFilter -> Maybe CategoryDrillDownFilter
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe CategoryDrillDownFilter
categoryFilter
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe NumericEqualityDrillDownFilter
numericEqualityFilter
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe TimeRangeDrillDownFilter
timeRangeFilter

instance Prelude.NFData DrillDownFilter where
  rnf :: DrillDownFilter -> ()
rnf DrillDownFilter' {Maybe CategoryDrillDownFilter
Maybe NumericEqualityDrillDownFilter
Maybe TimeRangeDrillDownFilter
timeRangeFilter :: Maybe TimeRangeDrillDownFilter
numericEqualityFilter :: Maybe NumericEqualityDrillDownFilter
categoryFilter :: Maybe CategoryDrillDownFilter
$sel:timeRangeFilter:DrillDownFilter' :: DrillDownFilter -> Maybe TimeRangeDrillDownFilter
$sel:numericEqualityFilter:DrillDownFilter' :: DrillDownFilter -> Maybe NumericEqualityDrillDownFilter
$sel:categoryFilter:DrillDownFilter' :: DrillDownFilter -> Maybe CategoryDrillDownFilter
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe CategoryDrillDownFilter
categoryFilter
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe NumericEqualityDrillDownFilter
numericEqualityFilter
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe TimeRangeDrillDownFilter
timeRangeFilter

instance Data.ToJSON DrillDownFilter where
  toJSON :: DrillDownFilter -> Value
toJSON DrillDownFilter' {Maybe CategoryDrillDownFilter
Maybe NumericEqualityDrillDownFilter
Maybe TimeRangeDrillDownFilter
timeRangeFilter :: Maybe TimeRangeDrillDownFilter
numericEqualityFilter :: Maybe NumericEqualityDrillDownFilter
categoryFilter :: Maybe CategoryDrillDownFilter
$sel:timeRangeFilter:DrillDownFilter' :: DrillDownFilter -> Maybe TimeRangeDrillDownFilter
$sel:numericEqualityFilter:DrillDownFilter' :: DrillDownFilter -> Maybe NumericEqualityDrillDownFilter
$sel:categoryFilter:DrillDownFilter' :: DrillDownFilter -> Maybe CategoryDrillDownFilter
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"CategoryFilter" 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 CategoryDrillDownFilter
categoryFilter,
            (Key
"NumericEqualityFilter" 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 NumericEqualityDrillDownFilter
numericEqualityFilter,
            (Key
"TimeRangeFilter" 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 TimeRangeDrillDownFilter
timeRangeFilter
          ]
      )