{-# 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.TimeEqualityFilter
-- 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.TimeEqualityFilter 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.ColumnIdentifier
import Amazonka.QuickSight.Types.TimeGranularity

-- | A @TimeEqualityFilter@ filters values that are equal to a given value.
--
-- /See:/ 'newTimeEqualityFilter' smart constructor.
data TimeEqualityFilter = TimeEqualityFilter'
  { -- | The parameter whose value should be used for the filter value.
    --
    -- This field is mutually exclusive to @Value@.
    TimeEqualityFilter -> Maybe Text
parameterName :: Prelude.Maybe Prelude.Text,
    -- | The level of time precision that is used to aggregate @DateTime@ values.
    TimeEqualityFilter -> Maybe TimeGranularity
timeGranularity :: Prelude.Maybe TimeGranularity,
    -- | The value of a @TimeEquality@ filter.
    --
    -- This field is mutually exclusive to @ParameterName@.
    TimeEqualityFilter -> Maybe POSIX
value :: Prelude.Maybe Data.POSIX,
    -- | An identifier that uniquely identifies a filter within a dashboard,
    -- analysis, or template.
    TimeEqualityFilter -> Text
filterId :: Prelude.Text,
    -- | The column that the filter is applied to.
    TimeEqualityFilter -> ColumnIdentifier
column :: ColumnIdentifier
  }
  deriving (TimeEqualityFilter -> TimeEqualityFilter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TimeEqualityFilter -> TimeEqualityFilter -> Bool
$c/= :: TimeEqualityFilter -> TimeEqualityFilter -> Bool
== :: TimeEqualityFilter -> TimeEqualityFilter -> Bool
$c== :: TimeEqualityFilter -> TimeEqualityFilter -> Bool
Prelude.Eq, ReadPrec [TimeEqualityFilter]
ReadPrec TimeEqualityFilter
Int -> ReadS TimeEqualityFilter
ReadS [TimeEqualityFilter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TimeEqualityFilter]
$creadListPrec :: ReadPrec [TimeEqualityFilter]
readPrec :: ReadPrec TimeEqualityFilter
$creadPrec :: ReadPrec TimeEqualityFilter
readList :: ReadS [TimeEqualityFilter]
$creadList :: ReadS [TimeEqualityFilter]
readsPrec :: Int -> ReadS TimeEqualityFilter
$creadsPrec :: Int -> ReadS TimeEqualityFilter
Prelude.Read, Int -> TimeEqualityFilter -> ShowS
[TimeEqualityFilter] -> ShowS
TimeEqualityFilter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TimeEqualityFilter] -> ShowS
$cshowList :: [TimeEqualityFilter] -> ShowS
show :: TimeEqualityFilter -> String
$cshow :: TimeEqualityFilter -> String
showsPrec :: Int -> TimeEqualityFilter -> ShowS
$cshowsPrec :: Int -> TimeEqualityFilter -> ShowS
Prelude.Show, forall x. Rep TimeEqualityFilter x -> TimeEqualityFilter
forall x. TimeEqualityFilter -> Rep TimeEqualityFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep TimeEqualityFilter x -> TimeEqualityFilter
$cfrom :: forall x. TimeEqualityFilter -> Rep TimeEqualityFilter x
Prelude.Generic)

-- |
-- Create a value of 'TimeEqualityFilter' 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:
--
-- 'parameterName', 'timeEqualityFilter_parameterName' - The parameter whose value should be used for the filter value.
--
-- This field is mutually exclusive to @Value@.
--
-- 'timeGranularity', 'timeEqualityFilter_timeGranularity' - The level of time precision that is used to aggregate @DateTime@ values.
--
-- 'value', 'timeEqualityFilter_value' - The value of a @TimeEquality@ filter.
--
-- This field is mutually exclusive to @ParameterName@.
--
-- 'filterId', 'timeEqualityFilter_filterId' - An identifier that uniquely identifies a filter within a dashboard,
-- analysis, or template.
--
-- 'column', 'timeEqualityFilter_column' - The column that the filter is applied to.
newTimeEqualityFilter ::
  -- | 'filterId'
  Prelude.Text ->
  -- | 'column'
  ColumnIdentifier ->
  TimeEqualityFilter
newTimeEqualityFilter :: Text -> ColumnIdentifier -> TimeEqualityFilter
newTimeEqualityFilter Text
pFilterId_ ColumnIdentifier
pColumn_ =
  TimeEqualityFilter'
    { $sel:parameterName:TimeEqualityFilter' :: Maybe Text
parameterName =
        forall a. Maybe a
Prelude.Nothing,
      $sel:timeGranularity:TimeEqualityFilter' :: Maybe TimeGranularity
timeGranularity = forall a. Maybe a
Prelude.Nothing,
      $sel:value:TimeEqualityFilter' :: Maybe POSIX
value = forall a. Maybe a
Prelude.Nothing,
      $sel:filterId:TimeEqualityFilter' :: Text
filterId = Text
pFilterId_,
      $sel:column:TimeEqualityFilter' :: ColumnIdentifier
column = ColumnIdentifier
pColumn_
    }

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

-- | The level of time precision that is used to aggregate @DateTime@ values.
timeEqualityFilter_timeGranularity :: Lens.Lens' TimeEqualityFilter (Prelude.Maybe TimeGranularity)
timeEqualityFilter_timeGranularity :: Lens' TimeEqualityFilter (Maybe TimeGranularity)
timeEqualityFilter_timeGranularity = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeEqualityFilter' {Maybe TimeGranularity
timeGranularity :: Maybe TimeGranularity
$sel:timeGranularity:TimeEqualityFilter' :: TimeEqualityFilter -> Maybe TimeGranularity
timeGranularity} -> Maybe TimeGranularity
timeGranularity) (\s :: TimeEqualityFilter
s@TimeEqualityFilter' {} Maybe TimeGranularity
a -> TimeEqualityFilter
s {$sel:timeGranularity:TimeEqualityFilter' :: Maybe TimeGranularity
timeGranularity = Maybe TimeGranularity
a} :: TimeEqualityFilter)

-- | The value of a @TimeEquality@ filter.
--
-- This field is mutually exclusive to @ParameterName@.
timeEqualityFilter_value :: Lens.Lens' TimeEqualityFilter (Prelude.Maybe Prelude.UTCTime)
timeEqualityFilter_value :: Lens' TimeEqualityFilter (Maybe UTCTime)
timeEqualityFilter_value = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeEqualityFilter' {Maybe POSIX
value :: Maybe POSIX
$sel:value:TimeEqualityFilter' :: TimeEqualityFilter -> Maybe POSIX
value} -> Maybe POSIX
value) (\s :: TimeEqualityFilter
s@TimeEqualityFilter' {} Maybe POSIX
a -> TimeEqualityFilter
s {$sel:value:TimeEqualityFilter' :: Maybe POSIX
value = Maybe POSIX
a} :: TimeEqualityFilter) 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 (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | An identifier that uniquely identifies a filter within a dashboard,
-- analysis, or template.
timeEqualityFilter_filterId :: Lens.Lens' TimeEqualityFilter Prelude.Text
timeEqualityFilter_filterId :: Lens' TimeEqualityFilter Text
timeEqualityFilter_filterId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeEqualityFilter' {Text
filterId :: Text
$sel:filterId:TimeEqualityFilter' :: TimeEqualityFilter -> Text
filterId} -> Text
filterId) (\s :: TimeEqualityFilter
s@TimeEqualityFilter' {} Text
a -> TimeEqualityFilter
s {$sel:filterId:TimeEqualityFilter' :: Text
filterId = Text
a} :: TimeEqualityFilter)

-- | The column that the filter is applied to.
timeEqualityFilter_column :: Lens.Lens' TimeEqualityFilter ColumnIdentifier
timeEqualityFilter_column :: Lens' TimeEqualityFilter ColumnIdentifier
timeEqualityFilter_column = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeEqualityFilter' {ColumnIdentifier
column :: ColumnIdentifier
$sel:column:TimeEqualityFilter' :: TimeEqualityFilter -> ColumnIdentifier
column} -> ColumnIdentifier
column) (\s :: TimeEqualityFilter
s@TimeEqualityFilter' {} ColumnIdentifier
a -> TimeEqualityFilter
s {$sel:column:TimeEqualityFilter' :: ColumnIdentifier
column = ColumnIdentifier
a} :: TimeEqualityFilter)

instance Data.FromJSON TimeEqualityFilter where
  parseJSON :: Value -> Parser TimeEqualityFilter
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"TimeEqualityFilter"
      ( \Object
x ->
          Maybe Text
-> Maybe TimeGranularity
-> Maybe POSIX
-> Text
-> ColumnIdentifier
-> TimeEqualityFilter
TimeEqualityFilter'
            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
"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
"TimeGranularity")
            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
"Value")
            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
"FilterId")
            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
"Column")
      )

instance Prelude.Hashable TimeEqualityFilter where
  hashWithSalt :: Int -> TimeEqualityFilter -> Int
hashWithSalt Int
_salt TimeEqualityFilter' {Maybe Text
Maybe POSIX
Maybe TimeGranularity
Text
ColumnIdentifier
column :: ColumnIdentifier
filterId :: Text
value :: Maybe POSIX
timeGranularity :: Maybe TimeGranularity
parameterName :: Maybe Text
$sel:column:TimeEqualityFilter' :: TimeEqualityFilter -> ColumnIdentifier
$sel:filterId:TimeEqualityFilter' :: TimeEqualityFilter -> Text
$sel:value:TimeEqualityFilter' :: TimeEqualityFilter -> Maybe POSIX
$sel:timeGranularity:TimeEqualityFilter' :: TimeEqualityFilter -> Maybe TimeGranularity
$sel:parameterName:TimeEqualityFilter' :: TimeEqualityFilter -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
parameterName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe TimeGranularity
timeGranularity
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
value
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
filterId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` ColumnIdentifier
column

instance Prelude.NFData TimeEqualityFilter where
  rnf :: TimeEqualityFilter -> ()
rnf TimeEqualityFilter' {Maybe Text
Maybe POSIX
Maybe TimeGranularity
Text
ColumnIdentifier
column :: ColumnIdentifier
filterId :: Text
value :: Maybe POSIX
timeGranularity :: Maybe TimeGranularity
parameterName :: Maybe Text
$sel:column:TimeEqualityFilter' :: TimeEqualityFilter -> ColumnIdentifier
$sel:filterId:TimeEqualityFilter' :: TimeEqualityFilter -> Text
$sel:value:TimeEqualityFilter' :: TimeEqualityFilter -> Maybe POSIX
$sel:timeGranularity:TimeEqualityFilter' :: TimeEqualityFilter -> Maybe TimeGranularity
$sel:parameterName:TimeEqualityFilter' :: TimeEqualityFilter -> Maybe Text
..} =
    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 TimeGranularity
timeGranularity
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
value
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
filterId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf ColumnIdentifier
column

instance Data.ToJSON TimeEqualityFilter where
  toJSON :: TimeEqualityFilter -> Value
toJSON TimeEqualityFilter' {Maybe Text
Maybe POSIX
Maybe TimeGranularity
Text
ColumnIdentifier
column :: ColumnIdentifier
filterId :: Text
value :: Maybe POSIX
timeGranularity :: Maybe TimeGranularity
parameterName :: Maybe Text
$sel:column:TimeEqualityFilter' :: TimeEqualityFilter -> ColumnIdentifier
$sel:filterId:TimeEqualityFilter' :: TimeEqualityFilter -> Text
$sel:value:TimeEqualityFilter' :: TimeEqualityFilter -> Maybe POSIX
$sel:timeGranularity:TimeEqualityFilter' :: TimeEqualityFilter -> Maybe TimeGranularity
$sel:parameterName:TimeEqualityFilter' :: TimeEqualityFilter -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (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
"TimeGranularity" 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 TimeGranularity
timeGranularity,
            (Key
"Value" 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 POSIX
value,
            forall a. a -> Maybe a
Prelude.Just (Key
"FilterId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
filterId),
            forall a. a -> Maybe a
Prelude.Just (Key
"Column" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= ColumnIdentifier
column)
          ]
      )